diff --git a/.github/workflows/sdks.yml b/.github/workflows/sdks.yml index bfa09511a..babe18ed8 100644 --- a/.github/workflows/sdks.yml +++ b/.github/workflows/sdks.yml @@ -23,24 +23,20 @@ jobs: include: - language: java repository: 'commercetools/commercetools-sdk-java-v2' - sshKey: JAVA_SDK_DEPLOY_KEY apiMixin: true API_RAML: "../commercetools-api-reference/api-specs/api/api-mixin.raml" diffFormat: JAVA_MARKDOWN - language: csharp repository: 'commercetools/commercetools-dotnet-core-sdk-v2' - sshKey: CSHARP_SDK_DEPLOY_KEY apiMixin: true API_RAML: "../commercetools-api-reference/api-specs/api/api-mixin.raml" diffFormat: DOTNET_MARKDOWN - language: typescript repository: 'commercetools/commercetools-sdk-typescript' - sshKey: TS_SDK_DEPLOY_KEY API_RAML: "../commercetools-api-reference/api-specs/api/api.raml" diffFormat: TS_MARKDOWN - language: php repository: 'commercetools/commercetools-sdk-php-v2' - sshKey: SDK_DEPLOY_KEY apiMixin: true makeParams: "-j2" API_RAML: "../commercetools-api-reference/api-specs/api/api-mixin.raml" @@ -49,17 +45,38 @@ jobs: # repository: 'commercetools/commercetools-postman-collection' # sshKey: ${{ secrets.POSTMAN_DEPLOY_KEY }} steps: + # Get GitHub token via the CT SDKs App + - name: Generate GitHub token (via CT SDKs App) + id: generate_github_token + uses: actions/create-github-app-token@v1 + with: + app-id: ${{ secrets.SDK_APP_ID }} + private-key: ${{ secrets.SDK_APP_PEM }} + owner: ${{ github.repository_owner }} + + - name: Get App user + id: get_app_user + env: + GITHUB_TOKEN: ${{ steps.generate_github_token.outputs.token }} + run: | + export GH_APP_USER=`gh api /users/ct-sdks%5Bbot%5D | jq .id` + echo "email=${GH_APP_USER}+ct-sdks[bot]@users.noreply.github.com" >> "$GITHUB_OUTPUT" + - name: "Checkout api reference" - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: path: commercetools-api-reference - + # Pass a personal access token (using our CT SDKs App) to be able to trigger other workflows + # https://help.github.com/en/actions/reference/events-that-trigger-workflows#triggering-new-workflows-using-a-personal-access-token + # https://github.community/t/action-does-not-trigger-another-on-push-tag-action/17148/8 + token: ${{ steps.generate_github_token.outputs.token }} + - name: "Checkout SDK" - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: repository: ${{ matrix.repository }} path: commercetools-sdk - ssh-key: ${{ secrets[matrix.sshKey] }} + token: ${{ steps.generate_github_token.outputs.token }} - name: 'Setup Java' uses: actions/setup-java@v3 @@ -137,10 +154,11 @@ jobs: HISTORY_RAML: "../commercetools-api-reference/api-specs/history/api.raml" - name: "Checkout previous api reference" - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 path: commercetools-api-reference-previous + token: ${{ steps.generate_github_token.outputs.token }} - name: "Store api reference version" run: | @@ -164,9 +182,6 @@ jobs: - name: "Calculate diff (History)" run: rmf-codegen diff -f ${{ matrix.diffFormat }} -o ./changes_history.md commercetools-api-reference-previous/api-specs/history/api.raml commercetools-api-reference/api-specs/history/api.raml - - name: "Calculate diff (ML)" - run: rmf-codegen diff -f ${{ matrix.diffFormat }} -o ./changes_ml.md commercetools-api-reference-previous/api-specs/ml/api.raml commercetools-api-reference/api-specs/ml/api.raml - - name: 'Create change file' run: | if [ -f ./changes_api.md ]; then @@ -187,12 +202,6 @@ jobs: cat ./changes_history.md >> ./changes.md echo "" >> ./changes.md fi - if [ -f ./changes_ml.md ]; then - echo "**ML changes**" >> ./changes.md - echo "" >> ./changes.md - cat ./changes_ml.md >> ./changes.md - echo "" >> ./changes.md - fi if [ -f ./changes.md ]; then cat ./changes.md cp ./changes.md ./commercetools-sdk/changes.md @@ -208,9 +217,9 @@ jobs: repository: commercetools-sdk branch: gen-sdk-updates commit_message: "build(codegen): updating SDK" - commit_user_name: Auto Mation - commit_user_email: automation@commercetools.com - commit_author: Auto Mation + commit_author: ct-sdks[bot] <${{ steps.get_app_user.outputs.email }}> + commit_user_name: ct-sdks[bot] + commit_user_email: ${{ steps.get_app_user.outputs.email }} - uses: stefanzweifel/git-auto-commit-action@v4 if: github.event_name == 'workflow_dispatch' && github.ref != 'refs/heads/main' @@ -218,6 +227,6 @@ jobs: repository: commercetools-sdk branch: ${{ github.ref_name }} commit_message: "build(codegen): updating SDK" - commit_user_name: Auto Mation - commit_user_email: automation@commercetools.com - commit_author: Auto Mation + commit_author: ct-sdks[bot] <${{ steps.get_app_user.outputs.email }}> + commit_user_name: ct-sdks[bot] + commit_user_email: ${{ steps.get_app_user.outputs.email }} diff --git a/Makefile b/Makefile index 5d0d9bb21..3c5b4ace1 100644 --- a/Makefile +++ b/Makefile @@ -13,7 +13,6 @@ validate_oas: npx autorest --v3 --azure-validator --input-file=oas/api/openapi.yaml npx autorest --v3 --azure-validator --input-file=oas/history/openapi.yaml npx autorest --v3 --azure-validator --input-file=oas/import/openapi.yaml - npx autorest --v3 --azure-validator --input-file=oas/ml/openapi.yaml codegen_install: curl -o- -s https://raw.githubusercontent.com/vrapio/rmf-codegen/master/scripts/install.sh | bash @@ -21,7 +20,7 @@ codegen_install: validate_raml: codegen_install rmf-codegen verify api-specs/api/api.raml -generate_oas: generate_oas_api generate_oas_import generate_oas_history generate_oas_ml +generate_oas: generate_oas_api generate_oas_import generate_oas_history generate_oas_api: codegen_install rmf-codegen generate -o oas/api -t OAS api-specs/api/api.raml diff --git a/api-specs/api/examples/approval-flow-update-response.example.json b/api-specs/api/examples/approval-flow-update-response.example.json index 02755255b..5f1121dab 100644 --- a/api-specs/api/examples/approval-flow-update-response.example.json +++ b/api-specs/api/examples/approval-flow-update-response.example.json @@ -23,7 +23,6 @@ { "id": "ff806a85-1457-4cef-929a-79aefe85f02d", "version": 1, - "lastMessageSequenceNumber": 1, "createdAt": "2023-06-12T14:43:45.732Z", "lastModifiedAt": "2023-06-12T14:43:45.732Z", "lastModifiedBy": { @@ -96,4 +95,4 @@ "eligibleApprovers": [], "pendingApprovers": [], "currentTierPendingApprovers": [] -} \ No newline at end of file +} diff --git a/api-specs/api/examples/approval-flow.example.json b/api-specs/api/examples/approval-flow.example.json index 74d8fa0d7..33ae37d59 100644 --- a/api-specs/api/examples/approval-flow.example.json +++ b/api-specs/api/examples/approval-flow.example.json @@ -23,7 +23,6 @@ { "id": "ff806a85-1457-4cef-929a-79aefe85f02d", "version": 1, - "lastMessageSequenceNumber": 1, "createdAt": "2023-06-12T14:43:45.732Z", "lastModifiedAt": "2023-06-12T14:43:45.732Z", "lastModifiedBy": { @@ -158,4 +157,4 @@ } } ] -} \ No newline at end of file +} diff --git a/api-specs/api/examples/approval-flows.example.json b/api-specs/api/examples/approval-flows.example.json index 6238e4691..58aa7277a 100644 --- a/api-specs/api/examples/approval-flows.example.json +++ b/api-specs/api/examples/approval-flows.example.json @@ -29,7 +29,6 @@ { "id": "ff806a85-1457-4cef-929a-79aefe85f02d", "version": 1, - "lastMessageSequenceNumber": 1, "createdAt": "2023-06-12T14:43:45.732Z", "lastModifiedAt": "2023-06-12T14:43:45.732Z", "lastModifiedBy": { @@ -166,4 +165,4 @@ ] } ] -} \ No newline at end of file +} diff --git a/api-specs/api/resources/in-store.raml b/api-specs/api/resources/in-store.raml index 78ce84e99..e0c0fb92f 100644 --- a/api-specs/api/resources/in-store.raml +++ b/api-specs/api/resources/in-store.raml @@ -2131,10 +2131,12 @@ uriParameters: ] description: | Gets the current or staged representation of a [Product](ctp:api:type:Product) by its key from the specified [Store](ctp:api:type:Store). - If the Store has defined some languages, countries, distribution or supply Channels, + If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection, they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices) and [inventory](ctp:api:type:ProductProjectionInventoryEntries). + If [ProductSelection](ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/projects/stores#products-available-in-store) in the specified Store. + When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections. is: - projectionSelecting @@ -2174,10 +2176,12 @@ uriParameters: ] description: | Gets the current or staged representation of a [Product](ctp:api:type:Product) by its ID from the specified [Store](ctp:api:type:Store). - If the Store has defined some languages, countries, distribution or supply Channels, + If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection, they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices) and [inventory](ctp:api:type:ProductProjectionInventoryEntries). + If [ProductSelection](ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/projects/stores#products-available-in-store) in the specified Store. + When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections. is: - projectionSelecting diff --git a/api-specs/api/resources/products.raml b/api-specs/api/resources/products.raml index 3fe502e35..07cfe64a5 100644 --- a/api-specs/api/resources/products.raml +++ b/api-specs/api/resources/products.raml @@ -43,7 +43,7 @@ head: post: securedBy: [oauth_2_0: { scopes: ['manage_products:{projectKey}'] }] description: | - To create a new Product, send a representation that is going to become the initial _staged_ representation of the new Product in the master catalog. + To create a new Product, send a representation that is going to become the initial _staged_ and _current_ representation of the new Product in the catalog. If [Price Selection](ctp:api:type:ProductPriceSelection) query parameters are provided, selected Prices will be added to the response. Produces the [ProductCreated](/projects/messages#product-created) Message. is: diff --git a/api-specs/api/traits/data-erasure.raml b/api-specs/api/traits/data-erasure.raml index 3b8bc1586..d4d4058d5 100644 --- a/api-specs/api/traits/data-erasure.raml +++ b/api-specs/api/traits/data-erasure.raml @@ -6,4 +6,4 @@ queryParameters: required: false description: | Defaults to `false`. - Set to `true` if you want to [erase all related personal data](/../api/general-concepts#data-erasure-of-personal-data) in compliance with GDPR. + Set to `true` if you want to [erase all related personal data](/../api/gdpr#data-erasure-of-personal-data) in compliance with GDPR. diff --git a/api-specs/api/types/approval-flow/ApprovalFlow.raml b/api-specs/api/types/approval-flow/ApprovalFlow.raml index 3852015ac..54eae3801 100644 --- a/api-specs/api/types/approval-flow/ApprovalFlow.raml +++ b/api-specs/api/types/approval-flow/ApprovalFlow.raml @@ -23,7 +23,7 @@ properties: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/general-concepts#events-tracked). lastModifiedAt: type: datetime description: | @@ -32,7 +32,7 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/general-concepts#events-tracked). order: type: OrderReference description: | diff --git a/api-specs/api/types/approval-flow/ApprovalFlowUpdate.raml b/api-specs/api/types/approval-flow/ApprovalFlowUpdate.raml index 9ecddfd1a..ef7b30b28 100644 --- a/api-specs/api/types/approval-flow/ApprovalFlowUpdate.raml +++ b/api-specs/api/types/approval-flow/ApprovalFlowUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the [Approval Flow](ctp:api:type:ApprovalFlow) to which the changes should be applied. - If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: ApprovalFlowUpdateAction diff --git a/api-specs/api/types/approval-rule/ApprovalRule.raml b/api-specs/api/types/approval-rule/ApprovalRule.raml index 1a8ae2a3e..c5bc46068 100644 --- a/api-specs/api/types/approval-rule/ApprovalRule.raml +++ b/api-specs/api/types/approval-rule/ApprovalRule.raml @@ -23,7 +23,7 @@ properties: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/general-concepts#events-tracked). lastModifiedAt: type: datetime description: | @@ -32,7 +32,7 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/api/types/approval-rule/ApprovalRuleUpdate.raml b/api-specs/api/types/approval-rule/ApprovalRuleUpdate.raml index 27d4ca382..c225641c0 100644 --- a/api-specs/api/types/approval-rule/ApprovalRuleUpdate.raml +++ b/api-specs/api/types/approval-rule/ApprovalRuleUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the [ApprovalRule](ctp:api:type:ApprovalRule) to which the changes should be applied. - If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: ApprovalRuleUpdateAction diff --git a/api-specs/api/types/associate-role/AssociateRole.raml b/api-specs/api/types/associate-role/AssociateRole.raml index 640ce9bdf..da158c970 100644 --- a/api-specs/api/types/associate-role/AssociateRole.raml +++ b/api-specs/api/types/associate-role/AssociateRole.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources updated after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key: type: string description: | diff --git a/api-specs/api/types/associate-role/AssociateRoleResourceIdentifier.raml b/api-specs/api/types/associate-role/AssociateRoleResourceIdentifier.raml index 2a22e4f67..19b0659a8 100644 --- a/api-specs/api/types/associate-role/AssociateRoleResourceIdentifier.raml +++ b/api-specs/api/types/associate-role/AssociateRoleResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: AssociateRoleResourceIdentifier discriminatorValue: associate-role description: | - [ResourceIdentifier](ctp:api:type:TypeResourceIdentifier) of an [AssociateRole](ctp:api:type:AssociateRole). + [ResourceIdentifier](ctp:api:type:TypeResourceIdentifier) of an [AssociateRole](ctp:api:type:AssociateRole). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [AssociateRole](ctp:api:type:AssociateRole). Either `id` or `key` is required. + Unique identifier of the referenced [AssociateRole](ctp:api:type:AssociateRole). Required if `key` is absent. key?: type: string description: | - Unique key of the referenced [AssociateRole](ctp:api:type:AssociateRole). Either `id` or `key` is required. + Unique key of the referenced [AssociateRole](ctp:api:type:AssociateRole). Required if `id` is absent. diff --git a/api-specs/api/types/associate-role/AssociateRoleUpdate.raml b/api-specs/api/types/associate-role/AssociateRoleUpdate.raml index 860257123..1498ac038 100644 --- a/api-specs/api/types/associate-role/AssociateRoleUpdate.raml +++ b/api-specs/api/types/associate-role/AssociateRoleUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the AssociateRole on which the changes should be applied. - If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: AssociateRoleUpdateAction diff --git a/api-specs/api/types/attribute-group/AttributeGroup.raml b/api-specs/api/types/attribute-group/AttributeGroup.raml index 2d8e39766..20d70406e 100644 --- a/api-specs/api/types/attribute-group/AttributeGroup.raml +++ b/api-specs/api/types/attribute-group/AttributeGroup.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). name: type: LocalizedString description: | diff --git a/api-specs/api/types/attribute-group/AttributeGroupResourceIdentifier.raml b/api-specs/api/types/attribute-group/AttributeGroupResourceIdentifier.raml index c5f06de93..720ff313d 100644 --- a/api-specs/api/types/attribute-group/AttributeGroupResourceIdentifier.raml +++ b/api-specs/api/types/attribute-group/AttributeGroupResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: AttributeGroupResourceIdentifier discriminatorValue: attribute-group description: | - [ResourceIdentifier](/../api/types#resourceidentifier) to an [AttributeGroup](ctp:api:type:AttributeGroup). + [ResourceIdentifier](/../api/types#resourceidentifier) to an [AttributeGroup](ctp:api:type:AttributeGroup). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Platform-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Either `id` or `key` is required. + Platform-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Required if `key` is absent. key?: type: string description: | - User-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Either `id` or `key` is required. + User-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Required if `id` is absent. diff --git a/api-specs/api/types/attribute-group/AttributeGroupUpdate.raml b/api-specs/api/types/attribute-group/AttributeGroupUpdate.raml index f9c2e8abb..c4562b4af 100644 --- a/api-specs/api/types/attribute-group/AttributeGroupUpdate.raml +++ b/api-specs/api/types/attribute-group/AttributeGroupUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the AttributeGroup on which the changes should be applied. If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) will be returned. + Expected version of the AttributeGroup on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: AttributeGroupUpdateAction diff --git a/api-specs/api/types/business-unit/Associate.raml b/api-specs/api/types/business-unit/Associate.raml index ba89aadf9..aff0b9428 100644 --- a/api-specs/api/types/business-unit/Associate.raml +++ b/api-specs/api/types/business-unit/Associate.raml @@ -11,7 +11,7 @@ properties: (deprecated): true type: AssociateRoleDeprecated[] description: | - Deprecated type. Use `associateRoleAssignment` instead. + Deprecated type. Use `associateRoleAssignments` instead. customer: type: CustomerReference description: | diff --git a/api-specs/api/types/business-unit/AssociateDraft.raml b/api-specs/api/types/business-unit/AssociateDraft.raml index f28edc552..2bf5619b5 100644 --- a/api-specs/api/types/business-unit/AssociateDraft.raml +++ b/api-specs/api/types/business-unit/AssociateDraft.raml @@ -12,7 +12,7 @@ properties: (deprecated): true type: AssociateRoleDeprecated[] description: | - Deprecated type. Use `associateRoleAssignment` instead. + Deprecated type. Use `associateRoleAssignments` instead. customer: type: CustomerResourceIdentifier description: | diff --git a/api-specs/api/types/business-unit/BusinessUnit.raml b/api-specs/api/types/business-unit/BusinessUnit.raml index 4fb39432a..9dfa216d2 100644 --- a/api-specs/api/types/business-unit/BusinessUnit.raml +++ b/api-specs/api/types/business-unit/BusinessUnit.raml @@ -30,12 +30,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources updated after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key: type: string description: | @@ -106,7 +106,7 @@ properties: inheritedAssociates?: type: InheritedAssociate[] description: | - Associates that are inherited from a parent Business Unit. This value of this field is [eventually consistent](/../api/general-concepts#eventual-consistency) and is only present when the `associateMode` is set to `ExplicitAndFromParent`. + Associates that are inherited from a parent Business Unit. The value of this field is [eventually consistent](/../api/general-concepts#eventual-consistency) and is only present when the `associateMode` is set to `ExplicitAndFromParent`. parentUnit?: type: BusinessUnitKeyReference description: | diff --git a/api-specs/api/types/business-unit/BusinessUnitResourceIdentifier.raml b/api-specs/api/types/business-unit/BusinessUnitResourceIdentifier.raml index 83f529df7..92c878384 100644 --- a/api-specs/api/types/business-unit/BusinessUnitResourceIdentifier.raml +++ b/api-specs/api/types/business-unit/BusinessUnitResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: BusinessUnitResourceIdentifier discriminatorValue: business-unit description: | - [ResourceIdentifier](/../api/types#resourceidentifier) to a [BusinessUnit](ctp:api:type:BusinessUnit). + [ResourceIdentifier](/../api/types#resourceidentifier) to a [BusinessUnit](ctp:api:type:BusinessUnit). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [BusinessUnit](ctp:api:type:BusinessUnit). Either `id` or `key` is required. + Unique identifier of the referenced [BusinessUnit](ctp:api:type:BusinessUnit). Required if `key` is absent. key?: type: string description: | - Unique key of the referenced [BusinessUnit](ctp:api:type:BusinessUnit). Either `id` or `key` is required. + Unique key of the referenced [BusinessUnit](ctp:api:type:BusinessUnit). Required if `id` is absent. diff --git a/api-specs/api/types/business-unit/BusinessUnitStatus.raml b/api-specs/api/types/business-unit/BusinessUnitStatus.raml index fdc84e9b6..20c2afd21 100644 --- a/api-specs/api/types/business-unit/BusinessUnitStatus.raml +++ b/api-specs/api/types/business-unit/BusinessUnitStatus.raml @@ -12,6 +12,6 @@ enum: Active: | The Business Unit can be used in Carts, Orders, Quote Requests, and Quotes and can be edited. Inactive: | - The Business Unit cannot be used in Carts, Orders, Quote Requests, and Quotes and can only be edited using the [general endpoint](ctp:api:endpoint:/{projectKey}/me/business-units:POST). + The Business Unit cannot be used in Carts, Orders, Quote Requests, and Quotes and can only be edited using the [general endpoint](/../api/associates-overview#through-the-general-endpoints). Status doesn't affect inheritance. Even if a parent unit is inactive, its children remain active and can inherit role assignments. default: Active diff --git a/api-specs/api/types/business-unit/BusinessUnitUpdate.raml b/api-specs/api/types/business-unit/BusinessUnitUpdate.raml index e2c7914aa..7b7d81a71 100644 --- a/api-specs/api/types/business-unit/BusinessUnitUpdate.raml +++ b/api-specs/api/types/business-unit/BusinessUnitUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the BusinessUnit on which the changes should be applied. - If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: BusinessUnitUpdateAction diff --git a/api-specs/api/types/cart-discount/CartDiscount.raml b/api-specs/api/types/cart-discount/CartDiscount.raml index 54b4e38c2..e6ce0e58e 100644 --- a/api-specs/api/types/cart-discount/CartDiscount.raml +++ b/api-specs/api/types/cart-discount/CartDiscount.raml @@ -26,12 +26,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources updated after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). name: type: LocalizedString description: | @@ -70,7 +70,6 @@ properties: The sort order is unambiguous among all CartDiscounts. stores: type: StoreKeyReference[] - (beta): true maxItems: 500 description: | - If a value exists, the Cart Discount applies on [Carts](ctp:api:type:Cart) having a [Store](ctp:api:type:Store) matching any Store defined for this field. diff --git a/api-specs/api/types/cart-discount/CartDiscountDraft.raml b/api-specs/api/types/cart-discount/CartDiscountDraft.raml index 4805483eb..783f121d6 100644 --- a/api-specs/api/types/cart-discount/CartDiscountDraft.raml +++ b/api-specs/api/types/cart-discount/CartDiscountDraft.raml @@ -41,7 +41,6 @@ properties: The sort order must be unambiguous among all CartDiscounts. stores?: type: StoreResourceIdentifier[] - (beta): true maxItems: 500 description: | - If defined, the Cart Discount applies on [Carts](ctp:api:type:Cart) having a [Store](ctp:api:type:Store) matching any Store defined for this field. diff --git a/api-specs/api/types/cart-discount/CartDiscountResourceIdentifier.raml b/api-specs/api/types/cart-discount/CartDiscountResourceIdentifier.raml index 7c9a14ddf..4a78c524f 100644 --- a/api-specs/api/types/cart-discount/CartDiscountResourceIdentifier.raml +++ b/api-specs/api/types/cart-discount/CartDiscountResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: CartDiscountResourceIdentifier discriminatorValue: cart-discount description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [CartDiscount](ctp:api:type:CartDiscount). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [CartDiscount](ctp:api:type:CartDiscount). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [CartDiscount](ctp:api:type:CartDiscount). Either `id` or `key` is required. + Unique identifier of the referenced [CartDiscount](ctp:api:type:CartDiscount). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [CartDiscount](ctp:api:type:CartDiscount). Either `id` or `key` is required. + User-defined unique identifier of the referenced [CartDiscount](ctp:api:type:CartDiscount). Required if `id` is absent. diff --git a/api-specs/api/types/cart-discount/CartDiscountTotalPriceTarget.raml b/api-specs/api/types/cart-discount/CartDiscountTotalPriceTarget.raml index 2aa08443c..6a383ac40 100644 --- a/api-specs/api/types/cart-discount/CartDiscountTotalPriceTarget.raml +++ b/api-specs/api/types/cart-discount/CartDiscountTotalPriceTarget.raml @@ -1,6 +1,5 @@ #%RAML 1.0 DataType (package): CartDiscount -(beta): true type: CartDiscountTarget displayName: CartDiscountTotalPriceTarget discriminatorValue: totalPrice diff --git a/api-specs/api/types/cart-discount/CartDiscountUpdate.raml b/api-specs/api/types/cart-discount/CartDiscountUpdate.raml index 99f5fb1fc..2486a0611 100644 --- a/api-specs/api/types/cart-discount/CartDiscountUpdate.raml +++ b/api-specs/api/types/cart-discount/CartDiscountUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the CartDiscount on which the changes should be applied. If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + Expected version of the CartDiscount on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: CartDiscountUpdateAction diff --git a/api-specs/api/types/cart-discount/updates/CartDiscountAddStoreAction.raml b/api-specs/api/types/cart-discount/updates/CartDiscountAddStoreAction.raml index 092ba80bf..4bcc6f3a9 100644 --- a/api-specs/api/types/cart-discount/updates/CartDiscountAddStoreAction.raml +++ b/api-specs/api/types/cart-discount/updates/CartDiscountAddStoreAction.raml @@ -1,6 +1,5 @@ #%RAML 1.0 DataType (package): CartDiscount -(beta): true (docs-uri): https://docs.commercetools.com/api/projects/cartDiscounts#add-store type: CartDiscountUpdateAction displayName: CartDiscountAddStoreAction diff --git a/api-specs/api/types/cart-discount/updates/CartDiscountRemoveStoreAction.raml b/api-specs/api/types/cart-discount/updates/CartDiscountRemoveStoreAction.raml index b8d0c9d0f..0ab2c606d 100644 --- a/api-specs/api/types/cart-discount/updates/CartDiscountRemoveStoreAction.raml +++ b/api-specs/api/types/cart-discount/updates/CartDiscountRemoveStoreAction.raml @@ -1,6 +1,5 @@ #%RAML 1.0 DataType (package): CartDiscount -(beta): true (docs-uri): https://docs.commercetools.com/api/projects/cartDiscounts#remove-store type: CartDiscountUpdateAction displayName: CartDiscountRemoveStoreAction diff --git a/api-specs/api/types/cart-discount/updates/CartDiscountSetStoresAction.raml b/api-specs/api/types/cart-discount/updates/CartDiscountSetStoresAction.raml index dfc485575..ddd80deab 100644 --- a/api-specs/api/types/cart-discount/updates/CartDiscountSetStoresAction.raml +++ b/api-specs/api/types/cart-discount/updates/CartDiscountSetStoresAction.raml @@ -1,6 +1,5 @@ #%RAML 1.0 DataType (package): CartDiscount -(beta): true (docs-uri): https://docs.commercetools.com/api/projects/cartDiscounts#set-stores type: CartDiscountUpdateAction displayName: CartDiscountSetStoresAction diff --git a/api-specs/api/types/cart/Cart.raml b/api-specs/api/types/cart/Cart.raml index 0f08f2aab..0d376aad4 100644 --- a/api-specs/api/types/cart/Cart.raml +++ b/api-specs/api/types/cart/Cart.raml @@ -80,7 +80,6 @@ properties: Sum of the `taxedPrice` field of [ShippingInfo](ctp:api:type:ShippingInfo) across all Shipping Methods. discountOnTotalPrice?: type: DiscountOnTotalPrice - (beta): true description: |- Discounts that apply on the Cart `totalPrice`. taxMode: @@ -115,7 +114,7 @@ properties: shippingAddress?: type: Address description: | - Shipping address associated with the Cart. Determines eligible [ShippingMethod](ctp:api:type:ShippingMethod) rates and Tax Rates of Line Items. + Shipping address for a Cart with `Single` [ShippingMode](ctp:api:type:ShippingMode). Determines eligible [ShippingMethod](ctp:api:type:ShippingMethod) rates and Tax Rates of Line Items. shippingMode: type: ShippingMode description: |- @@ -152,7 +151,7 @@ properties: description: | Additional shipping addresses of the Cart as specified by [LineItems](ctp:api:type:LineItem) using the `shippingDetails` field. - Eligible Shipping Methods or applicable Tax Rates are determined by the address in `shippingAddress`, and not `itemShippingAddresses`. + For Carts with `Single` [ShippingMode](ctp:api:type:ShippingMode): eligible Shipping Methods or applicable Tax Rates are determined by the address in `shippingAddress`, and not `itemShippingAddresses`. discountCodes: type: DiscountCodeInfo[] description: | @@ -203,9 +202,9 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources updated after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). diff --git a/api-specs/api/types/cart/CartDraft.raml b/api-specs/api/types/cart/CartDraft.raml index 8b32fabd0..2f62a520d 100644 --- a/api-specs/api/types/cart/CartDraft.raml +++ b/api-specs/api/types/cart/CartDraft.raml @@ -81,7 +81,7 @@ properties: shippingAddress?: type: BaseAddress description: | - Shipping address associated with the Cart. Determines eligible [ShippingMethod](ctp:api:type:ShippingMethod) rates and Tax Rates of Line Items. + Shipping address for a Cart with `Single` [ShippingMode](ctp:api:type:ShippingMode). Determines eligible [ShippingMethod](ctp:api:type:ShippingMethod) rates and Tax Rates of Line Items. shippingMethod?: type: ShippingMethodResourceIdentifier description: | @@ -115,7 +115,7 @@ properties: Multiple shipping addresses of the Cart. Each address must contain a `key` that is unique in this Cart. The keys are used by [LineItems](ctp:api:type:LineItem) to reference these addresses under their `shippingDetails`. - Eligible Shipping Methods or applicable Tax Rates are determined by the address `shippingAddress`, and not `itemShippingAddresses`. + For Carts with `Single` [ShippingMode](ctp:api:type:ShippingMode): eligible Shipping Methods or applicable Tax Rates are determined by the address `shippingAddress`, and not `itemShippingAddresses`. discountCodes?: type: string[] description: | diff --git a/api-specs/api/types/cart/CartResourceIdentifier.raml b/api-specs/api/types/cart/CartResourceIdentifier.raml index dba4a7dd7..06d1376dd 100644 --- a/api-specs/api/types/cart/CartResourceIdentifier.raml +++ b/api-specs/api/types/cart/CartResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: CartResourceIdentifier discriminatorValue: cart description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Cart](ctp:api:type:Cart). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Cart](ctp:api:type:Cart). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Cart](ctp:api:type:Cart). Either `id` or `key` is required. + Unique identifier of the referenced [Cart](ctp:api:type:Cart). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Cart](ctp:api:type:Cart). Either `id` or `key` is required. + User-defined unique identifier of the referenced [Cart](ctp:api:type:Cart). Required if `id` is absent. diff --git a/api-specs/api/types/cart/CartUpdate.raml b/api-specs/api/types/cart/CartUpdate.raml index e1305051f..2d0b436e3 100644 --- a/api-specs/api/types/cart/CartUpdate.raml +++ b/api-specs/api/types/cart/CartUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the Cart on which the changes apply. - If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) is returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: CartUpdateAction diff --git a/api-specs/api/types/cart/DiscountOnTotalPrice.raml b/api-specs/api/types/cart/DiscountOnTotalPrice.raml index c0ab26433..4b5d861c3 100644 --- a/api-specs/api/types/cart/DiscountOnTotalPrice.raml +++ b/api-specs/api/types/cart/DiscountOnTotalPrice.raml @@ -1,6 +1,5 @@ #%RAML 1.0 DataType (package): Cart -(beta): true (docs-uri): https://docs.commercetools.com/api/projects/carts#discountontotalprice displayName: DiscountOnTotalPrice type: object diff --git a/api-specs/api/types/cart/DiscountedTotalPricePortion.raml b/api-specs/api/types/cart/DiscountedTotalPricePortion.raml index a32530dd0..cb232ec4b 100644 --- a/api-specs/api/types/cart/DiscountedTotalPricePortion.raml +++ b/api-specs/api/types/cart/DiscountedTotalPricePortion.raml @@ -1,6 +1,5 @@ #%RAML 1.0 DataType (package): Cart -(beta): true (docs-uri): https://docs.commercetools.com/api/projects/carts#discountedtotalpriceportion displayName: DiscountedTotalPricePortion type: object diff --git a/api-specs/api/types/cart/ExternalTaxRateDraft.raml b/api-specs/api/types/cart/ExternalTaxRateDraft.raml index 9bc576297..41f9b8efe 100644 --- a/api-specs/api/types/cart/ExternalTaxRateDraft.raml +++ b/api-specs/api/types/cart/ExternalTaxRateDraft.raml @@ -36,5 +36,4 @@ properties: subRates?: type: SubRate[] description: | - For countries (such as the US) where the total tax is a combination of multiple taxes (such as state and local taxes). - (beta): true + For countries (such as the US) where the total tax is a combination of multiple taxes (such as state and local taxes). The total of all subrates must equal the TaxRate `amount`. diff --git a/api-specs/api/types/category/Category.raml b/api-specs/api/types/category/Category.raml index f8f69c1f8..5ee61a078 100644 --- a/api-specs/api/types/category/Category.raml +++ b/api-specs/api/types/category/Category.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources updated after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). name: type: LocalizedString description: | diff --git a/api-specs/api/types/category/CategoryResourceIdentifier.raml b/api-specs/api/types/category/CategoryResourceIdentifier.raml index 33a987d08..0cd0863a4 100644 --- a/api-specs/api/types/category/CategoryResourceIdentifier.raml +++ b/api-specs/api/types/category/CategoryResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: CategoryResourceIdentifier discriminatorValue: category description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Category](ctp:api:type:Category). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Category](ctp:api:type:Category). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Category](ctp:api:type:Channel). Either `id` or `key` is required. + Unique identifier of the referenced [Category](ctp:api:type:Channel). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Category](ctp:api:type:Category). Either `id` or `key` is required. + User-defined unique identifier of the referenced [Category](ctp:api:type:Category). Required if `id` is absent. diff --git a/api-specs/api/types/category/CategoryUpdate.raml b/api-specs/api/types/category/CategoryUpdate.raml index 2c30c7226..25bb96987 100644 --- a/api-specs/api/types/category/CategoryUpdate.raml +++ b/api-specs/api/types/category/CategoryUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the Category on which the changes should be applied. - If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: CategoryUpdateAction diff --git a/api-specs/api/types/channel/Channel.raml b/api-specs/api/types/channel/Channel.raml index fd08e94b1..9a6b351f3 100644 --- a/api-specs/api/types/channel/Channel.raml +++ b/api-specs/api/types/channel/Channel.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources updated after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key: type: string description: | diff --git a/api-specs/api/types/channel/ChannelResourceIdentifier.raml b/api-specs/api/types/channel/ChannelResourceIdentifier.raml index c23c7a369..e0797ee90 100644 --- a/api-specs/api/types/channel/ChannelResourceIdentifier.raml +++ b/api-specs/api/types/channel/ChannelResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ChannelResourceIdentifier discriminatorValue: channel description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Channel](ctp:api:type:Channel). Either `id` or `key` is required. + Unique identifier of the referenced [Channel](ctp:api:type:Channel). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Channel](ctp:api:type:Channel). Either `id` or `key` is required. + User-defined unique identifier of the referenced [Channel](ctp:api:type:Channel). Required if `id` is absent. diff --git a/api-specs/api/types/channel/ChannelUpdate.raml b/api-specs/api/types/channel/ChannelUpdate.raml index b0575fcc3..26e5a1a0e 100644 --- a/api-specs/api/types/channel/ChannelUpdate.raml +++ b/api-specs/api/types/channel/ChannelUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the Channel on which the changes should be applied. If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + Expected version of the Channel on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: ChannelUpdateAction diff --git a/api-specs/api/types/common/ClientLogging.raml b/api-specs/api/types/common/ClientLogging.raml index eec28d60b..3b9713aad 100644 --- a/api-specs/api/types/common/ClientLogging.raml +++ b/api-specs/api/types/common/ClientLogging.raml @@ -4,7 +4,7 @@ displayName: ClientLogging type: object description: | - These objects represent information about which [API Client](/../api/projects/api-clients) created or modified a resource. For more information, see [Client Logging](/client-logging). + These objects represent information about which [API Client](/../api/projects/api-clients) created or modified a resource. For more information, see [Client Logging](/../api/general-concepts#client-logging). properties: clientId?: type: string @@ -13,7 +13,7 @@ properties: externalUserId?: type: string description: | - [External user ID](/../api/client-logging#external-user-ids) provided by `X-External-User-ID` HTTP Header. + [External user ID](/../api/general-concepts#external-user-ids) provided by `X-External-User-ID` HTTP Header. maxLength: 128 customer?: type: CustomerReference diff --git a/api-specs/api/types/common/CreatedBy.raml b/api-specs/api/types/common/CreatedBy.raml index 0dc8df0df..c44bfd7e1 100644 --- a/api-specs/api/types/common/CreatedBy.raml +++ b/api-specs/api/types/common/CreatedBy.raml @@ -2,7 +2,7 @@ (package): Common displayName: CreatedBy type: ClientLogging -description: Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). +description: Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). properties: clientId?: type: string @@ -11,7 +11,7 @@ properties: externalUserId?: type: string description: | - [External user ID](/../api/client-logging#external-user-ids) provided by `X-External-User-ID` HTTP Header. + [External user ID](/../api/general-concepts#external-user-ids) provided by `X-External-User-ID` HTTP Header or [`external_user_id:{externalUserId}`](/../api/scopes#external_user_idexternaluserid) scope. maxLength: 128 customer?: type: CustomerReference diff --git a/api-specs/api/types/common/LastModifiedBy.raml b/api-specs/api/types/common/LastModifiedBy.raml index 7edd97b4a..a38bcd983 100644 --- a/api-specs/api/types/common/LastModifiedBy.raml +++ b/api-specs/api/types/common/LastModifiedBy.raml @@ -2,7 +2,7 @@ (package): Common displayName: LastModifiedBy type: ClientLogging -description: Present on resources modified after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). +description: Present on resources modified after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). properties: clientId?: type: string @@ -11,7 +11,7 @@ properties: externalUserId?: type: string description: | - [External user ID](/../api/client-logging#external-user-ids) provided by `X-External-User-ID` HTTP Header. + [External user ID](/../api/general-concepts#external-user-ids) provided by `X-External-User-ID` HTTP Header or [`external_user_id:{externalUserId}`](/../api/scopes#external_user_idexternaluserid) scope. maxLength: 128 customer?: type: CustomerReference diff --git a/api-specs/api/types/custom-object/CustomObject.raml b/api-specs/api/types/custom-object/CustomObject.raml index 417e50925..67ece25cc 100644 --- a/api-specs/api/types/custom-object/CustomObject.raml +++ b/api-specs/api/types/custom-object/CustomObject.raml @@ -26,12 +26,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). container: type: string description: | diff --git a/api-specs/api/types/customer-group/CustomerGroup.raml b/api-specs/api/types/customer-group/CustomerGroup.raml index aa965f4be..6dadd10c5 100644 --- a/api-specs/api/types/customer-group/CustomerGroup.raml +++ b/api-specs/api/types/customer-group/CustomerGroup.raml @@ -28,12 +28,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources updated after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/api/types/customer-group/CustomerGroupResourceIdentifier.raml b/api-specs/api/types/customer-group/CustomerGroupResourceIdentifier.raml index a2591f96f..082b98bc9 100644 --- a/api-specs/api/types/customer-group/CustomerGroupResourceIdentifier.raml +++ b/api-specs/api/types/customer-group/CustomerGroupResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: CustomerGroupResourceIdentifier discriminatorValue: customer-group description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [CustomerGroup](ctp:api:type:CustomerGroup). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [CustomerGroup](ctp:api:type:CustomerGroup). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [CustomerGroup](ctp:api:type:CustomerGroup). Either `id` or `key` is required. + Unique identifier of the referenced [CustomerGroup](ctp:api:type:CustomerGroup). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [CustomerGroup](ctp:api:type:CustomerGroup). Either `id` or `key` is required. + User-defined unique identifier of the referenced [CustomerGroup](ctp:api:type:CustomerGroup). Required if `id` is absent. diff --git a/api-specs/api/types/customer-group/CustomerGroupUpdate.raml b/api-specs/api/types/customer-group/CustomerGroupUpdate.raml index b33adf96a..6eb96a05a 100644 --- a/api-specs/api/types/customer-group/CustomerGroupUpdate.raml +++ b/api-specs/api/types/customer-group/CustomerGroupUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the CustomerGroup on which the changes should be applied. - If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: CustomerGroupUpdateAction diff --git a/api-specs/api/types/customer/Customer.raml b/api-specs/api/types/customer/Customer.raml index 6a7a0448a..3b77f5748 100644 --- a/api-specs/api/types/customer/Customer.raml +++ b/api-specs/api/types/customer/Customer.raml @@ -46,12 +46,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). email: type: string description: | diff --git a/api-specs/api/types/customer/CustomerResourceIdentifier.raml b/api-specs/api/types/customer/CustomerResourceIdentifier.raml index 4aa426234..a7b90bd90 100644 --- a/api-specs/api/types/customer/CustomerResourceIdentifier.raml +++ b/api-specs/api/types/customer/CustomerResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: CustomerResourceIdentifier discriminatorValue: customer description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Customer](ctp:api:type:Customer). Either `id` or `key` is required. + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Customer](ctp:api:type:Customer). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Customer](ctp:api:type:Customer). + Unique identifier of the referenced [Customer](ctp:api:type:Customer). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Customer](ctp:api:type:Customer). + User-defined unique identifier of the referenced [Customer](ctp:api:type:Customer). Required if `id` is absent. diff --git a/api-specs/api/types/customer/CustomerUpdate.raml b/api-specs/api/types/customer/CustomerUpdate.raml index 9261d90f7..69cb1d923 100644 --- a/api-specs/api/types/customer/CustomerUpdate.raml +++ b/api-specs/api/types/customer/CustomerUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the Customer on which the changes should be applied. If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned. + Expected version of the Customer on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: CustomerUpdateAction diff --git a/api-specs/api/types/customer/updates/CustomerChangeEmailAction.raml b/api-specs/api/types/customer/updates/CustomerChangeEmailAction.raml index cc34678eb..aadfe8076 100644 --- a/api-specs/api/types/customer/updates/CustomerChangeEmailAction.raml +++ b/api-specs/api/types/customer/updates/CustomerChangeEmailAction.raml @@ -6,7 +6,7 @@ displayName: CustomerChangeEmailAction discriminatorValue: changeEmail example: !include ../../../examples/Customer/CustomerChangeEmailAction.json description: | - Changing the email of the Customer produces the [CustomerEmailChanged](ctp:api:type:CustomerEmailChangedMessage) Message. + Changes the `email` of the Customer and sets the `isEmailVerified` property to `false`. This update action generates a [CustomerEmailChanged](ctp:api:type:CustomerEmailChangedMessage) Message. properties: email: type: string diff --git a/api-specs/api/types/discount-code/DiscountCode.raml b/api-specs/api/types/discount-code/DiscountCode.raml index 7bc258f00..63d1dce15 100644 --- a/api-specs/api/types/discount-code/DiscountCode.raml +++ b/api-specs/api/types/discount-code/DiscountCode.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). name?: type: LocalizedString description: | diff --git a/api-specs/api/types/discount-code/DiscountCodeResourceIdentifier.raml b/api-specs/api/types/discount-code/DiscountCodeResourceIdentifier.raml index 4a576ca32..a447f8cce 100644 --- a/api-specs/api/types/discount-code/DiscountCodeResourceIdentifier.raml +++ b/api-specs/api/types/discount-code/DiscountCodeResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: DiscountCodeResourceIdentifier discriminatorValue: discount-code description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [DiscountCode](ctp:api:type:DiscountCode). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [DiscountCode](ctp:api:type:DiscountCode). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [DiscountCode](ctp:api:type:DiscountCode). Either `id` or `key` is required. + Unique identifier of the referenced [DiscountCode](ctp:api:type:DiscountCode). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [DiscountCode](ctp:api:type:DiscountCode). Either `id` or `key` is required. + User-defined unique identifier of the referenced [DiscountCode](ctp:api:type:DiscountCode). Required if `id` is absent. diff --git a/api-specs/api/types/discount-code/DiscountCodeUpdate.raml b/api-specs/api/types/discount-code/DiscountCodeUpdate.raml index 6a5ea7c6e..fced0b4e6 100644 --- a/api-specs/api/types/discount-code/DiscountCodeUpdate.raml +++ b/api-specs/api/types/discount-code/DiscountCodeUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the DiscountCode on which the changes should be applied. - If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: DiscountCodeUpdateAction diff --git a/api-specs/api/types/error/MaxStoreReferencesReachedError.raml b/api-specs/api/types/error/MaxStoreReferencesReachedError.raml index 7b69504c6..639706c75 100644 --- a/api-specs/api/types/error/MaxStoreReferencesReachedError.raml +++ b/api-specs/api/types/error/MaxStoreReferencesReachedError.raml @@ -1,6 +1,5 @@ #%RAML 1.0 DataType (package): Error -(beta): true type: ErrorObject displayName: MaxStoreReferencesReachedError discriminatorValue: MaxStoreReferencesReached diff --git a/api-specs/api/types/error/NotEnabledError.raml b/api-specs/api/types/error/NotEnabledError.raml deleted file mode 100644 index 3ca1edb84..000000000 --- a/api-specs/api/types/error/NotEnabledError.raml +++ /dev/null @@ -1,14 +0,0 @@ -#%RAML 1.0 DataType -(package): Error -type: ErrorObject -displayName: NotEnabledError -discriminatorValue: NotEnabled -description: | - Returned when the [Project-specific category recommendations feature](/../api/projects/categoryRecommendations#project-specific-category-recommendations) is not enabled for the Project. -properties: - code: - type: string - message: - type: string - description: | - `"The category recommendations API is not yet enabled for your project."` diff --git a/api-specs/api/types/error/StoreCartDiscountsLimitReachedError.raml b/api-specs/api/types/error/StoreCartDiscountsLimitReachedError.raml index c610ce815..e08789358 100644 --- a/api-specs/api/types/error/StoreCartDiscountsLimitReachedError.raml +++ b/api-specs/api/types/error/StoreCartDiscountsLimitReachedError.raml @@ -1,6 +1,5 @@ #%RAML 1.0 DataType (package): Error -(beta): true type: ErrorObject displayName: StoreCartDiscountsLimitReachedError discriminatorValue: StoreCartDiscountsLimitReached diff --git a/api-specs/api/types/error/graphql/GraphQLMaxStoreReferencesReachedError.raml b/api-specs/api/types/error/graphql/GraphQLMaxStoreReferencesReachedError.raml index 1215e9a1a..e57fcd6cc 100644 --- a/api-specs/api/types/error/graphql/GraphQLMaxStoreReferencesReachedError.raml +++ b/api-specs/api/types/error/graphql/GraphQLMaxStoreReferencesReachedError.raml @@ -1,6 +1,5 @@ #%RAML 1.0 DataType (package): Error -(beta): true type: GraphQLErrorObject displayName: GraphQLMaxStoreReferencesReachedError discriminatorValue: MaxStoreReferencesReached diff --git a/api-specs/api/types/error/graphql/GraphQLNotEnabledError.raml b/api-specs/api/types/error/graphql/GraphQLNotEnabledError.raml deleted file mode 100644 index 5a5759525..000000000 --- a/api-specs/api/types/error/graphql/GraphQLNotEnabledError.raml +++ /dev/null @@ -1,10 +0,0 @@ -#%RAML 1.0 DataType -(package): Error -type: GraphQLErrorObject -displayName: GraphQLNotEnabledError -discriminatorValue: NotEnabled -description: | - Returned when the [Project-specific category recommendations feature](/../api/projects/categoryRecommendations#project-specific-category-recommendations) is not enabled for the Project. -properties: - code: - type: string diff --git a/api-specs/api/types/error/graphql/GraphQLStoreCartDiscountsLimitReachedError.raml b/api-specs/api/types/error/graphql/GraphQLStoreCartDiscountsLimitReachedError.raml index c74e86bd1..24c795c6c 100644 --- a/api-specs/api/types/error/graphql/GraphQLStoreCartDiscountsLimitReachedError.raml +++ b/api-specs/api/types/error/graphql/GraphQLStoreCartDiscountsLimitReachedError.raml @@ -1,6 +1,5 @@ #%RAML 1.0 DataType (package): Error -(beta): true type: GraphQLErrorObject displayName: GraphQLStoreCartDiscountsLimitReachedError discriminatorValue: StoreCartDiscountsLimitReached diff --git a/api-specs/api/types/extension/Extension.raml b/api-specs/api/types/extension/Extension.raml index bdaa3cf0f..645744314 100644 --- a/api-specs/api/types/extension/Extension.raml +++ b/api-specs/api/types/extension/Extension.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/api/types/extension/ExtensionUpdate.raml b/api-specs/api/types/extension/ExtensionUpdate.raml index 6bba6dec7..2b0982255 100644 --- a/api-specs/api/types/extension/ExtensionUpdate.raml +++ b/api-specs/api/types/extension/ExtensionUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the Extension on which the changes should be applied. If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + Expected version of the Extension on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: ExtensionUpdateAction diff --git a/api-specs/api/types/inventory/InventoryEntry.raml b/api-specs/api/types/inventory/InventoryEntry.raml index 73e19cf47..a23ad990f 100644 --- a/api-specs/api/types/inventory/InventoryEntry.raml +++ b/api-specs/api/types/inventory/InventoryEntry.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/api/types/inventory/InventoryEntryResourceIdentifier.raml b/api-specs/api/types/inventory/InventoryEntryResourceIdentifier.raml index 92c0eeae3..83ee2199f 100644 --- a/api-specs/api/types/inventory/InventoryEntryResourceIdentifier.raml +++ b/api-specs/api/types/inventory/InventoryEntryResourceIdentifier.raml @@ -4,13 +4,13 @@ type: ResourceIdentifier displayName: InventoryEntryResourceIdentifier discriminatorValue: inventory-entry description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [InventoryEntry](ctp:api:type:InventoryEntry). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [InventoryEntry](ctp:api:type:InventoryEntry). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Either `id` or `key` is required. + Unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Either `id` or `key` is required. + User-defined unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Required if `id` is absent. diff --git a/api-specs/api/types/inventory/InventoryEntryUpdate.raml b/api-specs/api/types/inventory/InventoryEntryUpdate.raml index 5fa15589d..2f08beec2 100644 --- a/api-specs/api/types/inventory/InventoryEntryUpdate.raml +++ b/api-specs/api/types/inventory/InventoryEntryUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the InventoryEntry on which the changes should be applied. If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + Expected version of the InventoryEntry on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: InventoryEntryUpdateAction diff --git a/api-specs/api/types/me/MyBusinessUnitAssociateDraft.raml b/api-specs/api/types/me/MyBusinessUnitAssociateDraft.raml index 41c8674ee..4caad7d2c 100644 --- a/api-specs/api/types/me/MyBusinessUnitAssociateDraft.raml +++ b/api-specs/api/types/me/MyBusinessUnitAssociateDraft.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the BusinessUnit on which the changes should be applied. If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned. + Expected version of the BusinessUnit on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. customer: type: MyCustomerDraft description: | diff --git a/api-specs/api/types/me/MyBusinessUnitUpdate.raml b/api-specs/api/types/me/MyBusinessUnitUpdate.raml index df8b17a9c..b5723057d 100644 --- a/api-specs/api/types/me/MyBusinessUnitUpdate.raml +++ b/api-specs/api/types/me/MyBusinessUnitUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the BusinessUnit on which the changes should be applied. - If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: BusinessUnitUpdateAction diff --git a/api-specs/api/types/me/MyCartUpdate.raml b/api-specs/api/types/me/MyCartUpdate.raml index c6930fb86..acc28db81 100644 --- a/api-specs/api/types/me/MyCartUpdate.raml +++ b/api-specs/api/types/me/MyCartUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the Cart on which the changes apply. - If it does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error is returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: MyCartUpdateAction diff --git a/api-specs/api/types/me/MyCustomerUpdate.raml b/api-specs/api/types/me/MyCustomerUpdate.raml index f96218dcf..02fed5047 100644 --- a/api-specs/api/types/me/MyCustomerUpdate.raml +++ b/api-specs/api/types/me/MyCustomerUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the Customer on which the changes should be applied. If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned. + Expected version of the Customer on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: MyCustomerUpdateAction diff --git a/api-specs/api/types/me/MyPaymentUpdate.raml b/api-specs/api/types/me/MyPaymentUpdate.raml index c31c94f54..81264b413 100644 --- a/api-specs/api/types/me/MyPaymentUpdate.raml +++ b/api-specs/api/types/me/MyPaymentUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the Payment on which the changes should be applied. If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) will be returned. + Expected version of the Payment on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: MyPaymentUpdateAction diff --git a/api-specs/api/types/me/MyQuoteUpdate.raml b/api-specs/api/types/me/MyQuoteUpdate.raml index 0f2a46401..895af664e 100644 --- a/api-specs/api/types/me/MyQuoteUpdate.raml +++ b/api-specs/api/types/me/MyQuoteUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the [Quote](ctp:api:type:Quote) to which the changes should be applied. - If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: MyQuoteUpdateAction diff --git a/api-specs/api/types/me/MyShoppingListUpdate.raml b/api-specs/api/types/me/MyShoppingListUpdate.raml index 97c0401f4..491ab5bac 100644 --- a/api-specs/api/types/me/MyShoppingListUpdate.raml +++ b/api-specs/api/types/me/MyShoppingListUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the ShoppingList on which the changes should be applied. If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) will be returned. + Expected version of the ShoppingList on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: MyShoppingListUpdateAction diff --git a/api-specs/api/types/message/Message.raml b/api-specs/api/types/message/Message.raml index 0c2151ac3..e7194a971 100644 --- a/api-specs/api/types/message/Message.raml +++ b/api-specs/api/types/message/Message.raml @@ -30,7 +30,7 @@ properties: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). sequenceNumber: type: number format: int64 diff --git a/api-specs/api/types/order-edit/OrderEdit.raml b/api-specs/api/types/order-edit/OrderEdit.raml index 47dbf6718..7a69dfa61 100644 --- a/api-specs/api/types/order-edit/OrderEdit.raml +++ b/api-specs/api/types/order-edit/OrderEdit.raml @@ -55,9 +55,9 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). diff --git a/api-specs/api/types/order-edit/OrderEditApply.raml b/api-specs/api/types/order-edit/OrderEditApply.raml index 197691a28..d62fd9178 100644 --- a/api-specs/api/types/order-edit/OrderEditApply.raml +++ b/api-specs/api/types/order-edit/OrderEditApply.raml @@ -3,7 +3,7 @@ type: object displayName: OrderEditApply description: | - If the `editVersion` and/or `resourceVersion` do not match the actual version, a [409 Conflict](/../api/errors#409-conflict) will be returned. + If the `editVersion` and/or `resourceVersion` do not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. properties: editVersion: type: number diff --git a/api-specs/api/types/order-edit/OrderEditResourceIdentifier.raml b/api-specs/api/types/order-edit/OrderEditResourceIdentifier.raml index d9834d2ca..102d9cd88 100644 --- a/api-specs/api/types/order-edit/OrderEditResourceIdentifier.raml +++ b/api-specs/api/types/order-edit/OrderEditResourceIdentifier.raml @@ -4,13 +4,13 @@ type: ResourceIdentifier displayName: OrderEditResourceIdentifier discriminatorValue: order-edit description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [OrderEdit](ctp:api:type:OrderEdit). Either `id` or `key` is required. + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [OrderEdit](ctp:api:type:OrderEdit). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit). + Unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit). + User-defined unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit). Required if `id` is absent. diff --git a/api-specs/api/types/order-edit/OrderEditUpdate.raml b/api-specs/api/types/order-edit/OrderEditUpdate.raml index 8bcec5741..41f8bda62 100644 --- a/api-specs/api/types/order-edit/OrderEditUpdate.raml +++ b/api-specs/api/types/order-edit/OrderEditUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the Order Edit on which the changes should be applied. - If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) will be returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: OrderEditUpdateAction[] description: | diff --git a/api-specs/api/types/order/Order.raml b/api-specs/api/types/order/Order.raml index e8b045b6f..a4ff2460e 100644 --- a/api-specs/api/types/order/Order.raml +++ b/api-specs/api/types/order/Order.raml @@ -78,7 +78,6 @@ properties: Sum of the `taxedPrice` field of [ShippingInfo](ctp:api:type:ShippingInfo) across all Shipping Methods. discountOnTotalPrice?: type: DiscountOnTotalPrice - (beta): true description: |- Discounts that apply on the total price of the Order. taxMode?: @@ -240,9 +239,9 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). diff --git a/api-specs/api/types/order/OrderUpdate.raml b/api-specs/api/types/order/OrderUpdate.raml index fc1d4b446..d9409c7ff 100644 --- a/api-specs/api/types/order/OrderUpdate.raml +++ b/api-specs/api/types/order/OrderUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the Order on which the changes should be applied. - If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) will be returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: OrderUpdateAction diff --git a/api-specs/api/types/order/ShipmentState.raml b/api-specs/api/types/order/ShipmentState.raml index 2203a2b5a..a0e626630 100644 --- a/api-specs/api/types/order/ShipmentState.raml +++ b/api-specs/api/types/order/ShipmentState.raml @@ -3,7 +3,7 @@ (docs-uri): https://docs.commercetools.com/api/projects/orders#shipmentstate type: string description: | - Indicates the shipment status of the Parcel. + Indicates the shipment status of the Order. enum: - Shipped - Delivered diff --git a/api-specs/api/types/payment/Payment.raml b/api-specs/api/types/payment/Payment.raml index c328e66c8..50afef3f8 100644 --- a/api-specs/api/types/payment/Payment.raml +++ b/api-specs/api/types/payment/Payment.raml @@ -23,12 +23,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). customer?: type: CustomerReference description: | diff --git a/api-specs/api/types/payment/PaymentResourceIdentifier.raml b/api-specs/api/types/payment/PaymentResourceIdentifier.raml index deb6eaab8..5e657a7c8 100644 --- a/api-specs/api/types/payment/PaymentResourceIdentifier.raml +++ b/api-specs/api/types/payment/PaymentResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: PaymentResourceIdentifier discriminatorValue: payment description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Payment](ctp:api:type:Payment). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Payment](ctp:api:type:Payment). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Payment](ctp:api:type:Payment). Either `id` or `key` is required. + Unique identifier of the referenced [Payment](ctp:api:type:Payment). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Payment](ctp:api:type:Payment). Either `id` or `key` is required. + User-defined unique identifier of the referenced [Payment](ctp:api:type:Payment). Required if `id` is absent. diff --git a/api-specs/api/types/payment/PaymentUpdate.raml b/api-specs/api/types/payment/PaymentUpdate.raml index 3de3b65f1..53cd20fdb 100644 --- a/api-specs/api/types/payment/PaymentUpdate.raml +++ b/api-specs/api/types/payment/PaymentUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the Payment on which the changes should be applied. If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned. + Expected version of the Payment on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: PaymentUpdateAction diff --git a/api-specs/api/types/product-discount/ProductDiscount.raml b/api-specs/api/types/product-discount/ProductDiscount.raml index 6066d2668..65b7b07e9 100644 --- a/api-specs/api/types/product-discount/ProductDiscount.raml +++ b/api-specs/api/types/product-discount/ProductDiscount.raml @@ -28,12 +28,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). name: type: LocalizedString description: | diff --git a/api-specs/api/types/product-discount/ProductDiscountResourceIdentifier.raml b/api-specs/api/types/product-discount/ProductDiscountResourceIdentifier.raml index 704da82d0..02bc4697d 100644 --- a/api-specs/api/types/product-discount/ProductDiscountResourceIdentifier.raml +++ b/api-specs/api/types/product-discount/ProductDiscountResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ProductDiscountResourceIdentifier discriminatorValue: product-discount description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductDiscount](ctp:api:type:ProductDiscount). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductDiscount](ctp:api:type:ProductDiscount). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [ProductDiscount](ctp:api:type:ProductDiscount). Either `id` or `key` is required. + Unique identifier of the referenced [ProductDiscount](ctp:api:type:ProductDiscount). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [ProductDiscount](ctp:api:type:ProductDiscount). Either `id` or `key` is required. + User-defined unique identifier of the referenced [ProductDiscount](ctp:api:type:ProductDiscount). Required if `id` is absent. diff --git a/api-specs/api/types/product-discount/ProductDiscountUpdate.raml b/api-specs/api/types/product-discount/ProductDiscountUpdate.raml index 71bba104a..a1aa5b166 100644 --- a/api-specs/api/types/product-discount/ProductDiscountUpdate.raml +++ b/api-specs/api/types/product-discount/ProductDiscountUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the ProductDiscount on which the changes should be applied. If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + Expected version of the ProductDiscount on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: ProductDiscountUpdateAction diff --git a/api-specs/api/types/product-selection/ProductSelection.raml b/api-specs/api/types/product-selection/ProductSelection.raml index e990efda2..2aa3648af 100644 --- a/api-specs/api/types/product-selection/ProductSelection.raml +++ b/api-specs/api/types/product-selection/ProductSelection.raml @@ -25,11 +25,11 @@ properties: lastModifiedBy?: type: LastModifiedBy description: |- - Present on resources updated after 1/02/2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1/02/2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy description: |- - Present on resources created after 1/02/2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1/02/2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/api/types/product-selection/ProductSelectionResourceIdentifier.raml b/api-specs/api/types/product-selection/ProductSelectionResourceIdentifier.raml index daecdf269..03773fda0 100644 --- a/api-specs/api/types/product-selection/ProductSelectionResourceIdentifier.raml +++ b/api-specs/api/types/product-selection/ProductSelectionResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ProductSelectionResourceIdentifier discriminatorValue: product-selection description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductSelection](ctp:api:type:ProductSelection). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductSelection](ctp:api:type:ProductSelection). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [ProductSelection](ctp:api:type:ProductSelection). Either `id` or `key` is required. + Unique identifier of the referenced [ProductSelection](ctp:api:type:ProductSelection). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [ProductSelection](ctp:api:type:ProductSelection). Either `id` or `key` is required. + User-defined unique identifier of the referenced [ProductSelection](ctp:api:type:ProductSelection). Required if `id` is absent. diff --git a/api-specs/api/types/product-type/AttributeReferenceTypeId.raml b/api-specs/api/types/product-type/AttributeReferenceTypeId.raml index 06f7ce231..16d726e87 100644 --- a/api-specs/api/types/product-type/AttributeReferenceTypeId.raml +++ b/api-specs/api/types/product-type/AttributeReferenceTypeId.raml @@ -6,7 +6,10 @@ type: string description: | Name of the resource type that the value should reference. Supported resource type identifiers: enum: + - associate-role + - business-unit - cart + - cart-discount - category - channel - customer @@ -19,8 +22,14 @@ enum: - state - zone (enumDescriptions): + associate-role: | + References a [AssociateRole](ctp:api:type:AssociateRole). + business-unit: | + References a [BusinessUnit](ctp:api:type:BusinessUnit). cart: | References a [Cart](ctp:api:type:Cart). + cart-discount: | + References a [CartDiscount](ctp:api:type:CartDiscount). category: | References a [Category](ctp:api:type:Category). channel: | diff --git a/api-specs/api/types/product-type/ProductType.raml b/api-specs/api/types/product-type/ProductType.raml index 6a3210704..01e0bda07 100644 --- a/api-specs/api/types/product-type/ProductType.raml +++ b/api-specs/api/types/product-type/ProductType.raml @@ -26,12 +26,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: |- diff --git a/api-specs/api/types/product-type/ProductTypeResourceIdentifier.raml b/api-specs/api/types/product-type/ProductTypeResourceIdentifier.raml index 691181b3c..71765becd 100644 --- a/api-specs/api/types/product-type/ProductTypeResourceIdentifier.raml +++ b/api-specs/api/types/product-type/ProductTypeResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ProductTypeResourceIdentifier discriminatorValue: product-type description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductType](ctp:api:type:ProductType). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductType](ctp:api:type:ProductType). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [ProductType](ctp:api:type:ProductType). Either `id` or `key` is required. + Unique identifier of the referenced [ProductType](ctp:api:type:ProductType). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [ProductType](ctp:api:type:ProductType). Either `id` or `key` is required. + User-defined unique identifier of the referenced [ProductType](ctp:api:type:ProductType). Required if `id` is absent. diff --git a/api-specs/api/types/product-type/ProductTypeUpdate.raml b/api-specs/api/types/product-type/ProductTypeUpdate.raml index e43af3a6a..8704216ea 100644 --- a/api-specs/api/types/product-type/ProductTypeUpdate.raml +++ b/api-specs/api/types/product-type/ProductTypeUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the ProductType on which the changes should be applied. If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + Expected version of the ProductType on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: ProductTypeUpdateAction diff --git a/api-specs/api/types/product/Product.raml b/api-specs/api/types/product/Product.raml index 5b6867308..304796b1b 100644 --- a/api-specs/api/types/product/Product.raml +++ b/api-specs/api/types/product/Product.raml @@ -32,12 +32,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/api/types/product/ProductResourceIdentifier.raml b/api-specs/api/types/product/ProductResourceIdentifier.raml index 811d14660..8a0d36847 100644 --- a/api-specs/api/types/product/ProductResourceIdentifier.raml +++ b/api-specs/api/types/product/ProductResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ProductResourceIdentifier discriminatorValue: product description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Product](ctp:api:type:Product). Either `id` or `key` is required. + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Product](ctp:api:type:Product). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Product](ctp:api:type:Product). + Unique identifier of the referenced [Product](ctp:api:type:Product). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Product](ctp:api:type:Product). + User-defined unique identifier of the referenced [Product](ctp:api:type:Product). Required if `id` is absent. diff --git a/api-specs/api/types/product/ProductUpdate.raml b/api-specs/api/types/product/ProductUpdate.raml index 0d53277dd..d4c013dfd 100644 --- a/api-specs/api/types/product/ProductUpdate.raml +++ b/api-specs/api/types/product/ProductUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the Product on which the changes should be applied. If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) will be returned. + Expected version of the Product on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: ProductUpdateAction diff --git a/api-specs/api/types/project/ProjectUpdate.raml b/api-specs/api/types/project/ProjectUpdate.raml index 535d1c9f2..2a041bb9c 100644 --- a/api-specs/api/types/project/ProjectUpdate.raml +++ b/api-specs/api/types/project/ProjectUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the Project on which the changes should be applied. If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + Expected version of the Project on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: ProjectUpdateAction diff --git a/api-specs/api/types/project/SearchIndexingConfigurationValues.raml b/api-specs/api/types/project/SearchIndexingConfigurationValues.raml index fc19b602c..8b4cbb0d1 100644 --- a/api-specs/api/types/project/SearchIndexingConfigurationValues.raml +++ b/api-specs/api/types/project/SearchIndexingConfigurationValues.raml @@ -14,4 +14,4 @@ properties: (beta): true type: LastModifiedBy description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). diff --git a/api-specs/api/types/quote-request/QuoteRequest.raml b/api-specs/api/types/quote-request/QuoteRequest.raml index 48b8cb84d..d1cec9555 100644 --- a/api-specs/api/types/quote-request/QuoteRequest.raml +++ b/api-specs/api/types/quote-request/QuoteRequest.raml @@ -34,12 +34,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). quoteRequestState: type: QuoteRequestState description: | diff --git a/api-specs/api/types/quote-request/QuoteRequestUpdate.raml b/api-specs/api/types/quote-request/QuoteRequestUpdate.raml index 106589e00..fc28819ae 100644 --- a/api-specs/api/types/quote-request/QuoteRequestUpdate.raml +++ b/api-specs/api/types/quote-request/QuoteRequestUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the [QuoteRequest](ctp:api:type:QuoteRequest) to which the changes should be applied. - If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: QuoteRequestUpdateAction diff --git a/api-specs/api/types/quote/Quote.raml b/api-specs/api/types/quote/Quote.raml index 04b5abdc7..1a0ac1c3a 100644 --- a/api-specs/api/types/quote/Quote.raml +++ b/api-specs/api/types/quote/Quote.raml @@ -34,12 +34,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). quoteRequest: type: QuoteRequestReference description: | diff --git a/api-specs/api/types/quote/QuoteUpdate.raml b/api-specs/api/types/quote/QuoteUpdate.raml index fe6783834..47af1cf04 100644 --- a/api-specs/api/types/quote/QuoteUpdate.raml +++ b/api-specs/api/types/quote/QuoteUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the [Quote](ctp:api:type:Quote) to which the changes should be applied. - If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: QuoteUpdateAction diff --git a/api-specs/api/types/review/Review.raml b/api-specs/api/types/review/Review.raml index 24a2da8b0..e71d6649f 100644 --- a/api-specs/api/types/review/Review.raml +++ b/api-specs/api/types/review/Review.raml @@ -26,12 +26,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/api/types/review/ReviewResourceIdentifier.raml b/api-specs/api/types/review/ReviewResourceIdentifier.raml index 3c6f124ec..d20d98c8d 100644 --- a/api-specs/api/types/review/ReviewResourceIdentifier.raml +++ b/api-specs/api/types/review/ReviewResourceIdentifier.raml @@ -4,13 +4,13 @@ type: ResourceIdentifier displayName: ReviewResourceIdentifier discriminatorValue: review description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Review](ctp:api:type:Review). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Review](ctp:api:type:Review). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Review](ctp:api:type:Review). Either `id` or `key` is required. + Unique identifier of the referenced [Review](ctp:api:type:Review). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Review](ctp:api:type:Review). Either `id` or `key` is required. + User-defined unique identifier of the referenced [Review](ctp:api:type:Review). Required if `id` is absent. diff --git a/api-specs/api/types/shipping-method/ShippingMethod.raml b/api-specs/api/types/shipping-method/ShippingMethod.raml index c22a787b0..7de124a22 100644 --- a/api-specs/api/types/shipping-method/ShippingMethod.raml +++ b/api-specs/api/types/shipping-method/ShippingMethod.raml @@ -24,12 +24,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: User-defined unique identifier of the ShippingMethod. diff --git a/api-specs/api/types/shipping-method/ShippingMethodResourceIdentifier.raml b/api-specs/api/types/shipping-method/ShippingMethodResourceIdentifier.raml index 21e4efe0d..20d661974 100644 --- a/api-specs/api/types/shipping-method/ShippingMethodResourceIdentifier.raml +++ b/api-specs/api/types/shipping-method/ShippingMethodResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ShippingMethodResourceIdentifier discriminatorValue: shipping-method description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ShippingMethod](ctp:api:type:ShippingMethod). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ShippingMethod](ctp:api:type:ShippingMethod). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [ShippingMethod](ctp:api:type:ShippingMethod). Either `id` or `key` is required. + Unique identifier of the referenced [ShippingMethod](ctp:api:type:ShippingMethod). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [ShippingMethod](ctp:api:type:ShippingMethod). Either `id` or `key` is required. + User-defined unique identifier of the referenced [ShippingMethod](ctp:api:type:ShippingMethod). Required if `id` is absent. diff --git a/api-specs/api/types/shopping-list/ShoppingList.raml b/api-specs/api/types/shopping-list/ShoppingList.raml index d7364a09b..434ff6ff3 100644 --- a/api-specs/api/types/shopping-list/ShoppingList.raml +++ b/api-specs/api/types/shopping-list/ShoppingList.raml @@ -73,9 +73,9 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). diff --git a/api-specs/api/types/shopping-list/ShoppingListResourceIdentifier.raml b/api-specs/api/types/shopping-list/ShoppingListResourceIdentifier.raml index 1faf51511..67475e34c 100644 --- a/api-specs/api/types/shopping-list/ShoppingListResourceIdentifier.raml +++ b/api-specs/api/types/shopping-list/ShoppingListResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ShoppingListResourceIdentifier discriminatorValue: shopping-list description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ShoppingList](ctp:api:type:ShoppingList). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ShoppingList](ctp:api:type:ShoppingList). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [ShoppingList](ctp:api:type:ShoppingList). Either `id` or `key` is required. + Unique identifier of the referenced [ShoppingList](ctp:api:type:ShoppingList). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [ShoppingList](ctp:api:type:ShoppingList). Either `id` or `key` is required. + User-defined unique identifier of the referenced [ShoppingList](ctp:api:type:ShoppingList). Required if `id` is absent. diff --git a/api-specs/api/types/shopping-list/ShoppingListUpdate.raml b/api-specs/api/types/shopping-list/ShoppingListUpdate.raml index dc2b30771..6d0649b01 100644 --- a/api-specs/api/types/shopping-list/ShoppingListUpdate.raml +++ b/api-specs/api/types/shopping-list/ShoppingListUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the ShoppingList on which the changes should be applied. If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) will be returned. + Expected version of the ShoppingList on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: ShoppingListUpdateAction diff --git a/api-specs/api/types/staged-quote/StagedQuote.raml b/api-specs/api/types/staged-quote/StagedQuote.raml index b9c94c329..fe3d7aa02 100644 --- a/api-specs/api/types/staged-quote/StagedQuote.raml +++ b/api-specs/api/types/staged-quote/StagedQuote.raml @@ -30,12 +30,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). stagedQuoteState: type: StagedQuoteState customer?: diff --git a/api-specs/api/types/staged-quote/StagedQuoteUpdate.raml b/api-specs/api/types/staged-quote/StagedQuoteUpdate.raml index 15a0a0a84..4c9331577 100644 --- a/api-specs/api/types/staged-quote/StagedQuoteUpdate.raml +++ b/api-specs/api/types/staged-quote/StagedQuoteUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the [StagedQuote](ctp:api:type:StagedQuote) to which the changes should be applied. - If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: StagedQuoteUpdateAction diff --git a/api-specs/api/types/standalone-price/StandalonePrice.raml b/api-specs/api/types/standalone-price/StandalonePrice.raml index 82d29e990..f20328ec3 100644 --- a/api-specs/api/types/standalone-price/StandalonePrice.raml +++ b/api-specs/api/types/standalone-price/StandalonePrice.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: |- diff --git a/api-specs/api/types/standalone-price/StandalonePriceUpdate.raml b/api-specs/api/types/standalone-price/StandalonePriceUpdate.raml index 5c6ad7929..7d0f95917 100644 --- a/api-specs/api/types/standalone-price/StandalonePriceUpdate.raml +++ b/api-specs/api/types/standalone-price/StandalonePriceUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the StandalonePrice on which the changes should be applied. If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + Expected version of the StandalonePrice on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: StandalonePriceUpdateAction diff --git a/api-specs/api/types/state/State.raml b/api-specs/api/types/state/State.raml index c982626fc..cc0495070 100644 --- a/api-specs/api/types/state/State.raml +++ b/api-specs/api/types/state/State.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key: type: string description: | diff --git a/api-specs/api/types/state/StateResourceIdentifier.raml b/api-specs/api/types/state/StateResourceIdentifier.raml index dbe2fd41f..69a845fd6 100644 --- a/api-specs/api/types/state/StateResourceIdentifier.raml +++ b/api-specs/api/types/state/StateResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: StateResourceIdentifier discriminatorValue: state description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [State](ctp:api:type:State). Either `id` or `key` is required. + Unique identifier of the referenced [State](ctp:api:type:State). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [State](ctp:api:type:State). Either `id` or `key` is required. + User-defined unique identifier of the referenced [State](ctp:api:type:State). Required if `id` is absent. diff --git a/api-specs/api/types/state/StateUpdate.raml b/api-specs/api/types/state/StateUpdate.raml index bee3102d1..0ad9a5c49 100644 --- a/api-specs/api/types/state/StateUpdate.raml +++ b/api-specs/api/types/state/StateUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the State on which the changes should be applied. If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + Expected version of the State on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: StateUpdateAction diff --git a/api-specs/api/types/store/Store.raml b/api-specs/api/types/store/Store.raml index 5e879ae65..1fd50bc0b 100644 --- a/api-specs/api/types/store/Store.raml +++ b/api-specs/api/types/store/Store.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key: type: string description: | diff --git a/api-specs/api/types/store/StoreResourceIdentifier.raml b/api-specs/api/types/store/StoreResourceIdentifier.raml index 1ff3c3689..332d6b308 100644 --- a/api-specs/api/types/store/StoreResourceIdentifier.raml +++ b/api-specs/api/types/store/StoreResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: StoreResourceIdentifier discriminatorValue: store description: | - [ResourceIdentifier](/../api/types#resourceidentifier) to a [Store](ctp:api:type:Store). + [ResourceIdentifier](/../api/types#resourceidentifier) to a [Store](ctp:api:type:Store). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique ID of the referenced [Store](ctp:api:type:Store). Either `id` or `key` is required. + Unique ID of the referenced [Store](ctp:api:type:Store). Required if `key` is absent. key?: type: string description: | - Unique key of the referenced [Store](ctp:api:type:Store). Either `id` or `key` is required. + Unique key of the referenced [Store](ctp:api:type:Store). Required if `id` is absent. diff --git a/api-specs/api/types/store/StoreUpdate.raml b/api-specs/api/types/store/StoreUpdate.raml index 0fcf8d881..f116d65e8 100644 --- a/api-specs/api/types/store/StoreUpdate.raml +++ b/api-specs/api/types/store/StoreUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the Store on which the changes should be applied. If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + Expected version of the Store on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: StoreUpdateAction diff --git a/api-specs/api/types/subscription/ResourceDeletedDeliveryPayload.raml b/api-specs/api/types/subscription/ResourceDeletedDeliveryPayload.raml index ba1479c2d..c6e01e4bd 100644 --- a/api-specs/api/types/subscription/ResourceDeletedDeliveryPayload.raml +++ b/api-specs/api/types/subscription/ResourceDeletedDeliveryPayload.raml @@ -20,4 +20,4 @@ properties: dataErasure?: type: boolean description: | - `true` if the `dataErasure` [parameter](/../api/general-concepts#data-erasure-of-personal-data) on the `DELETE` request was set to `true`. + `true` if the `dataErasure` [parameter](/../api/gdpr#data-erasure-of-personal-data) on the `DELETE` request was set to `true`. diff --git a/api-specs/api/types/subscription/Subscription.raml b/api-specs/api/types/subscription/Subscription.raml index 37eac4aa6..d805f89f0 100644 --- a/api-specs/api/types/subscription/Subscription.raml +++ b/api-specs/api/types/subscription/Subscription.raml @@ -28,12 +28,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). changes: type: ChangeSubscription[] description: | diff --git a/api-specs/api/types/subscription/SubscriptionUpdate.raml b/api-specs/api/types/subscription/SubscriptionUpdate.raml index 47b223f7b..057849feb 100644 --- a/api-specs/api/types/subscription/SubscriptionUpdate.raml +++ b/api-specs/api/types/subscription/SubscriptionUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the Subscription on which the changes should be applied. If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) will be returned. + Expected version of the Subscription on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: SubscriptionUpdateAction diff --git a/api-specs/api/types/tax-category/TaxCategory.raml b/api-specs/api/types/tax-category/TaxCategory.raml index 630754282..fdd93312b 100644 --- a/api-specs/api/types/tax-category/TaxCategory.raml +++ b/api-specs/api/types/tax-category/TaxCategory.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). name: type: string description: | diff --git a/api-specs/api/types/tax-category/TaxCategoryResourceIdentifier.raml b/api-specs/api/types/tax-category/TaxCategoryResourceIdentifier.raml index 40ee1b911..5b79bdce4 100644 --- a/api-specs/api/types/tax-category/TaxCategoryResourceIdentifier.raml +++ b/api-specs/api/types/tax-category/TaxCategoryResourceIdentifier.raml @@ -5,16 +5,16 @@ type: ResourceIdentifier displayName: TaxCategoryResourceIdentifier discriminatorValue: tax-category description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [TaxCategory](ctp:api:type:TaxCategory). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [TaxCategory](ctp:api:type:TaxCategory). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [TaxCategory](ctp:api:type:TaxCategory). Either `id` or `key` is required. + Unique identifier of the referenced [TaxCategory](ctp:api:type:TaxCategory). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [TaxCategory](ctp:api:type:TaxCategory). Either `id` or `key` is required. + User-defined unique identifier of the referenced [TaxCategory](ctp:api:type:TaxCategory). Required if `id` is absent. pattern: ^[A-Za-z0-9_-]+$ minLength: 2 maxLength: 256 diff --git a/api-specs/api/types/tax-category/TaxCategoryUpdate.raml b/api-specs/api/types/tax-category/TaxCategoryUpdate.raml index 46a0a0555..08f7fa53b 100644 --- a/api-specs/api/types/tax-category/TaxCategoryUpdate.raml +++ b/api-specs/api/types/tax-category/TaxCategoryUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the TaxCategory on which the changes should be applied. If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + Expected version of the TaxCategory on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: TaxCategoryUpdateAction diff --git a/api-specs/api/types/tax-category/TaxRate.raml b/api-specs/api/types/tax-category/TaxRate.raml index c210e6d80..00dedc637 100644 --- a/api-specs/api/types/tax-category/TaxRate.raml +++ b/api-specs/api/types/tax-category/TaxRate.raml @@ -26,7 +26,7 @@ properties: minimum: 0 maximum: 1 description: | - Tax rate. If subrates are used, the amount must be the sum of all subrates. + Tax rate. If subrates are used, the amount is the sum of all rates in `subRates`. includedInPrice: type: boolean description: | @@ -42,4 +42,4 @@ properties: subRates?: type: SubRate[] description: | - Used to calculate the [taxPortions](/../api/projects/carts#taxedprice) field in a Cart or Order. It is useful if the total tax of a country (such as the US) is a combination of multiple taxes (such as state and local taxes). + Used to calculate the [taxPortions](/../api/projects/carts#taxedprice) field in a Cart or Order. It is useful if the total tax of a country (such as the US) is a combination of multiple taxes (such as state and local taxes). The total of all subrates equals the TaxRate `amount`. diff --git a/api-specs/api/types/tax-category/TaxRateDraft.raml b/api-specs/api/types/tax-category/TaxRateDraft.raml index 01052d775..f4ee512a4 100644 --- a/api-specs/api/types/tax-category/TaxRateDraft.raml +++ b/api-specs/api/types/tax-category/TaxRateDraft.raml @@ -29,7 +29,7 @@ properties: subRates?: type: SubRate[] description: | - Used to calculate the [taxPortions](/../api/projects/carts#taxedprice) field in a Cart or Order. It is useful if the total tax of a country (such as the US) is a combination of multiple taxes (such as state and local taxes). + Used to calculate the [taxPortions](/../api/projects/carts#taxedprice) field in a Cart or Order. It is useful if the total tax of a country (such as the US) is a combination of multiple taxes (such as state and local taxes). The total of all subrates must equal the TaxRate `amount`. key?: type: string description: | diff --git a/api-specs/api/types/type/Type.raml b/api-specs/api/types/type/Type.raml index 06e58e71a..b654e2406 100644 --- a/api-specs/api/types/type/Type.raml +++ b/api-specs/api/types/type/Type.raml @@ -25,12 +25,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key: type: string description: |- diff --git a/api-specs/api/types/type/TypeResourceIdentifier.raml b/api-specs/api/types/type/TypeResourceIdentifier.raml index d97e0e568..1dbeedcdf 100644 --- a/api-specs/api/types/type/TypeResourceIdentifier.raml +++ b/api-specs/api/types/type/TypeResourceIdentifier.raml @@ -5,16 +5,16 @@ type: ResourceIdentifier displayName: TypeResourceIdentifier discriminatorValue: type description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Type](ctp:api:type:Type). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Type](ctp:api:type:Type). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Type](ctp:api:type:Type). Either `id` or `key` is required. + Unique identifier of the referenced [Type](ctp:api:type:Type). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Type](ctp:api:type:Type). Either `id` or `key` is required. + User-defined unique identifier of the referenced [Type](ctp:api:type:Type). Required if `id` is absent. pattern: ^[A-Za-z0-9_-]+$ minLength: 2 maxLength: 256 diff --git a/api-specs/api/types/type/TypeUpdate.raml b/api-specs/api/types/type/TypeUpdate.raml index 66468a10c..16cb76fe9 100644 --- a/api-specs/api/types/type/TypeUpdate.raml +++ b/api-specs/api/types/type/TypeUpdate.raml @@ -8,7 +8,7 @@ properties: format: int64 description: | Expected version of the type on which the changes should be applied. - If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: TypeUpdateAction diff --git a/api-specs/api/types/types.raml b/api-specs/api/types/types.raml index df68aadcf..ed50bcb85 100644 --- a/api-specs/api/types/types.raml +++ b/api-specs/api/types/types.raml @@ -529,7 +529,6 @@ MissingRoleOnChannelError: !include error/MissingRoleOnChannelError.raml MissingTaxRateForCountryError: !include error/MissingTaxRateForCountryError.raml MoneyOverflowError: !include error/MoneyOverflowError.raml NoMatchingProductDiscountFoundError: !include error/NoMatchingProductDiscountFoundError.raml -NotEnabledError: !include error/NotEnabledError.raml ObjectNotFoundError: !include error/ObjectNotFoundError.raml OutOfStockError: !include error/OutOfStockError.raml OverCapacityError: !include error/OverCapacityError.raml @@ -609,7 +608,6 @@ GraphQLMissingRoleOnChannelError: !include error/graphql/GraphQLMissingRoleOnCha GraphQLMissingTaxRateForCountryError: !include error/graphql/GraphQLMissingTaxRateForCountryError.raml GraphQLMoneyOverflowError: !include error/graphql/GraphQLMoneyOverflowError.raml GraphQLNoMatchingProductDiscountFoundError: !include error/graphql/GraphQLNoMatchingProductDiscountFoundError.raml -GraphQLNotEnabledError: !include error/graphql/GraphQLNotEnabledError.raml GraphQLObjectNotFoundError: !include error/graphql/GraphQLObjectNotFoundError.raml GraphQLOutOfStockError: !include error/graphql/GraphQLOutOfStockError.raml GraphQLOverCapacityError: !include error/graphql/GraphQLOverCapacityError.raml diff --git a/api-specs/api/types/zone/Zone.raml b/api-specs/api/types/zone/Zone.raml index 541e689f5..5be862452 100644 --- a/api-specs/api/types/zone/Zone.raml +++ b/api-specs/api/types/zone/Zone.raml @@ -26,12 +26,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/api/types/zone/ZoneResourceIdentifier.raml b/api-specs/api/types/zone/ZoneResourceIdentifier.raml index 12de49ede..34019aaeb 100644 --- a/api-specs/api/types/zone/ZoneResourceIdentifier.raml +++ b/api-specs/api/types/zone/ZoneResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ZoneResourceIdentifier discriminatorValue: zone description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Zone](ctp:api:type:Zone). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Zone](ctp:api:type:Zone). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Zone](ctp:api:type:Zone). Either `id` or `key` is required. + Unique identifier of the referenced [Zone](ctp:api:type:Zone). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Zone](ctp:api:type:Zone). Either `id` or `key` is required. + User-defined unique identifier of the referenced [Zone](ctp:api:type:Zone). Required if `id` is absent. diff --git a/api-specs/api/types/zone/ZoneUpdate.raml b/api-specs/api/types/zone/ZoneUpdate.raml index 64eeb534b..f20dfbbac 100644 --- a/api-specs/api/types/zone/ZoneUpdate.raml +++ b/api-specs/api/types/zone/ZoneUpdate.raml @@ -7,7 +7,8 @@ properties: type: number format: int64 description: | - Expected version of the Zone on which the changes should be applied. If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned. + Expected version of the Zone on which the changes should be applied. + If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned. actions: type: array items: ZoneUpdateAction diff --git a/api-specs/checkout/examples/message/ErrorInitBadConfigMessage.json b/api-specs/checkout/examples/message/ErrorInitBadConfigMessage.json index c805047a5..ae1c7b3e9 100644 --- a/api-specs/checkout/examples/message/ErrorInitBadConfigMessage.json +++ b/api-specs/checkout/examples/message/ErrorInitBadConfigMessage.json @@ -1,10 +1,10 @@ { "type": "error:init:bad_config", - "code": "seller_not_found", - "message": "Seller {sellerId} not found", + "code": "project_deactivated", + "message": "commercetools Checkout {projectKey} is deactivated.", "payload": { - "seller": { - "id": "{sellerId}" + "project": { + "key": "{projectKey}" } } } diff --git a/api-specs/checkout/examples/message/InfoOrderCreatedMessage.json b/api-specs/checkout/examples/message/InfoOrderCreatedMessage.json index 2106ce916..929e662db 100644 --- a/api-specs/checkout/examples/message/InfoOrderCreatedMessage.json +++ b/api-specs/checkout/examples/message/InfoOrderCreatedMessage.json @@ -1,7 +1,7 @@ { "type": "info:order:status", "code": "order_created", - "message": "Order {orderId} created", + "message": "Order {orderId} created.", "payload": { "order": { "id": "{orderId}" diff --git a/api-specs/checkout/types/responses/AdyenBadConfig.raml b/api-specs/checkout/types/responses/AdyenBadConfig.raml index 13f075a44..9c606f5d1 100644 --- a/api-specs/checkout/types/responses/AdyenBadConfig.raml +++ b/api-specs/checkout/types/responses/AdyenBadConfig.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: AdyenBadConfig discriminatorValue: adyen_bad_config description: | - Generated when the configuration used to initialize Adyen contains at least one invalid field. + Generated when the configuration to initialize the [Adyen payment connector](/configuring-adyen) contains at least one invalid field. properties: code: type: string @@ -14,7 +14,7 @@ properties: description: \`error:psp:bad_config` message: type: string - description: Some fields are invalid + description: Some fields are invalid. payload?: type: object - description: An object containing `PSP` and an array of objects with the invalid fields. + description: An object containing `psp` and an array of objects with the invalid fields. diff --git a/api-specs/checkout/types/responses/AdyenInitError.raml b/api-specs/checkout/types/responses/AdyenInitError.raml index ed58f022b..6e2e7b2be 100644 --- a/api-specs/checkout/types/responses/AdyenInitError.raml +++ b/api-specs/checkout/types/responses/AdyenInitError.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: AdyenInitError discriminatorValue: adyen_init_error description: | - Generated when Adyen cannot be initialized. + Generated when the [Adyen payment connector](/configuring-adyen) cannot be initialized. properties: code: type: string @@ -14,7 +14,7 @@ properties: description: \`error:psp:bad_config` message: type: string - description: Could not initialise Adyen + description: Could not initialise Adyen. payload?: type: object - description: An object containing `PSP`, `clientKey`, and `enviroment`. + description: An object containing `psp`, `clientKey`, and `enviroment`. diff --git a/api-specs/checkout/types/responses/AdyenTimeout.raml b/api-specs/checkout/types/responses/AdyenTimeout.raml index b91c5f163..01e94a0cd 100644 --- a/api-specs/checkout/types/responses/AdyenTimeout.raml +++ b/api-specs/checkout/types/responses/AdyenTimeout.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: AdyenTimeout discriminatorValue: adyen_timeout description: | - Generated when a timeout error occurs while initializing Adyen. + Generated when a timeout error occurs while initializing the [Adyen payment connector](/configuring-adyen). properties: code: type: string @@ -14,7 +14,7 @@ properties: description: \`error:psp:bad_config` message: type: string - description: Timeout while initialising Adyen + description: Timeout while initialising Adyen. payload?: type: object - description: An object containing `PSP`, `clientKey`, and `enviroment`. + description: An object containing `psp`, `clientKey`, and `enviroment`. diff --git a/api-specs/checkout/types/responses/ApplicationDeactivated.raml b/api-specs/checkout/types/responses/ApplicationDeactivated.raml index ad7500365..7b9bff92e 100644 --- a/api-specs/checkout/types/responses/ApplicationDeactivated.raml +++ b/api-specs/checkout/types/responses/ApplicationDeactivated.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: ApplicationDeactivated discriminatorValue: application_disabled description: | - Generated when the requested application is deactivated. Activate the application in the Merchant Center to continue. + Generated when the requested [application](/configuring-checkout#applications) is deactivated. Activate the application in the Merchant Center to continue. properties: code: type: string @@ -14,7 +14,7 @@ properties: description: \`error:init:bad_config` message: type: string - description: Application `{appId}` for seller `{sellerId}` is disabled + description: Application `{applicationKey}` for commercetools Checkout `{projectKey}` is disabled. payload?: type: object - description: An object containing `sellerId` and `appId`. + description: An object containing `projectKey` and `applicationKey`. diff --git a/api-specs/checkout/types/responses/ApplicationNotFound.raml b/api-specs/checkout/types/responses/ApplicationNotFound.raml index 43495d5ad..331d17735 100644 --- a/api-specs/checkout/types/responses/ApplicationNotFound.raml +++ b/api-specs/checkout/types/responses/ApplicationNotFound.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: ApplicationNotFound discriminatorValue: application_not_found description: | - Generated when the requested application is not found. The application may have been deleted or its configuration is incorrect. + Generated when the requested [application](/configuring-checkout#applications) is not found. The application may have been deleted or its configuration is incorrect. properties: code: type: string @@ -14,7 +14,7 @@ properties: description: \`error:init:bad_config` message: type: string - description: Application `{appId}` for seller `{sellerId}` not found + description: Application `{applicationKey}` for commercetools Checkout `{projectKey}` not found. payload?: type: object - description: An object containing `sellerId` and `appId`. + description: An object containing `projectKey` and `applicationKey`. diff --git a/api-specs/checkout/types/responses/BadInputData.raml b/api-specs/checkout/types/responses/BadInputData.raml index ded0ce959..cd50d2137 100644 --- a/api-specs/checkout/types/responses/BadInputData.raml +++ b/api-specs/checkout/types/responses/BadInputData.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: BadInputData discriminatorValue: invalid_fields description: | - Generated when the `checkoutConfig` object contains one or more invalid fields. + Generated when the `checkoutConfig` [object](/sdk) contains one or more invalid fields. properties: code: type: string @@ -14,7 +14,7 @@ properties: description: \`error:init:bad_config` message: type: string - description: Some fields are invalid + description: Some fields are invalid. payload?: type: object description: An object containing an array of `field`, `message`, and `invalidValue`. diff --git a/api-specs/checkout/types/responses/CartEmptiedDuringCheckout.raml b/api-specs/checkout/types/responses/CartEmptiedDuringCheckout.raml index 39e4c5eb8..10cc10455 100644 --- a/api-specs/checkout/types/responses/CartEmptiedDuringCheckout.raml +++ b/api-specs/checkout/types/responses/CartEmptiedDuringCheckout.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: CartEmptiedDuringCheckout discriminatorValue: cart_emptied_during_checkout description: | - Generated when the Cart was emptied during the checkout. It is not possible to recover from this, the customer must restart the checkout process. + Generated when the [Cart](/../api/projects/carts) was emptied during the checkout process. It is not possible to recover from this, the customer must restart the checkout process. properties: code: type: string @@ -14,7 +14,7 @@ properties: description: \`error:cart:empty` message: type: string - description: Cart `{cartId}` was emptied during checkout + description: Cart `{cartId}` was emptied during checkout. payload?: type: object description: An object containing `cartId`. diff --git a/api-specs/checkout/types/responses/CartEmpty.raml b/api-specs/checkout/types/responses/CartEmpty.raml index c7d5c6d6c..69a34316f 100644 --- a/api-specs/checkout/types/responses/CartEmpty.raml +++ b/api-specs/checkout/types/responses/CartEmpty.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: CartEmpty discriminatorValue: cart_empty description: | - Generated when the Cart for the current checkout is empty. The Cart must contain at least one Line Item. + Generated when the [Cart](/../api/projects/carts) for the current checkout is empty. The Cart must contain at least one [Line Item](/../api/carts-orders-overview#line-items). properties: code: type: string @@ -14,7 +14,7 @@ properties: description: \`error:cart:empty` message: type: string - description: Cart `{cartId}` is empty + description: Cart `{cartId}` is empty. payload?: type: object description: An object containing `cartId`. diff --git a/api-specs/checkout/types/responses/CartNotFound.raml b/api-specs/checkout/types/responses/CartNotFound.raml index 81bf95f9c..280487198 100644 --- a/api-specs/checkout/types/responses/CartNotFound.raml +++ b/api-specs/checkout/types/responses/CartNotFound.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: CartNotFound discriminatorValue: cart_not_found description: | - Generated when the Cart is not found. A valid Cart with at least one Line Item is required to start the checkout. + Generated when the [Cart](/../api/projects/carts) is not found. To start the checkout process, a valid Cart with at least one [Line Item](/../api/carts-orders-overview#line-items) is required. properties: code: type: string @@ -14,7 +14,7 @@ properties: description: \`error:cart:not_found` message: type: string - description: Cart `{cartId}` for seller `{sellerId}` and application `{appId}` not found + description: Cart `{cartId}` for commercetools Checkout `{projectKey}` and application `{applicationKey}` not found. payload?: type: object - description: An object containing `sellerId`, `appId`, and `cartId`. + description: An object containing `projectKey`, `applicationKey`, and `cartId`. diff --git a/api-specs/checkout/types/responses/CartWithExistingPayment.raml b/api-specs/checkout/types/responses/CartWithExistingPayment.raml new file mode 100644 index 000000000..8365261d4 --- /dev/null +++ b/api-specs/checkout/types/responses/CartWithExistingPayment.raml @@ -0,0 +1,20 @@ +#%RAML 1.0 DataType +(annotations.package): responses +type: ResponseMessage +displayName: CartWithExistingPayment +discriminatorValue: cart_with_exisiting_payment +description: | + Generated when trying to add a [Payment](/../api/projects/payments) to a [Cart](/../api/projects/carts) that already references an approved Payment. +properties: + code: + type: string + description: + type: + type: string + description: \`error:payment:failed` + message: + type: string + description: Cart with existing approved payment. + payload?: + type: object + description: An object containing `cartId`. diff --git a/api-specs/checkout/types/responses/CheckoutCancelled.raml b/api-specs/checkout/types/responses/CheckoutCancelled.raml index 6f9befd56..c24813c4e 100644 --- a/api-specs/checkout/types/responses/CheckoutCancelled.raml +++ b/api-specs/checkout/types/responses/CheckoutCancelled.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: CheckoutCancelled discriminatorValue: checkout_cancelled description: | - Generated when the customer cancels the checkout. + Generated when the customer cancels the checkout process. properties: code: type: string @@ -14,4 +14,4 @@ properties: description: \`info:app:status` message: type: string - description: Checkout cancelled + description: Checkout cancelled. diff --git a/api-specs/checkout/types/responses/CheckoutCompleted.raml b/api-specs/checkout/types/responses/CheckoutCompleted.raml index d78cb4a9a..a4eb74406 100644 --- a/api-specs/checkout/types/responses/CheckoutCompleted.raml +++ b/api-specs/checkout/types/responses/CheckoutCompleted.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: CheckoutCompleted discriminatorValue: checkout_completed description: | - Generated when the customer completes the checkout. + Generated when the customer completes the checkout process. properties: code: type: string @@ -14,7 +14,7 @@ properties: description: \`info:app:status` message: type: string - description: Checkout for `{orderId}` completed + description: Checkout for `{orderId}` completed. payload?: type: object description: An object containing `orderId`. diff --git a/api-specs/checkout/types/responses/CheckoutLoaded.raml b/api-specs/checkout/types/responses/CheckoutLoaded.raml index ea8174b17..638c4c4e7 100644 --- a/api-specs/checkout/types/responses/CheckoutLoaded.raml +++ b/api-specs/checkout/types/responses/CheckoutLoaded.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: CheckoutLoaded discriminatorValue: checkout_loaded description: | - Generated when the checkout was loaded successfully and it is waiting for the configuration parameters passed through the `checkoutConfig` object. + Generated when Checkout has been loaded successfully and is waiting for the configuration parameters passed in the `checkoutConfig` [object](/sdk). properties: code: type: string @@ -14,4 +14,4 @@ properties: description: \`info:app:status` message: type: string - description: Checkout loaded + description: Checkout loaded. diff --git a/api-specs/checkout/types/responses/CheckoutStarted.raml b/api-specs/checkout/types/responses/CheckoutStarted.raml index 8427da215..edb201f31 100644 --- a/api-specs/checkout/types/responses/CheckoutStarted.raml +++ b/api-specs/checkout/types/responses/CheckoutStarted.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: CheckoutStarted discriminatorValue: checkout_started description: | - Generated when the checkout receives the configuration parameters passed through the `checkoutConfig` object and starts successfully. + Generated when the configuration parameters are passed successfully through the `checkoutConfig` [object](/sdk) and the checkout process starts. properties: code: type: string @@ -14,4 +14,4 @@ properties: description: \`info:app:status` message: type: string - description: Checkout started + description: Checkout started. diff --git a/api-specs/checkout/types/responses/DeprecatedFields.raml b/api-specs/checkout/types/responses/DeprecatedFields.raml new file mode 100644 index 000000000..a55c79383 --- /dev/null +++ b/api-specs/checkout/types/responses/DeprecatedFields.raml @@ -0,0 +1,20 @@ +#%RAML 1.0 DataType +(annotations.package): responses +type: ResponseMessage +displayName: DeprecatedFields +discriminatorValue: deprecated_fields +description: | + Generated when the `checkoutConfig` [object](/sdk) contains one or more deprecated fields. +properties: + code: + type: string + description: + type: + type: string + description: \`warn:init:bad_config` + message: + type: string + description: Some fields are deprecated. + payload?: + type: object + description: An object containing an array of `field` and `message`. diff --git a/api-specs/checkout/types/responses/InitTimeout.raml b/api-specs/checkout/types/responses/InitTimeout.raml index e3f84d06a..58bb85179 100644 --- a/api-specs/checkout/types/responses/InitTimeout.raml +++ b/api-specs/checkout/types/responses/InitTimeout.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: InitTimeout discriminatorValue: init_timeout description: | - Generated when the checkout has not received the configuration parameters passed through the `checkoutConfig` object on time. + Generated when Checkout has not received the configuration parameters passed through the `checkoutConfig` [object](/sdk) on time. properties: code: type: string @@ -14,4 +14,4 @@ properties: description: \`error:init:timeout` message: type: string - description: Timeout error, no init message received + description: Timeout error, no init message received. diff --git a/api-specs/checkout/types/responses/InvalidToken.raml b/api-specs/checkout/types/responses/InvalidToken.raml index e2abb47d4..78610388a 100644 --- a/api-specs/checkout/types/responses/InvalidToken.raml +++ b/api-specs/checkout/types/responses/InvalidToken.raml @@ -14,4 +14,4 @@ properties: description: \`error:token:invalid` message: type: string - description: The token is invalid + description: The token is invalid. diff --git a/api-specs/checkout/types/responses/NoAllowedOrigins.raml b/api-specs/checkout/types/responses/NoAllowedOrigins.raml deleted file mode 100644 index 1b3e028fb..000000000 --- a/api-specs/checkout/types/responses/NoAllowedOrigins.raml +++ /dev/null @@ -1,18 +0,0 @@ -#%RAML 1.0 DataType -(annotations.package): responses -type: ResponseMessage -displayName: NoAllowedOrigins -discriminatorValue: no_allowed_origins -description: | - Generated when there are no allowed origins configured for the current application. Add at least one **Origin URL** in your [application settings in the Merchant Center](/configuring-checkout#applications). - -properties: - code: - type: string - description: - type: - type: string - description: \`error:init:bad_config` - message: - type: string - description: There are no allowed origins configured diff --git a/api-specs/checkout/types/responses/NoPaymentMethods.raml b/api-specs/checkout/types/responses/NoPaymentMethods.raml index 7b2989cfe..a691aa10f 100644 --- a/api-specs/checkout/types/responses/NoPaymentMethods.raml +++ b/api-specs/checkout/types/responses/NoPaymentMethods.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: NoPaymentMethods discriminatorValue: no_payment_methods description: | - Generated when there are no payment methods available. Add at least one **Payment method** in your [application settings in the Merchant Center](/configuring-checkout#payment-connector). + Generated when no payment method is set up for an [application](/configuring-checkout#applications). Add at least one **Payment method** to the application in the Merchant Center. properties: code: type: string @@ -14,4 +14,4 @@ properties: description: \`error:init:bad_config` message: type: string - description: There are no payment methods configured + description: There are no payment methods configured. diff --git a/api-specs/checkout/types/responses/NoShippingMethods.raml b/api-specs/checkout/types/responses/NoShippingMethods.raml index 41247eda6..abe82bbc9 100644 --- a/api-specs/checkout/types/responses/NoShippingMethods.raml +++ b/api-specs/checkout/types/responses/NoShippingMethods.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: NoShippingMethods discriminatorValue: no_shipping_methods description: | - Generated when no Shipping Method is available for the shipping address of the Cart. This may indicate an incomplete configuration. + Generated when no [Shipping Method](/../api/projects/shippingMethods) is available for the shipping address of the [Cart](/../api/projects/carts). This may indicate an incomplete configuration. properties: code: type: string @@ -14,7 +14,7 @@ properties: description: \`warn:init:bad_config` message: type: string - description: There are no shipping methods matching cart + description: There are no shipping methods matching cart. payload?: type: object description: An object containing `cartId`. diff --git a/api-specs/checkout/types/responses/OrderCreated.raml b/api-specs/checkout/types/responses/OrderCreated.raml index 2eee5b2a2..880421bba 100644 --- a/api-specs/checkout/types/responses/OrderCreated.raml +++ b/api-specs/checkout/types/responses/OrderCreated.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: OrderCreated discriminatorValue: order_created description: | - Generated when the checkout successfully creates an Order. + Generated when an [Order](/../api/projects/orders) is created after a successful checkout process. properties: code: type: string @@ -14,7 +14,7 @@ properties: description: \`info:order:status` message: type: string - description: Order `{orderId}` created + description: Order `{orderId}` created. payload?: type: object description: An object containing `orderId`. diff --git a/api-specs/checkout/types/responses/OrderCreationError.raml b/api-specs/checkout/types/responses/OrderCreationError.raml new file mode 100644 index 000000000..268830b0a --- /dev/null +++ b/api-specs/checkout/types/responses/OrderCreationError.raml @@ -0,0 +1,20 @@ +#%RAML 1.0 DataType +(annotations.package): responses +type: ResponseMessage +displayName: OrderCreationError +discriminatorValue: order_creation_error +description: | + Generated when an [Order](/../api/projects/orders) that references an approved [Payment](/../api/projects/payments) cannot be created. +properties: + code: + type: string + description: + type: + type: string + description: \`error:order:failed` + message: + type: string + description: Order creation failed with approved payment. + payload?: + type: object + description: An object containing `cartId` and `errors`. diff --git a/api-specs/checkout/types/responses/ProjectIsDeactivated.raml b/api-specs/checkout/types/responses/ProjectIsDeactivated.raml new file mode 100644 index 000000000..013c9a488 --- /dev/null +++ b/api-specs/checkout/types/responses/ProjectIsDeactivated.raml @@ -0,0 +1,20 @@ +#%RAML 1.0 DataType +(annotations.package): responses +type: ResponseMessage +displayName: ProjectIsDeactivated +discriminatorValue: project_deactivated +description: | + Generated when the commercetools Checkout [`projectKey`](/sdk) is deactivated and cannot be initialized. Contact support via the [Support Portal](https://commercetools.atlassian.net/servicedesk/customer/portal/30). +properties: + code: + type: string + description: + type: + type: string + description: \`error:init:bad_config` + message: + type: string + description: commercetools Checkout `{projectKey}` is deactivated. + payload?: + type: object + description: An object containing `projectKey`. diff --git a/api-specs/checkout/types/responses/SellerIsDeactivated.raml b/api-specs/checkout/types/responses/SellerIsDeactivated.raml deleted file mode 100644 index 1b3dd554f..000000000 --- a/api-specs/checkout/types/responses/SellerIsDeactivated.raml +++ /dev/null @@ -1,20 +0,0 @@ -#%RAML 1.0 DataType -(annotations.package): responses -type: ResponseMessage -displayName: SellerIsDeactivated -discriminatorValue: seller_deactivated -description: | - Generated when the seller is deactivated and the checkout cannot be initialized. Contact commercetools support. -properties: - code: - type: string - description: - type: - type: string - description: \`error:init:bad_config` - message: - type: string - description: Seller `{sellerId}` is deactivated - payload?: - type: object - description: An object containing `sellerId`. diff --git a/api-specs/checkout/types/responses/SellerNotFound.raml b/api-specs/checkout/types/responses/SellerNotFound.raml deleted file mode 100644 index fe1b8f26a..000000000 --- a/api-specs/checkout/types/responses/SellerNotFound.raml +++ /dev/null @@ -1,20 +0,0 @@ -#%RAML 1.0 DataType -(annotations.package): responses -type: ResponseMessage -displayName: SellerNotFound -discriminatorValue: seller_not_found -description: | - Generated when the seller is not found. The seller may have been deleted or the configuration may not be correct. Contact commercetools support. -properties: - code: - type: string - description: - type: - type: string - description: \`error:init:bad_config` - message: - type: string - description: Seller `{sellerId}` not found - payload?: - type: object - description: An object containing `sellerId`. diff --git a/api-specs/checkout/types/responses/ShippingAddressMissing.raml b/api-specs/checkout/types/responses/ShippingAddressMissing.raml index 53bdcbbda..45efda7fc 100644 --- a/api-specs/checkout/types/responses/ShippingAddressMissing.raml +++ b/api-specs/checkout/types/responses/ShippingAddressMissing.raml @@ -14,7 +14,7 @@ properties: description: \`error:cart:field_required` message: type: string - description: The shippingAddress field is missing for cart `{cartId}` + description: The shippingAddress field is missing for cart `{cartId}`. payload?: type: object description: An object containing `cartId`. diff --git a/api-specs/checkout/types/responses/UnallowedOrigin.raml b/api-specs/checkout/types/responses/UnallowedOrigin.raml index f3393ebe0..b2bed8ba3 100644 --- a/api-specs/checkout/types/responses/UnallowedOrigin.raml +++ b/api-specs/checkout/types/responses/UnallowedOrigin.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: UnallowedOrigin discriminatorValue: unallowed_origin description: | - Generated when the currently used origin URL is not in the list of the [**Origin URLs** configured in the Merchant Center](/configuring-checkout#create-an-application) and the checkout cannot be initialized. Add the **Origin URL** in your application settings in the Merchant Center. + Generated when Checkout cannot be initialized because the URL that is trying to initialize it is not in the list of the allowed URLs for the [application](/configuring-checkout#applications). Add the URL to the **Origin URLs** list in your application settings in the Merchant Center. properties: code: type: string @@ -14,7 +14,7 @@ properties: description: \`error:init:bad_config` message: type: string - description: Unallowed origin `{origin}`, allowed origins `{allowedOrigins}` + description: Unallowed origin `{origin}`, allowed origins `{allowedOrigins}`. payload?: type: object description: An object containing `origin` and `allowedOrigins`. diff --git a/api-specs/checkout/types/responses/UnavailableLocale.raml b/api-specs/checkout/types/responses/UnavailableLocale.raml index 1177bb571..383ca7186 100644 --- a/api-specs/checkout/types/responses/UnavailableLocale.raml +++ b/api-specs/checkout/types/responses/UnavailableLocale.raml @@ -4,7 +4,7 @@ type: ResponseMessage displayName: UnavailableLocale discriminatorValue: unavailable_locale description: | - Generated when the provided locale is not [available for localization](/installing-checkout#locales). The checkout falls back to English. + Generated when the provided `locale` is not [available for localization](/installing-checkout#locales). The localization falls back to English. properties: code: type: string @@ -14,7 +14,7 @@ properties: description: \`error:init:bad_config` message: type: string - description: The provided locale `{locale}` is not available for translated definitions + description: The provided locale `{locale}` is not available for translated definitions. payload?: type: object description: An object containing `locale`. diff --git a/api-specs/checkout/types/types.raml b/api-specs/checkout/types/types.raml index 0da0d051b..57b3404d0 100644 --- a/api-specs/checkout/types/types.raml +++ b/api-specs/checkout/types/types.raml @@ -14,12 +14,13 @@ CheckoutStarted: !include responses/CheckoutStarted.raml InitTimeout: !include responses/InitTimeout.raml BadInputData: !include responses/BadInputData.raml InvalidToken: !include responses/InvalidToken.raml -NoAllowedOrigins: !include responses/NoAllowedOrigins.raml NoPaymentMethods: !include responses/NoPaymentMethods.raml NoShippingMethods: !include responses/NoShippingMethods.raml OrderCreated: !include responses/OrderCreated.raml -SellerIsDeactivated: !include responses/SellerIsDeactivated.raml -SellerNotFound: !include responses/SellerNotFound.raml +ProjectIsDeactivated: !include responses/ProjectIsDeactivated.raml ShippingAddressMissing: !include responses/ShippingAddressMissing.raml UnallowedOrigin: !include responses/UnallowedOrigin.raml UnavailableLocale: !include responses/UnavailableLocale.raml +DeprecatedFields: !include responses/DeprecatedFields.raml +OrderCreationError: !include responses/OrderCreationError.raml +CartWithExistingPayment: !include responses/CartWithExistingPayment.raml diff --git a/api-specs/connect/types/common.raml b/api-specs/connect/types/common.raml index b1e9311e0..49e02efc5 100644 --- a/api-specs/connect/types/common.raml +++ b/api-specs/connect/types/common.raml @@ -199,7 +199,7 @@ types: staged?: type: boolean default: false - description: If `true`, the previewable [ConnectorStaged](ctp:connect:type:ConnectorStaged) will be referenced instead of the certified Connector. The `isPreviewable` field of the [ConnectorStaged](ctp:connect:type:ConnectorStaged) must be `true` to reference a previewable ConnectorStaged. + description: If `true`, the previewable [ConnectorStaged](ctp:connect:type:ConnectorStaged) will be referenced instead of the published Connector. The `isPreviewable` field of the [ConnectorStaged](ctp:connect:type:ConnectorStaged) must be `true` to reference a previewable ConnectorStaged. version: type: number format: int64 diff --git a/api-specs/connect/types/error/GeneralError.raml b/api-specs/connect/types/error/GeneralError.raml index 3d03c7d8b..77f859085 100644 --- a/api-specs/connect/types/error/GeneralError.raml +++ b/api-specs/connect/types/error/GeneralError.raml @@ -6,7 +6,7 @@ discriminatorValue: General description: | Returned when a server-side problem occurs. - If you encounter this error, report it using the [Support Portal](TBC for connect). + If you encounter this error, report it using the [Support Portal](https://commercetools.atlassian.net/servicedesk/customer/portal/27). properties: code: type: string diff --git a/api-specs/frontend-api/api.raml b/api-specs/frontend-api/api.raml index f269d6c5f..96fbdbe18 100644 --- a/api-specs/frontend-api/api.raml +++ b/api-specs/frontend-api/api.raml @@ -50,7 +50,9 @@ types: Tastic: !include types/Tastic.raml TasticConfiguration: !include types/TasticConfiguration.raml ViewData: !include types/ViewData.raml - + BuildUpload: !include types/BuildUpload.raml + BuildMetadata: !include types/BuildMetadata.raml + BuildUploadResult: !include types/BuildUploadResult.raml traits: right-header: headers: @@ -82,3 +84,7 @@ traits: /preview: !include resources/FrontasticPreview.raml /action: !include resources/FrontasticAction.raml /data-source: !include resources/FrontasticDataSource.raml + +/api: + /build: + /upload: !include resources/BuildUpload.raml diff --git a/api-specs/frontend-api/examples/build-upload-metadata-payload.json b/api-specs/frontend-api/examples/build-upload-metadata-payload.json new file mode 100644 index 000000000..ac9dffe27 --- /dev/null +++ b/api-specs/frontend-api/examples/build-upload-metadata-payload.json @@ -0,0 +1,11 @@ +{ + "branch": "main", + "revision": "a594ac3df6506a04e041de2b2d7ca5bf813fd602", + "versionNumber": "2023.07.18.13.28", + "nodeJsVersion": 18, + "buildSuccessful": true, + "buildTime": "2023-11-21T08:14:31.830Z", + "buildDuration": 300, + "buildLog": "Build started...\nDependencies installed...\nBuild completed successfully!", + "deploy": true +} diff --git a/api-specs/frontend-api/examples/build-upload-success.json b/api-specs/frontend-api/examples/build-upload-success.json new file mode 100644 index 000000000..d5a75207a --- /dev/null +++ b/api-specs/frontend-api/examples/build-upload-success.json @@ -0,0 +1,4 @@ +{ + "message": "Upload successful.", + "status": "success" +} diff --git a/api-specs/frontend-api/resources/BuildUpload.raml b/api-specs/frontend-api/resources/BuildUpload.raml new file mode 100644 index 000000000..9ec8f328a --- /dev/null +++ b/api-specs/frontend-api/resources/BuildUpload.raml @@ -0,0 +1,13 @@ +#%RAML 1.0 ResourceType + +post: + description: Uploads your backend builds from your custom CI environment to the Studio. + body: + multipart/form-data: + type: BuildUpload + responses: + 200: + body: + application/json: + type: object + example: !include ../examples/build-upload-success.json diff --git a/api-specs/frontend-api/ruleset.xml b/api-specs/frontend-api/ruleset.xml index bdfdffc9e..f48301a6b 100644 --- a/api-specs/frontend-api/ruleset.xml +++ b/api-specs/frontend-api/ruleset.xml @@ -4,34 +4,46 @@ default - - com.commercetools.rmf.validators.ResourcePluralRule - - - - - - - - - - - com.commercetools.rmf.validators.UnionTypePropertyRule - - - - - - com.commercetools.rmf.validators.DatetimeRule - - - com.commercetools.rmf.validators.SdkBaseUriRule - - - com.commercetools.rmf.validators.NamedStringEnumRule - - - - + + com.commercetools.rmf.validators.ResourcePluralRule + + + + + + + + + + + + + + com.commercetools.rmf.validators.SdkBaseUriRule + + + com.commercetools.rmf.validators.UnionTypePropertyRule + + + + + + com.commercetools.rmf.validators.CamelCaseRule + + + + + + com.commercetools.rmf.validators.NamedStringEnumRule + + + + + + com.commercetools.rmf.validators.StringPropertySingularRule + + + + diff --git a/api-specs/frontend-api/types/BuildMetadata.raml b/api-specs/frontend-api/types/BuildMetadata.raml new file mode 100644 index 000000000..2bec00a74 --- /dev/null +++ b/api-specs/frontend-api/types/BuildMetadata.raml @@ -0,0 +1,38 @@ +#%RAML 1.0 DataType +(package): Common +displayName: BuildMetadata +type: object +properties: + branch: + type: string + description: Name of the Git branch to deploy. + revision: + type: string + description: Full commit ID hash of the current HEAD. + versionNumber: + type: string + description: Current time represented in the format `YYYY.MM.DD.HH.mm`. This value should be unique and sortable. + nodeJsVersion: + type: integer + description: Node.js version for the [Extension runner](/../frontend-getting-started/development-concepts#extension-runner). + default: 18 + required: false + buildSuccessful: + type: boolean + description: | + If `true`, the build is marked as successful and [displayed in the Studio](/../frontend-studio/using-deployment-in-the-studio). + buildTime: + type: string + description: Date and time of the build in the [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) format. For example, `2023-11-21T08:14:31.830Z`. + buildDuration: + type: integer + description: Build duration in seconds. + buildLog: + type: string + description: CI execution logs. + deploy: + type: boolean + description: | + If `true`, the build is automatically deployed to the staging environment, if `buildSuccessful` is `true`. + default: false + required: false diff --git a/api-specs/frontend-api/types/BuildUpload.raml b/api-specs/frontend-api/types/BuildUpload.raml new file mode 100644 index 000000000..e809d6db5 --- /dev/null +++ b/api-specs/frontend-api/types/BuildUpload.raml @@ -0,0 +1,20 @@ +#%RAML 1.0 DataType +(package): Common +displayName: BuildUpload +type: object +properties: + metadata: + description: Metadata about the build. + type: BuildMetadata + required: true + example: !include ../examples/build-upload-metadata-payload.json + extension: + description: Javascript bundle containing all code of the backend extensions. + type: file + required: true + fileTypes: ['*.js'] + extension_map: + description: Map for the build file. When provided, exceptions will be logged with readable stack traces. + type: file + required: false + fileTypes: ['*.js.map'] diff --git a/api-specs/frontend-api/types/BuildUploadResult.raml b/api-specs/frontend-api/types/BuildUploadResult.raml new file mode 100644 index 000000000..9e369890e --- /dev/null +++ b/api-specs/frontend-api/types/BuildUploadResult.raml @@ -0,0 +1,14 @@ +#%RAML 1.0 DataType +(package): Common +displayName: BuildUploadResult +type: object +properties: + status: + type: string + description: Status of the build. + enum: + - success + - failure + message: + type: string + description: Description of the upload result. diff --git a/api-specs/generate-a-postman-collection.md b/api-specs/generate-a-postman-collection.md index 372aceca3..34d26bb8c 100644 --- a/api-specs/generate-a-postman-collection.md +++ b/api-specs/generate-a-postman-collection.md @@ -47,6 +47,5 @@ yarn run generate-postman - api: HTTP API - history: Change History API - import: Import API -- ml: Machine Learning API 4. Choose one of the APIs and import the corresponding `collection.json` and `template.json` files to Postman. diff --git a/api-specs/graphql/schema.sdl b/api-specs/graphql/schema.sdl index 1f390f7e4..1d0bea676 100644 --- a/api-specs/graphql/schema.sdl +++ b/api-specs/graphql/schema.sdl @@ -27,8 +27,6 @@ type APIClientWithoutSecretQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [APIClientWithoutSecret!]! } @@ -125,7 +123,6 @@ input AddCartDiscountCode { validateDuplicates: Boolean = false } -"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input AddCartDiscountStore { store: ResourceIdentifierInput! } @@ -713,8 +710,6 @@ type ApprovalFlowQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [ApprovalFlow!]! } @@ -820,8 +815,6 @@ type ApprovalRuleQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [ApprovalRule!]! } @@ -1100,8 +1093,6 @@ type AssociateRoleQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [AssociateRole!]! } @@ -1216,8 +1207,6 @@ type AttributeGroupQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [AttributeGroup!]! } @@ -1595,8 +1584,6 @@ type BusinessUnitQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [BusinessUnit!]! } @@ -1699,7 +1686,6 @@ type Cart implements Versioned & ReferenceExpandable { customLineItems: [CustomLineItem!]! totalPrice: Money! taxedPrice: TaxedPrice - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" discountOnTotalPrice: DiscountOnTotalPrice shippingAddress: Address billingAddress: Address @@ -1784,11 +1770,7 @@ type CartDiscount implements Versioned & ReferenceExpandable { descriptionAllLocales: [LocalizedString!] referenceRefs: [Reference!]! custom: CustomFieldsType - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" storesRef: [KeyReference!]! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" stores: [Store!]! value: CartDiscountValue! target: CartDiscountTarget @@ -1814,8 +1796,6 @@ input CartDiscountDraft { isActive: Boolean = true custom: CustomFieldsDraft key: String - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" stores: [ResourceIdentifierInput!] } @@ -1843,8 +1823,6 @@ type CartDiscountQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [CartDiscount!]! } @@ -1862,23 +1840,16 @@ input CartDiscountTargetInput { totalPrice: CartDiscountTotalPriceTargetInput } -"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type CartDiscountTotalPriceTarget implements CartDiscountTarget { type: String! } -"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input CartDiscountTotalPriceTargetInput { dummy: String } input CartDiscountUpdateAction { - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" setStores: SetCartDiscountStores - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" addStore: AddCartDiscountStore - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" removeStore: RemoveCartDiscountStore changeCartPredicate: ChangeCartDiscountCartPredicate changeIsActive: ChangeCartDiscountIsActive @@ -1970,8 +1941,6 @@ type CartQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [Cart!]! } @@ -2201,8 +2170,6 @@ type CategoryQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [Category!]! } @@ -2899,8 +2866,6 @@ type ChannelQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [Channel!]! } @@ -2992,8 +2957,6 @@ type CommercetoolsSubscriptionQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [CommercetoolsSubscription!]! } @@ -3313,8 +3276,6 @@ type CustomObjectQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [CustomObject!]! } @@ -3575,8 +3536,6 @@ type CustomerGroupQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [CustomerGroup!]! } @@ -3658,8 +3617,6 @@ type CustomerQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [Customer!]! } @@ -4007,8 +3964,6 @@ type DiscountCodeQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [DiscountCode!]! } @@ -4092,7 +4047,6 @@ type DiscountedProductSearchPriceValue { discount: ProductDiscount } -"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type DiscountedTotalPricePortion { discount: CartDiscount discountRef: Reference! @@ -4217,8 +4171,6 @@ type ExtensionQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [Extension!]! } @@ -4742,8 +4694,6 @@ type InventoryEntryQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [InventoryEntry!]! } @@ -5243,8 +5193,6 @@ type MessageQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [Message!]! } @@ -6326,8 +6274,6 @@ type MyPaymentQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [MyPayment!]! } @@ -6451,7 +6397,6 @@ type Order implements Versioned & ReferenceExpandable { customLineItems: [CustomLineItem!]! totalPrice: Money! taxedPrice: TaxedPrice - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" discountOnTotalPrice: DiscountOnTotalPrice shippingAddress: Address billingAddress: Address @@ -6682,8 +6627,6 @@ type OrderEditQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [OrderEdit!]! } @@ -6793,8 +6736,6 @@ type OrderQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [Order!]! } @@ -7108,8 +7049,6 @@ type PaymentQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [Payment!]! } @@ -7347,8 +7286,6 @@ type ProductAssignmentQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [ProductAssignment!]! } @@ -7546,8 +7483,6 @@ type ProductDiscountQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [ProductDiscount!]! } @@ -7620,8 +7555,6 @@ type ProductOfSelectionQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [ProductOfSelection!]! } @@ -7897,8 +7830,6 @@ type ProductQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [Product!]! } @@ -8066,8 +7997,6 @@ type ProductSelectionQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [ProductSelection!]! } @@ -8176,8 +8105,6 @@ type ProductTypeDefinitionQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [ProductTypeDefinition!]! } @@ -8862,8 +8789,6 @@ type QuoteQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [Quote!]! } @@ -8960,8 +8885,6 @@ type QuoteRequestQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [QuoteRequest!]! } @@ -9243,7 +9166,6 @@ input RemoveCartDiscountCode { discountCode: ReferenceInput! } -"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input RemoveCartDiscountStore { store: ResourceIdentifierInput! } @@ -9657,8 +9579,6 @@ type ReviewQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [Review!]! } @@ -9906,8 +9826,6 @@ type SelectionOfProductQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [SelectionOfProduct!]! } @@ -10163,7 +10081,6 @@ input SetCartDiscountKey { key: String } -"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input SetCartDiscountStores { stores: [ResourceIdentifierInput!] } @@ -12426,8 +12343,6 @@ type ShippingMethodQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [ShippingMethod!]! } @@ -12705,8 +12620,6 @@ type ShoppingListQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [ShoppingList!]! } @@ -12919,8 +12832,6 @@ type StagedQuoteQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [StagedQuote!]! } @@ -13034,8 +12945,6 @@ type StandalonePriceQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [StandalonePrice!]! } @@ -13155,8 +13064,6 @@ type StateQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [State!]! } @@ -13301,8 +13208,6 @@ type StoreQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [Store!]! } @@ -13477,8 +13382,6 @@ type TaxCategoryQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [TaxCategory!]! } @@ -13685,7 +13588,6 @@ type TimeType implements FieldType { name: String! } -"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type DiscountOnTotalPrice { discountedAmount: BaseMoney! includedDiscounts: [DiscountedTotalPricePortion!]! @@ -13915,8 +13817,6 @@ type TypeDefinitionQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [TypeDefinition!]! } @@ -14065,8 +13965,6 @@ type ZoneQueryResult { offset: Int! count: Int! total: Long! - - "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" exists: Boolean! results: [Zone!]! } diff --git a/api-specs/history/types/ModifiedBy.raml b/api-specs/history/types/ModifiedBy.raml index c4b00779f..b118aef32 100644 --- a/api-specs/history/types/ModifiedBy.raml +++ b/api-specs/history/types/ModifiedBy.raml @@ -18,7 +18,7 @@ properties: Indicates who performed the change. - If the change was made by a user, the value is `"user"`. - - If the change was made by an API Client with or without an [external user ID](/client-logging#external-user-ids), the value is `"external-user"`. + - If the change was made by an API Client with or without an [external user ID](/general-concepts#external-user-ids), the value is `"external-user"`. - If the change was made by an [Associate](ctp:api:type:Associate), the value is `"associate"`. clientId?: type: string diff --git a/api-specs/history/types/change/AddAddressChange.raml b/api-specs/history/types/change/AddAddressChange.raml index 92c3e4a6c..bff945eda 100644 --- a/api-specs/history/types/change/AddAddressChange.raml +++ b/api-specs/history/types/change/AddAddressChange.raml @@ -13,9 +13,6 @@ properties: type: string enum: - AddAddressChange - previousValue: - type: Address - description: Value before the change. nextValue: type: Address description: Value after the change. diff --git a/api-specs/history/types/change/AddChannelRolesChange.raml b/api-specs/history/types/change/AddChannelRolesChange.raml index 58638df7c..0a8ea4b9e 100644 --- a/api-specs/history/types/change/AddChannelRolesChange.raml +++ b/api-specs/history/types/change/AddChannelRolesChange.raml @@ -16,10 +16,10 @@ properties: previousValue: type: array items: - type: ChannelRole + type: ChannelRoleEnum description: Value before the change. nextValue: type: array items: - type: ChannelRole + type: ChannelRoleEnum description: Value after the change. diff --git a/api-specs/history/types/change/AddLocalizedEnumValueChange.raml b/api-specs/history/types/change/AddLocalizedEnumValueChange.raml index 0033d9bec..37c0a887c 100644 --- a/api-specs/history/types/change/AddLocalizedEnumValueChange.raml +++ b/api-specs/history/types/change/AddLocalizedEnumValueChange.raml @@ -18,7 +18,7 @@ properties: enum: - addLocalizedEnumValue nextValue: - type: LocalizedEnumValue + type: AttributeLocalizedEnumValue description: Value after the change. fieldName: type: string diff --git a/api-specs/history/types/change/AddLocationChange.raml b/api-specs/history/types/change/AddLocationChange.raml index caa0a51e6..296e1d3bc 100644 --- a/api-specs/history/types/change/AddLocationChange.raml +++ b/api-specs/history/types/change/AddLocationChange.raml @@ -13,9 +13,6 @@ properties: type: string enum: - addLocation - previousValue: - type: Location - description: Value before the change. nextValue: type: Location description: Value after the change. diff --git a/api-specs/history/types/change/AddPlainEnumValueChange.raml b/api-specs/history/types/change/AddPlainEnumValueChange.raml index 42574eeb0..109a595f6 100644 --- a/api-specs/history/types/change/AddPlainEnumValueChange.raml +++ b/api-specs/history/types/change/AddPlainEnumValueChange.raml @@ -14,7 +14,7 @@ properties: enum: - addPlainEnumValue nextValue: - type: EnumValue + type: AttributePlainEnumValue description: Value after the change. attributeName: type: string diff --git a/api-specs/history/types/change/AddStateRolesChange.raml b/api-specs/history/types/change/AddStateRolesChange.raml index 0f60c118f..296d68e12 100644 --- a/api-specs/history/types/change/AddStateRolesChange.raml +++ b/api-specs/history/types/change/AddStateRolesChange.raml @@ -16,10 +16,10 @@ properties: previousValue: type: array items: - type: StateRole + type: StateRoleEnum description: Value before the change. nextValue: type: array items: - type: StateRole + type: StateRoleEnum description: Value after the change. diff --git a/api-specs/history/types/change/ChangeDescriptionChange.raml b/api-specs/history/types/change/ChangeDescriptionChange.raml index 77ed4a2c2..4cccf7e52 100644 --- a/api-specs/history/types/change/ChangeDescriptionChange.raml +++ b/api-specs/history/types/change/ChangeDescriptionChange.raml @@ -4,10 +4,8 @@ type: Change displayName: ChangeDescriptionChange discriminatorValue: ChangeDescriptionChange description: | - Change triggered by the following update actions: + Change triggered by the [Change Description](ctp:api:type:ProductTypeChangeDescriptionAction) update action. - - [Change Description](ctp:api:type:ChannelChangeDescriptionAction) on Channels. - - [Change Description](ctp:api:type:ProductTypeChangeDescriptionAction) on Product Types. properties: type: type: string diff --git a/api-specs/history/types/change/ChangeLocalizedDescriptionChange.raml b/api-specs/history/types/change/ChangeLocalizedDescriptionChange.raml index 982802862..839a60661 100644 --- a/api-specs/history/types/change/ChangeLocalizedDescriptionChange.raml +++ b/api-specs/history/types/change/ChangeLocalizedDescriptionChange.raml @@ -4,10 +4,8 @@ type: Change displayName: ChangeLocalizedDescriptionChange discriminatorValue: ChangeLocalizedDescriptionChange description: | - Change triggered by the following update actions: + Change triggered by the [Change Description](ctp:api:type:ChannelChangeDescriptionAction) update action. - - [Change Description](ctp:api:type:ProductTypeChangeDescriptionAction) on Product Types. - - [Change Description](ctp:api:type:ChannelChangeDescriptionAction) on Channels. properties: type: type: string diff --git a/api-specs/history/types/change/ChangeLocalizedNameChange.raml b/api-specs/history/types/change/ChangeLocalizedNameChange.raml index bdbc437da..71451f4f6 100644 --- a/api-specs/history/types/change/ChangeLocalizedNameChange.raml +++ b/api-specs/history/types/change/ChangeLocalizedNameChange.raml @@ -9,14 +9,10 @@ description: | - [Change Name](ctp:api:type:CartDiscountChangeNameAction) on Cart Discounts. - [Change Name](ctp:api:type:CategoryChangeNameAction) on Categories. - [Change Name](ctp:api:type:ChannelChangeNameAction) on Channels. - - [Change Name](ctp:api:type:CustomerGroupChangeNameAction) on Customer Groups. - [Change Name](ctp:api:type:ProductChangeNameAction) on Products. - [Change Name](ctp:api:type:ProductDiscountChangeNameAction) on Product Discounts. - [Change Name](ctp:api:type:ProductSelectionChangeNameAction) on Product Selections. - - [Change Name](ctp:api:type:ProductTypeChangeNameAction) on Product Types. - [Change Name](ctp:api:type:ShoppingListChangeNameAction) on Shopping Lists. - - [Change Name](ctp:api:type:TaxCategoryChangeNameAction) on Tax Categories. - - [Change Name](ctp:api:type:TypeChangeNameAction) on Types. - [Change Name](ctp:api:type:ZoneChangeNameAction) on Zones. properties: type: diff --git a/api-specs/history/types/change/ChangeNameChange.raml b/api-specs/history/types/change/ChangeNameChange.raml index e3fd9ac19..769b0ee2c 100644 --- a/api-specs/history/types/change/ChangeNameChange.raml +++ b/api-specs/history/types/change/ChangeNameChange.raml @@ -6,17 +6,9 @@ discriminatorValue: ChangeNameChange description: | Change triggered by the following update actions: - - [Change Name](ctp:api:type:CartDiscountChangeNameAction) on Cart Discounts. - - [Change Name](ctp:api:type:CategoryChangeNameAction) on Categories. - - [Change Name](ctp:api:type:ChannelChangeNameAction) on Channels. - [Change Name](ctp:api:type:CustomerGroupChangeNameAction) on Customer Groups. - - [Change Name](ctp:api:type:ProductChangeNameAction) on Products. - - [Change Name](ctp:api:type:ProductDiscountChangeNameAction) on Product Discounts. - - [Change Name](ctp:api:type:ProductSelectionChangeNameAction) on Product Selections. - [Change Name](ctp:api:type:ProductTypeChangeNameAction) on Product Types. - - [Change Name](ctp:api:type:ShoppingListChangeNameAction) on Shopping Lists. - [Change Name](ctp:api:type:TaxCategoryChangeNameAction) on Tax Categories. - - [Change Name](ctp:api:type:TypeChangeNameAction) on Types. - [Change Name](ctp:api:type:ZoneChangeNameAction) on Zones. properties: type: diff --git a/api-specs/history/types/change/ChangeStateTypeChange.raml b/api-specs/history/types/change/ChangeStateTypeChange.raml index 904b911ee..ab5080f0d 100644 --- a/api-specs/history/types/change/ChangeStateTypeChange.raml +++ b/api-specs/history/types/change/ChangeStateTypeChange.raml @@ -14,8 +14,8 @@ properties: enum: - changeType previousValue: - type: StateType + type: StateTypeEnum description: Value before the change. nextValue: - type: StateType + type: StateTypeEnum description: Value after the change. diff --git a/api-specs/history/types/change/RemoveChannelRolesChange.raml b/api-specs/history/types/change/RemoveChannelRolesChange.raml index a1c3153f2..57ce942f1 100644 --- a/api-specs/history/types/change/RemoveChannelRolesChange.raml +++ b/api-specs/history/types/change/RemoveChannelRolesChange.raml @@ -16,10 +16,10 @@ properties: previousValue: type: array items: - type: ChannelRole + type: ChannelRoleEnum description: Value before the change. nextValue: type: array items: - type: ChannelRole + type: ChannelRoleEnum description: Value after the change. diff --git a/api-specs/history/types/change/RemoveLocationChange.raml b/api-specs/history/types/change/RemoveLocationChange.raml index bb8b8182f..5e5ae74c9 100644 --- a/api-specs/history/types/change/RemoveLocationChange.raml +++ b/api-specs/history/types/change/RemoveLocationChange.raml @@ -16,6 +16,3 @@ properties: previousValue: type: Location description: Value before the change. - nextValue: - type: Location - description: Value after the change. diff --git a/api-specs/history/types/change/RemoveStateRolesChange.raml b/api-specs/history/types/change/RemoveStateRolesChange.raml index cee4834f6..1f2eb4920 100644 --- a/api-specs/history/types/change/RemoveStateRolesChange.raml +++ b/api-specs/history/types/change/RemoveStateRolesChange.raml @@ -16,10 +16,10 @@ properties: previousValue: type: array items: - type: StateRole + type: StateRoleEnum description: Value before the change. nextValue: type: array items: - type: StateRole + type: StateRoleEnum description: Value after the change. diff --git a/api-specs/history/types/change/RemoveTaxRateChange.raml b/api-specs/history/types/change/RemoveTaxRateChange.raml index b01103d6b..5cb759695 100644 --- a/api-specs/history/types/change/RemoveTaxRateChange.raml +++ b/api-specs/history/types/change/RemoveTaxRateChange.raml @@ -16,6 +16,3 @@ properties: previousValue: type: TaxRate description: Value before the change. - nextValue: - type: TaxRate - description: Value after the change. diff --git a/api-specs/history/types/change/SetChannelRolesChange.raml b/api-specs/history/types/change/SetChannelRolesChange.raml index 153aacb05..d84e2fc51 100644 --- a/api-specs/history/types/change/SetChannelRolesChange.raml +++ b/api-specs/history/types/change/SetChannelRolesChange.raml @@ -16,10 +16,10 @@ properties: previousValue: type: array items: - type: ChannelRole + type: ChannelRoleEnum description: Value before the change. nextValue: type: array items: - type: ChannelRole + type: ChannelRoleEnum description: Value after the change. diff --git a/api-specs/history/types/change/SetDescriptionChange.raml b/api-specs/history/types/change/SetDescriptionChange.raml index d6098976b..580a30933 100644 --- a/api-specs/history/types/change/SetDescriptionChange.raml +++ b/api-specs/history/types/change/SetDescriptionChange.raml @@ -6,15 +6,7 @@ discriminatorValue: SetDescriptionChange description: | Change triggered by the following update actions: - - [Set Description](ctp:api:type:CartDiscountSetDescriptionAction) on Cart Discounts. - - [Set Description](ctp:api:type:CategorySetDescriptionAction) on Categories. - - [Set Description](ctp:api:type:DiscountCodeSetDescriptionAction) on Discount Codes. - - [Set Description](ctp:api:type:ProductSetDescriptionAction) on Products. - - [Set Description](ctp:api:type:ProductDiscountSetDescriptionAction) on Product Discounts. - - [Set Description](ctp:api:type:ShoppingListSetDescriptionAction) on Shopping Lists. - - [Set Description](ctp:api:type:StateSetDescriptionAction) on States. - [Set Description](ctp:api:type:TaxCategorySetDescriptionAction) on Tax Categories. - - [Set Description](ctp:api:type:TypeSetDescriptionAction) on Types. - [Set Description](ctp:api:type:ZoneSetDescriptionAction) on Zones. properties: type: diff --git a/api-specs/history/types/change/SetLocalizedDescriptionChange.raml b/api-specs/history/types/change/SetLocalizedDescriptionChange.raml index 24cc5414c..7f67cb146 100644 --- a/api-specs/history/types/change/SetLocalizedDescriptionChange.raml +++ b/api-specs/history/types/change/SetLocalizedDescriptionChange.raml @@ -13,9 +13,7 @@ description: | - [Set Description](ctp:api:type:ProductDiscountSetDescriptionAction) on Product Discounts. - [Set Description](ctp:api:type:ShoppingListSetDescriptionAction) on Shopping Lists. - [Set Description](ctp:api:type:StateSetDescriptionAction) on States. - - [Set Description](ctp:api:type:TaxCategorySetDescriptionAction) on Tax Categories. - [Set Description](ctp:api:type:TypeSetDescriptionAction) on Types. - - [Set Description](ctp:api:type:ZoneSetDescriptionAction) on Zones. properties: type: type: string diff --git a/api-specs/history/types/change/SetStateRolesChange.raml b/api-specs/history/types/change/SetStateRolesChange.raml index ab3c821b2..71f294e22 100644 --- a/api-specs/history/types/change/SetStateRolesChange.raml +++ b/api-specs/history/types/change/SetStateRolesChange.raml @@ -16,10 +16,10 @@ properties: previousValue: type: array items: - type: StateRole + type: StateRoleEnum description: Value before the change. nextValue: type: array items: - type: StateRole + type: StateRoleEnum description: Value after the change. diff --git a/api-specs/history/types/common/AttributeLocalizedEnumValue.raml b/api-specs/history/types/common/AttributeLocalizedEnumValue.raml new file mode 100644 index 000000000..392207067 --- /dev/null +++ b/api-specs/history/types/common/AttributeLocalizedEnumValue.raml @@ -0,0 +1,15 @@ +#%RAML 1.0 DataType +(package): Common +type: object +displayName: AttributeLocalizedEnumValue +description: | + A localized enum value must be unique within the enum, else a [DuplicateEnumValues](ctp:api:type:DuplicateEnumValuesError) error is returned. +properties: + key: + type: string + description: | + Key of the value used as a programmatic identifier, for example in facets & filters. + label: + type: LocalizedString + description: | + Descriptive, localized label of the value. diff --git a/api-specs/history/types/common/AttributePlainEnumValue.raml b/api-specs/history/types/common/AttributePlainEnumValue.raml new file mode 100644 index 000000000..2370d211e --- /dev/null +++ b/api-specs/history/types/common/AttributePlainEnumValue.raml @@ -0,0 +1,15 @@ +#%RAML 1.0 DataType +(package): Common +type: object +displayName: AttributePlainEnumValue +description: | + A plain enum value must be unique within the enum, else a [DuplicateEnumValues](ctp:api:type:DuplicateEnumValuesError) error is returned. +properties: + key: + type: string + description: | + Key of the value used as a programmatic identifier, for example in facets & filters. + label: + type: string + description: | + Descriptive label of the value. diff --git a/api-specs/history/types/common/ChannelRole.raml b/api-specs/history/types/common/ChannelRoleEnum.raml similarity index 52% rename from api-specs/history/types/common/ChannelRole.raml rename to api-specs/history/types/common/ChannelRoleEnum.raml index 07f0dfc56..f62feac1d 100644 --- a/api-specs/history/types/common/ChannelRole.raml +++ b/api-specs/history/types/common/ChannelRoleEnum.raml @@ -1,8 +1,9 @@ #%RAML 1.0 DataType (package): Common +displayName: ChannelRoleEnum type: string -displayName: ChannelRole -description: +description: | + Describes the purpose and type of the Channel. A Channel can have one or more roles. enum: - InventorySupply - ProductDistribution diff --git a/api-specs/history/types/common/StateRole.raml b/api-specs/history/types/common/StateRoleEnum.raml similarity index 51% rename from api-specs/history/types/common/StateRole.raml rename to api-specs/history/types/common/StateRoleEnum.raml index f09b3a685..c5663c3b4 100644 --- a/api-specs/history/types/common/StateRole.raml +++ b/api-specs/history/types/common/StateRoleEnum.raml @@ -1,8 +1,8 @@ #%RAML 1.0 DataType (package): Common type: string -displayName: StateRole -description: +description: | + For some resource types, a State can fulfill the following predefined roles: enum: - ReviewIncludedInStatistics - Return diff --git a/api-specs/history/types/common/StateType.raml b/api-specs/history/types/common/StateTypeEnum.raml similarity index 52% rename from api-specs/history/types/common/StateType.raml rename to api-specs/history/types/common/StateTypeEnum.raml index 87ce8da6a..62d4bce44 100644 --- a/api-specs/history/types/common/StateType.raml +++ b/api-specs/history/types/common/StateTypeEnum.raml @@ -1,11 +1,14 @@ #%RAML 1.0 DataType (package): Common type: string -displayName: StateType -description: +description: | + Resource or object type the State can be assigned to. enum: - OrderState - LineItemState - ProductState - ReviewState - PaymentState + - QuoteRequestState + - StagedQuoteState + - QuoteState diff --git a/api-specs/history/types/types.raml b/api-specs/history/types/types.raml index 6e0e494a5..f365da767 100644 --- a/api-specs/history/types/types.raml +++ b/api-specs/history/types/types.raml @@ -59,6 +59,8 @@ AssociateRoleInheritanceMode: !include common/AssociateRoleInheritanceMode.raml AssociateRoleLabel: !include label/AssociateRoleLabel.raml AttributeConstraintEnum: !include common/AttributeConstraintEnum.raml AttributeDefinition: !include common/AttributeDefinition.raml +AttributeLocalizedEnumValue: !include common/AttributeLocalizedEnumValue.raml +AttributePlainEnumValue: !include common/AttributePlainEnumValue.raml AttributeType: !include common/AttributeType.raml AttributeValue: !include change/change-value/AttributeValue.raml AuthenticationMode: !include common/AuthenticationMode.raml @@ -144,7 +146,7 @@ ChangeValueChange: !include change/ChangeValueChange.raml ChangeValueExternalChangeValue: !include change/change-value/ChangeValueExternalChangeValue.raml ChangeValueGiftLineItemChangeValue: !include change/change-value/ChangeValueGiftLineItemChangeValue.raml ChangeValueRelativeChangeValue: !include change/change-value/ChangeValueRelativeChangeValue.raml -ChannelRole: !include common/ChannelRole.raml +ChannelRoleEnum: !include common/ChannelRoleEnum.raml CountryCode: !include common/CountryCode.raml CurrencyCode: !include common/CurrencyCode.raml CustomFieldExpandedValue: !include change/change-value/CustomFieldExpandedValue.raml @@ -408,8 +410,8 @@ ShoppingListLineItemValue: !include change/change-value/ShoppingListLineItemValu StackingMode: !include common/StackingMode.raml StagedQuoteLabel: !include label/StagedQuoteLabel.raml StagedQuoteState: !include common/StagedQuoteState.raml -StateRole: !include common/StateRole.raml -StateType: !include common/StateType.raml +StateRoleEnum: !include common/StateRoleEnum.raml +StateTypeEnum: !include common/StateTypeEnum.raml StoreCountry: !include common/StoreCountry.raml StringLabel: !include label/StringLabel.raml SubRate: !include common/SubRate.raml diff --git a/api-specs/importapi/api.raml b/api-specs/importapi/api.raml index 237e6a401..d897f5de6 100644 --- a/api-specs/importapi/api.raml +++ b/api-specs/importapi/api.raml @@ -249,6 +249,7 @@ traits: 200: body: type: import-summary.ImportSummary + example: !include examples/import-summary.json /import-operations: type: base get: @@ -267,7 +268,7 @@ traits: Number of [elements skipped](/../api/general-concepts#offset). sort?: description: | - See [Sorting](https://docs.commercetools.com/api/general-concepts#sorting). + See [Sorting](/../api/general-concepts#sorting). type: string[] resourceKey?: description: | diff --git a/api-specs/importapi/examples/import-summary.json b/api-specs/importapi/examples/import-summary.json new file mode 100644 index 000000000..fa173f2cd --- /dev/null +++ b/api-specs/importapi/examples/import-summary.json @@ -0,0 +1,12 @@ +{ + "states": { + "processing": 3, + "validationFailed": 0, + "unresolved": 0, + "waitForMasterVariant": 0, + "imported": 2, + "rejected": 0, + "canceled": 0 + }, + "total": 5 +} diff --git a/api-specs/ml/README.md b/api-specs/ml/README.md deleted file mode 100644 index 99268ba1b..000000000 --- a/api-specs/ml/README.md +++ /dev/null @@ -1,27 +0,0 @@ -[![CircleCI](https://circleci.com/gh/commercetools/ml-services-api-reference.svg?style=svg&circle-token=238371835c24c7a0ab677ce159f01879eb226f69)](https://circleci.com/gh/commercetools/ml-services-api-reference) - -# Summary - -This repository contains the -[RAML specification](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md) -for commercetools machine learning API. - -# Setup - -- [install yarn](https://classic.yarnpkg.com/en/docs/install/#mac-stable) if you - don't already have it. -- run `yarn install` to install dependencies - -Now whenever the spec is changed, the git hooks make sure that the precommit -tasks are executed (such as formatting...) - -# Checking that the specification is valid - -In case you made changes to the spec, and want to check that it's valid before -commiting to git, you can follow these steps. - -- install - [`rmf-codegen`](https://github.com/vrapio/rmf-codegen#install-rmf-codegen-cli) - cli, if not already installed. -- run `rmf-codegen verify api.raml` at the project root, to check that the api - is valid. diff --git a/api-specs/ml/api.raml b/api-specs/ml/api.raml deleted file mode 100644 index dd22dc753..000000000 --- a/api-specs/ml/api.raml +++ /dev/null @@ -1,34 +0,0 @@ -#%RAML 1.0 ---- -title: commercetools Composable Commerce Machine Learning API -version: v1 -mediaType: application/json -baseUri: https://ml-eu.europe-west1.gcp.commercetools.com - -uses: - category-recommendations: types/category-recommendations.raml - general-recommendations: types/general-recommendations.raml - image-search: types/image-search.raml - image-search-config: types/image-search-config.raml - missing-data: types/missing-data.raml - common: types/common.raml - similar-products: types/similar-products.raml - annotations: types/annotations.raml -(annotations.products): - - Composable Commerce - -securitySchemes: - oauth_2_0: !include securitySchemes/oauth2.raml -securedBy: [oauth_2_0] - -/{projectKey}: - (annotations.methodName): withProjectKey - uriParameters: - projectKey: - type: string - /image-search: !include resources/image-search.raml - /recommendations: - /project-categories: !include resources/category-recommendations.raml - /general-categories: !include resources/general-recommendations.raml - /missing-data: !include resources/missing-data.raml - /similarities: !include resources/similar-products.raml diff --git a/api-specs/ml/examples/category-recommendations.json b/api-specs/ml/examples/category-recommendations.json deleted file mode 100644 index d993be470..000000000 --- a/api-specs/ml/examples/category-recommendations.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "count": 2, - "total": 16, - "offset": 0, - "results": [ - { - "category": { - "id": "c077eb33-c5fe-4560-af75-abb8b205ca25", - "typeId": "category" - }, - "confidence": 0.08427, - "path": "Men > Shoes" - }, - { - "category": { - "id": "b0b08091-8e32-4601-948a-8b504606d3ac", - "typeId": "category" - }, - "confidence": 0.08319, - "path": "Accessories > Men > Shoes" - } - ], - "meta": { - "productName": "Runner – Philippe Model “Tropez”", - "productImageUrl": "https://s3-eu-west-1.amazonaws.com/commercetools-maximilian/products/083442_1_medium.jpg?$mcsmall$", - "generalCategoryNames": [ - "shoes", - "sports", - "fitness", - "sneakers", - "loafers" - ] - } -} diff --git a/api-specs/ml/examples/general-recommendations.json b/api-specs/ml/examples/general-recommendations.json deleted file mode 100644 index 987bd4fe1..000000000 --- a/api-specs/ml/examples/general-recommendations.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "count": 3, - "total": 11, - "offset": 0, - "results": [ - { - "categoryName": "headwear", - "confidence": 0.06584 - }, - { - "categoryName": "caps", - "confidence": 0.0279 - }, - { - "categoryName": "women", - "confidence": 0.02391 - } - ] -} diff --git a/api-specs/ml/examples/image-search.json b/api-specs/ml/examples/image-search.json deleted file mode 100644 index f814ef260..000000000 --- a/api-specs/ml/examples/image-search.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "count": 3, - "offset": 0, - "total": 110, - "results": [ - { - "imageUrl": "http://cdn6.bigcommerce.com/s-stm8v/products/586/images/1711/3D_GOLF_HOODIE_BLACK__17630.1481286168.490.588.jpg?c=2", - "productVariants": [ - { - "product": { - "id": "0f5feac3-b50f-447b-8c36-7603153a2dd0", - "typeId": "product" - }, - "staged": true, - "variantId": 1 - } - ] - }, - { - "imageUrl": "http://images.koovscdn.com/uploads/products/81364_1a41bcd8e5e3a8bf675c48aa2be132a3_image1_zoom.jpg", - "productVariants": [ - { - "product": { - "id": "8a7f5101-8b20-4ba6-8988-ff43dbf35d3d", - "typeId": "product" - }, - "staged": true, - "variantId": 1 - } - ] - }, - { - "imageUrl": "http://sandiegobrewing.com/gear/wp-content/uploads/2015/03/guy-white-380x380.png", - "productVariants": [ - { - "product": { - "id": "15245f8f-478b-426a-b3a9-41e8257f39d9", - "typeId": "product" - }, - "staged": true, - "variantId": 1 - }, - { - "product": { - "id": "a315869c-3d78-476c-99d1-3dec4375a97a", - "typeId": "product" - }, - "staged": false, - "variantId": 1 - }, - { - "product": { - "id": "a315869c-3d78-476c-99d1-3dec4375a97a", - "typeId": "product" - }, - "staged": true, - "variantId": 1 - } - ] - } - ] -} diff --git a/api-specs/ml/examples/missing-data-response.json b/api-specs/ml/examples/missing-data-response.json deleted file mode 100644 index 63e48e753..000000000 --- a/api-specs/ml/examples/missing-data-response.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "result": { - "count": 1, - "offset": 0, - "total": 26137, - "meta": { - "productLevel": { - "total": 2968, - "missingAttributeNames": 2968, - "missingAttributeValues": 2968 - }, - "variantLevel": { - "total": 26137, - "missingAttributeNames": 26137, - "missingAttributeValues": 26137 - } - }, - "results": [ - { - "product": { - "id": "a8e01ea0-4181-4b00-9a2d-198504c6e4bd", - "typeId": "product" - }, - "productType": { - "id": "e7878071-7713-4f37-9ddd-dfc99b9b33dc", - "typeId": "product-type" - }, - "variantId": 1, - "attributeCount": { - "productTypeAttributes": 15, - "variantAttributes": 12, - "missingAttributeValues": 2 - }, - "attributeCoverage": { - "names": 0.8, - "values": 0.83 - }, - "missingAttributeNames": ["designer", "color", "style"], - "missingAttributeValues": ["completeTheLook", "lookProducts"] - } - ] - }, - "state": "SUCCESS", - "expires": "2019-01-19T15:00:56.546614Z" -} diff --git a/api-specs/ml/examples/missing-data-token.json b/api-specs/ml/examples/missing-data-token.json deleted file mode 100644 index 517800231..000000000 --- a/api-specs/ml/examples/missing-data-token.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "taskId": "b37e87f3-1d2b-4550-83ef-bd2e7e7f1b09", - "uriPath": "/{projectKey}/missing-data/attributes/status/b37e87f3-1d2b-4550-83ef-bd2e7e7f1b09" -} diff --git a/api-specs/ml/examples/missing-images-response.json b/api-specs/ml/examples/missing-images-response.json deleted file mode 100644 index 628ecbfb6..000000000 --- a/api-specs/ml/examples/missing-images-response.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "result": { - "count": 1, - "offset": 0, - "total": 7, - "meta": { - "threshold": 1, - "productLevel": { - "total": 2968, - "missingImages": 1 - }, - "variantLevel": { - "total": 29105, - "missingImages": 7 - } - }, - "results": [ - { - "product": { - "id": "a2a9db01-00fe-436d-b56e-2545642984c0", - "typeId": "product" - }, - "variantId": 2, - "imageCount": 0 - } - ] - }, - "state": "SUCCESS", - "expires": "2019-01-19T15:09:27.791377Z" -} diff --git a/api-specs/ml/examples/missing-prices-response.json b/api-specs/ml/examples/missing-prices-response.json deleted file mode 100644 index d745ba587..000000000 --- a/api-specs/ml/examples/missing-prices-response.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "result": { - "count": 2, - "offset": 0, - "total": 122, - "meta": { - "productLevel": { - "total": 2828, - "missingPrices": 122 - }, - "variantLevel": { - "total": 2828, - "missingPrices": 122 - } - }, - "results": [ - { - "product": { - "id": "d637f362-0940-4902-9e8e-a361ff71d569", - "typeId": "product" - }, - "variantId": 1 - }, - { - "product": { - "id": "9a47c2be-c842-4403-a779-64f8872d587d", - "typeId": "product" - }, - "variantId": 1 - } - ] - }, - "state": "SUCCESS", - "expires": "2019-01-19T16:18:45.121950Z" -} diff --git a/api-specs/ml/examples/similar-products-response.json b/api-specs/ml/examples/similar-products-response.json deleted file mode 100644 index bc7660bb2..000000000 --- a/api-specs/ml/examples/similar-products-response.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "state": "SUCCESS", - "result": { - "count": 1, - "total": 16, - "offset": 0, - "results": [ - { - "confidence": 0.68427, - "products": [ - { - "product": { - "id": "b0b08091-8e32-4601-948a-8b504606d3ac", - "typeId": "product" - }, - "variantId": 1, - "meta": { - "name": { - "en": "White T-Shirt | Commercetools Hackathon Edition | Available in S/M/L" - } - } - }, - - { - "product": { - "id": "46014606-8b50-4606-8292-4a414601948a", - "typeId": "product" - }, - "variantId": 1, - "meta": { - "name": { - "en": "Limited edition of the Commercetools T-Shirt - White Color - Now on Sale!" - } - } - } - ] - } - ], - "meta": { - "similarityMeasures": { - "name": 1 - } - } - } -} diff --git a/api-specs/ml/examples/similar-products-token.json b/api-specs/ml/examples/similar-products-token.json deleted file mode 100644 index 6804147d6..000000000 --- a/api-specs/ml/examples/similar-products-token.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "taskId": "078b4eb3-8e29-1276-45b1-8964cf118707", - "uriPath": "/{projectKey}/similarities/products/078b4eb3-8e29-1276-45b1-8964cf118707" -} diff --git a/api-specs/ml/resources/category-recommendations.raml b/api-specs/ml/resources/category-recommendations.raml deleted file mode 100644 index 119543e06..000000000 --- a/api-specs/ml/resources/category-recommendations.raml +++ /dev/null @@ -1,36 +0,0 @@ -#%RAML 1.0 Library - -/{productId}: - (annotations.methodName): withProductId - uriParameters: - productId: - type: string - get: - description: | - Response Representation: PagedQueryResult with a results array of ProjectCategoryrecommendation, sorted by confidence scores in descending order and the meta information of ProjectCategoryrecommendationMeta. - queryParameters: - limit?: - default: 3 - type: integer - description: | - Number of [results requested](/../api/general-concepts#limit). - offset?: - default: 0 - type: integer - description: | - Number of [elements skipped](/../api/general-concepts#offset). - staged?: - type: boolean - description: Flag to target either the staged or the current version of a Product. - confidenceMin?: - type: number - format: float - confidenceMax?: - type: number - format: float - responses: - 200: - body: - application/json: - type: category-recommendations.ProjectCategoryRecommendationPagedQueryResponse - example: !include ../examples/category-recommendations.json diff --git a/api-specs/ml/resources/general-recommendations.raml b/api-specs/ml/resources/general-recommendations.raml deleted file mode 100644 index dae277795..000000000 --- a/api-specs/ml/resources/general-recommendations.raml +++ /dev/null @@ -1,39 +0,0 @@ -#%RAML 1.0 Library - -get: - description: | - This endpoint takes arbitrary product names or image URLs and generates recommendations from a general set of categories, which cover a broad range of industries. The full list of supported categories can be found [here](https://docs.commercetools.com/category_recommendations_supported_categories.txt). These are independent of the categories that are actually defined in your project. The main purpose of this API is to provide a quick way to test the behavior of the category recommendations engine for different names and images. In contrast to the [project-specific endpoint](https://docs.commercetools.com/http-api-projects-categoryrecommendations#project-specific-category-recommendations), this endpoint does not have [activation criteria](https://docs.commercetools.com/http-api-projects-categoryrecommendations#activating-the-api) and is enabled for all projects. - queryParameters: - productImageUrl?: - type: string - description: - Either `productName` or `productImageUrl` is required URL to a product - image. - productName: - type: string - description: - Either `productName` or `productImageUrl` is required. Name of the - product that should get category recommendations (best results with - English names). - limit?: - default: 3 - type: integer - description: | - Number of [results requested](/../api/general-concepts#limit). - offset?: - default: 0 - type: integer - description: | - Number of [elements skipped](/../api/general-concepts#offset). - confidenceMin?: - type: number - format: float - confidenceMax?: - type: number - format: float - responses: - 200: - body: - application/json: - type: general-recommendations.GeneralCategoryRecommendationPagedQueryResponse - example: !include ../examples/general-recommendations.json diff --git a/api-specs/ml/resources/image-search.raml b/api-specs/ml/resources/image-search.raml deleted file mode 100644 index 95d746f65..000000000 --- a/api-specs/ml/resources/image-search.raml +++ /dev/null @@ -1,46 +0,0 @@ -#%RAML 1.0 Library - -description: | - Search for similar products using an image as search input. -post: - description: | - Accepts an image file and returns similar products from product catalogue. - queryParameters: - limit?: - description: | - Number of [results requested](/../api/general-concepts#limit). - default: 5 - type: integer - offset?: - default: 0 - type: integer - description: | - Number of [elements skipped](/../api/general-concepts#offset). - body: - multipart/form-data: - type: image-search.ImageSearchRequest - fileTypes: ['image/jpeg', 'image/png', 'image/gif'] - responses: - 200: - body: - application/json: - type: image-search.ImageSearchResponse - example: !include ../examples/image-search.json -/config: - get: - description: Get the current image search config. - responses: - 200: - body: - application/json: - type: image-search-config.ImageSearchConfigResponse - post: - description: Endpoint to update the image search config. - body: - application/json: - type: image-search-config.ImageSearchConfigRequest - responses: - 200: - body: - application/json: - type: image-search-config.ImageSearchConfigResponse diff --git a/api-specs/ml/resources/missing-data.raml b/api-specs/ml/resources/missing-data.raml deleted file mode 100644 index b50bcf801..000000000 --- a/api-specs/ml/resources/missing-data.raml +++ /dev/null @@ -1,105 +0,0 @@ -#%RAML 1.0 Library -(annotations.deprecated): true -(annotations.beta): true -/attributes: - (annotations.deprecated): true - (annotations.beta): true - post: - (annotations.deprecated): true - (annotations.beta): true - body: - application/json: - type: missing-data.MissingAttributesSearchRequest - responses: - 202: - body: - application/json: - type: common.TaskToken - example: !include ../examples/missing-data-token.json - /status: - (annotations.deprecated): true - (annotations.beta): true - /{taskId}: - (annotations.deprecated): true - (annotations.beta): true - (annotations.methodName): withTaskId - uriParameters: - taskId: - type: string - get: - (annotations.deprecated): true - (annotations.beta): true - responses: - 200: - body: - application/json: - type: missing-data.MissingDataTaskStatus - example: !include ../examples/missing-data-response.json -/images: - (annotations.deprecated): true - (annotations.beta): true - post: - (annotations.deprecated): true - (annotations.beta): true - body: - application/json: - type: missing-data.MissingImagesSearchRequest - responses: - 202: - body: - application/json: - type: common.TaskToken - example: !include ../examples/missing-data-token.json - /status: - (annotations.deprecated): true - (annotations.beta): true - /{taskId}: - (annotations.deprecated): true - (annotations.beta): true - (annotations.methodName): withTaskId - uriParameters: - taskId: - type: string - get: - (annotations.deprecated): true - (annotations.beta): true - responses: - 200: - body: - application/json: - type: missing-data.MissingImagesTaskStatus - example: !include ../examples/missing-images-response.json -/prices: - (annotations.deprecated): true - (annotations.beta): true - post: - (annotations.deprecated): true - (annotations.beta): true - body: - application/json: - type: missing-data.MissingPricesSearchRequest - responses: - 202: - body: - application/json: - type: common.TaskToken - example: !include ../examples/missing-data-token.json - /status: - (annotations.deprecated): true - (annotations.beta): true - /{taskId}: - (annotations.deprecated): true - (annotations.beta): true - (annotations.methodName): withTaskId - uriParameters: - taskId: - type: string - get: - (annotations.deprecated): true - (annotations.beta): true - responses: - 200: - body: - application/json: - type: missing-data.MissingPricesTaskStatus - example: !include ../examples/missing-prices-response.json diff --git a/api-specs/ml/resources/similar-products.raml b/api-specs/ml/resources/similar-products.raml deleted file mode 100644 index 92079e9b2..000000000 --- a/api-specs/ml/resources/similar-products.raml +++ /dev/null @@ -1,26 +0,0 @@ -#%RAML 1.0 Library - -/products: - post: - body: - application/json: - type: similar-products.SimilarProductSearchRequest - responses: - 202: - body: - application/json: - type: common.TaskToken - example: !include ../examples/similar-products-token.json - /status: - /{taskId}: - (annotations.methodName): withTaskId - uriParameters: - taskId: - type: string - get: - responses: - 200: - body: - application/json: - type: similar-products.SimilarProductsTaskStatus - example: !include ../examples/similar-products-response.json diff --git a/api-specs/ml/ruleset.xml b/api-specs/ml/ruleset.xml deleted file mode 100644 index da3dd12a8..000000000 --- a/api-specs/ml/ruleset.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - default - - - - com.commercetools.rmf.validators.ResourcePluralRule - - - - - - - com.commercetools.rmf.validators.PropertyPluralRule - - - - - - - - - - - - - - - - com.commercetools.rmf.validators.StringPropertySingularRule - - - - - - - com.commercetools.rmf.validators.NamedStringEnumRule - - - - - - - - com.commercetools.rmf.validators.PostBodyRule - - - - - - - com.commercetools.rmf.validators.UnionTypePropertyRule - - - - - - - com.commercetools.rmf.validators.DatetimeRule - - - - - - diff --git a/api-specs/ml/securitySchemes/oauth2.raml b/api-specs/ml/securitySchemes/oauth2.raml deleted file mode 100644 index e0ee804e9..000000000 --- a/api-specs/ml/securitySchemes/oauth2.raml +++ /dev/null @@ -1,49 +0,0 @@ -#%RAML 1.0 SecurityScheme - -description: | - HTTP API authorization uses [OAuth2](https://datatracker.ietf.org/doc/html/rfc6750){:target="_blank"}. - - Clients must obtain an access token from the auth service using one of - the authorization flows described below, before they are able to make authorized requests - to other SPHERE.IO services. On successful completion of an authorization flow, - a client will be given an `access_token`, which they need to include in requests - to authorized service endpoints via the HTTP `Authorization` header like this: -type: OAuth 2.0 -describedBy: - headers: - Authorization: - description: | - On successful completion of an authorization flow, - a client will be given an `access_token`, which they need to include in requests - to authorized service endpoints via the HTTP `Authorization` header like this: - - Authorization: Bearer {access_token} - type: string - responses: - 401: - description: Unauthorized -settings: - authorizationUri: https://auth.sphere.io/oauth/token - accessTokenUri: https://auth.sphere.io/oauth/token - authorizationGrants: [client_credentials] - scopes: - - 'manage_project:{projectKey}' - - 'manage_products:{projectKey}' - - 'view_products:{projectKey}' - - 'manage_orders:{projectKey}' - - 'view_orders:{projectKey}' - - 'manage_customers:{projectKey}' - - 'view_customers:{projectKey}' - - 'manage_payments:{projectKey}' - - 'view_payments:{projectKey}' - - 'manage_subscriptions:{projectKey}' - - 'manage_extensions:{projectKey}' - - 'manage_customers:{projectKey}' - - 'view_customers:{projectKey}' - - 'manage_types:{projectKey}' - - 'view_types:{projectKey}' - - 'view_shopping_lists:{projectKey}' - - 'manage_shopping_lists:{projectKey}' - - 'manage_my_orders:{projectKey}' - - 'manage_my_profile:{projectKey}' - - 'view_project_settings:{projectKey}' diff --git a/api-specs/ml/securitySchemes/oauth2_anonymous.raml b/api-specs/ml/securitySchemes/oauth2_anonymous.raml deleted file mode 100644 index 9a957b800..000000000 --- a/api-specs/ml/securitySchemes/oauth2_anonymous.raml +++ /dev/null @@ -1,46 +0,0 @@ -#%RAML 1.0 SecurityScheme - -description: | - HTTP API authorization uses [OAuth2](https://datatracker.ietf.org/doc/html/rfc6750){:target="_blank"}. - - Clients must obtain an access token from the auth service using one of - the authorization flows described below, before they are able to make authorized requests - to other SPHERE.IO services. On successful completion of an authorization flow, - a client will be given an `access_token`, which they need to include in requests - to authorized service endpoints via the HTTP `Authorization` header like this: -type: OAuth 2.0 -describedBy: - headers: - Authorization: - description: | - On successful completion of an authorization flow, - a client will be given an `access_token`, which they need to include in requests - to authorized service endpoints via the HTTP `Authorization` header like this: - - Authorization: Bearer {access_token} - type: string - responses: - 401: - description: Unauthorized -settings: - authorizationUri: https://auth.sphere.io/oauth/{projectKey}/anonymous/token - accessTokenUri: https://auth.sphere.io/oauth/{projectKey}/anonymous/token - authorizationGrants: [client_credentials] - scopes: - - 'manage_project:{projectKey}' - - 'manage_products:{projectKey}' - - 'view_products:{projectKey}' - - 'manage_orders:{projectKey}' - - 'view_orders:{projectKey}' - - 'manage_customers:{projectKey}' - - 'view_customers:{projectKey}' - - 'manage_payments:{projectKey}' - - 'view_payments:{projectKey}' - - 'manage_subscriptions:{projectKey}' - - 'view_subscriptions:{projectKey}' - - 'manage_customers:{projectKey}' - - 'view_customers:{projectKey}' - - 'manage_types:{projectKey}' - - 'view_types:{projectKey}' - - 'manage_my_orders:{projectKey}' - - 'manage_my_profile:{projectKey}' diff --git a/api-specs/ml/securitySchemes/oauth2_password.raml b/api-specs/ml/securitySchemes/oauth2_password.raml deleted file mode 100644 index c2bcd9255..000000000 --- a/api-specs/ml/securitySchemes/oauth2_password.raml +++ /dev/null @@ -1,46 +0,0 @@ -#%RAML 1.0 SecurityScheme - -description: | - HTTP API authorization uses [OAuth2](https://datatracker.ietf.org/doc/html/rfc6750){:target="_blank"}. - - Clients must obtain an access token from the auth service using one of - the authorization flows described below, before they are able to make authorized requests - to other SPHERE.IO services. On successful completion of an authorization flow, - a client will be given an `access_token`, which they need to include in requests - to authorized service endpoints via the HTTP `Authorization` header like this: -type: OAuth 2.0 -describedBy: - headers: - Authorization: - description: | - On successful completion of an authorization flow, - a client will be given an `access_token`, which they need to include in requests - to authorized service endpoints via the HTTP `Authorization` header like this: - - Authorization: Bearer {access_token} - type: string - responses: - 401: - description: Unauthorized -settings: - authorizationUri: https://auth.sphere.io/oauth/{projectKey}/customers/token - accessTokenUri: https://auth.sphere.io/oauth/{projectKey}/customers/token - authorizationGrants: [password] - scopes: - - 'manage_project:{projectKey}' - - 'manage_products:{projectKey}' - - 'view_products:{projectKey}' - - 'manage_orders:{projectKey}' - - 'view_orders:{projectKey}' - - 'manage_customers:{projectKey}' - - 'view_customers:{projectKey}' - - 'manage_payments:{projectKey}' - - 'view_payments:{projectKey}' - - 'manage_subscriptions:{projectKey}' - - 'view_subscriptions:{projectKey}' - - 'manage_customers:{projectKey}' - - 'view_customers:{projectKey}' - - 'manage_types:{projectKey}' - - 'view_types:{projectKey}' - - 'manage_my_orders:{projectKey}' - - 'manage_my_profile:{projectKey}' diff --git a/api-specs/ml/securitySchemes/oauth2_refresh.raml b/api-specs/ml/securitySchemes/oauth2_refresh.raml deleted file mode 100644 index e843b394a..000000000 --- a/api-specs/ml/securitySchemes/oauth2_refresh.raml +++ /dev/null @@ -1,46 +0,0 @@ -#%RAML 1.0 SecurityScheme - -description: | - HTTP API authorization uses [OAuth2](https://datatracker.ietf.org/doc/html/rfc6750){:target="_blank"}. - - Clients must obtain an access token from the auth service using one of - the authorization flows described below, before they are able to make authorized requests - to other SPHERE.IO services. On successful completion of an authorization flow, - a client will be given an `access_token`, which they need to include in requests - to authorized service endpoints via the HTTP `Authorization` header like this: -type: OAuth 2.0 -describedBy: - headers: - Authorization: - description: | - On successful completion of an authorization flow, - a client will be given an `access_token`, which they need to include in requests - to authorized service endpoints via the HTTP `Authorization` header like this: - - Authorization: Bearer {access_token} - type: string - responses: - 401: - description: Unauthorized -settings: - authorizationUri: https://auth.sphere.io/oauth/token - accessTokenUri: https://auth.sphere.io/oauth/token - authorizationGrants: [refresh_token] - scopes: - - 'manage_project:{projectKey}' - - 'manage_products:{projectKey}' - - 'view_products:{projectKey}' - - 'manage_orders:{projectKey}' - - 'view_orders:{projectKey}' - - 'manage_customers:{projectKey}' - - 'view_customers:{projectKey}' - - 'manage_payments:{projectKey}' - - 'view_payments:{projectKey}' - - 'manage_subscriptions:{projectKey}' - - 'view_subscriptions:{projectKey}' - - 'manage_customers:{projectKey}' - - 'view_customers:{projectKey}' - - 'manage_types:{projectKey}' - - 'view_types:{projectKey}' - - 'manage_my_orders:{projectKey}' - - 'manage_my_profile:{projectKey}' diff --git a/api-specs/ml/types/annotations.raml b/api-specs/ml/types/annotations.raml deleted file mode 100644 index 59fb17f35..000000000 --- a/api-specs/ml/types/annotations.raml +++ /dev/null @@ -1,55 +0,0 @@ -#%RAML 1.0 Library -usage: Generator annotation types. - -annotationTypes: - asMap: - type: object - properties: - key: string - value: string - package: - description: | - Allows to specify a target package for a generator for a RAML library. - This package name should be a language indepedent logical name (e.g. "products"), which a generator then uses to - generate a language specific package name (e.g. "com.myapi.jvm.products") from its configuration. - allowedTargets: - - Library - type: string - enumDescriptions: - description: | - Allows to describe the values of an enum type. - type: object - properties: - //: - description: | - Adds a description for the enum value given by the key. - type: string - updateType: - type: string - allowedTargets: TypeDeclaration - identifier: - type: boolean - allowedTargets: TypeDeclaration - abstract: - type: boolean - allowedTargets: TypeDeclaration - methodName: - type: string - markDeprecated: - type: boolean - allowedTargets: - - Resource - - TypeDeclaration - deprecated: - type: boolean - allowedTargets: - - Resource - - TypeDeclaration - products: - allowedTargets: - - API - type: array - items: - type: string - beta: - type: boolean diff --git a/api-specs/ml/types/category-recommendations.raml b/api-specs/ml/types/category-recommendations.raml deleted file mode 100644 index ae7ffadb3..000000000 --- a/api-specs/ml/types/category-recommendations.raml +++ /dev/null @@ -1,61 +0,0 @@ -#%RAML 1.0 Library -usage: Category recommendations types -(annotations.package): category-recommendations - -uses: - common: ./common.raml - annotations: ./annotations.raml - -types: - ProjectCategoryRecommendation: - properties: - category: - description: A category that is recommended for a product. - type: common.CategoryReference - confidence: - description: Probability score for the category recommendation. - type: number - format: float - path: - type: string - description: - Breadcrumb path to the recommended category. This only picks up one - language, not all available languages for the category. English is - prioritized, but if English data is not available, an arbitrary - language is selected. Do not use this to identify a category,use the - category ID from the category reference instead. - ProjectCategoryRecommendationMeta: - properties: - productName: - type: string - required: false - description: The product name that was used to generate recommendations. - productImageUrl: - type: string - required: false - description: The product image that was used to generate recommendations. - generalCategoryNames: - type: string[] - description: - Top 5 general categories that were used internally to generate the - project-specific categories. These category names are not related to - the categories defined in the project, but they provide additional - information to understand the project-specific categories in the - results section. - ProjectCategoryRecommendationPagedQueryResponse: - properties: - count: - type: number - format: int64 - total: - type: number - format: int64 - offset: - type: number - format: int64 - description: | - Number of [elements skipped](/../api/general-concepts#offset). - results: - type: ProjectCategoryRecommendation[] - meta: - type: ProjectCategoryRecommendationMeta diff --git a/api-specs/ml/types/common.raml b/api-specs/ml/types/common.raml deleted file mode 100644 index 4bba73c42..000000000 --- a/api-specs/ml/types/common.raml +++ /dev/null @@ -1,112 +0,0 @@ -#%RAML 1.0 Library -usage: Common data types. -(annotations.package): common - -uses: - annotations: ./annotations.raml - -types: - LocalizedString: - (annotations.asMap): - key: string - value: string - properties: - /^[a-z]{2}(-[A-Z]{2})?$/: - type: string - - CurrencyCode: - type: string - description: | - The currency code compliant to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - pattern: ^[A-Z]{3}$ - - Money: - properties: - centAmount: - type: number - format: int64 - currencyCode: - type: CurrencyCode - - ReferenceTypeId: - type: string - enum: - - cart - - cart-discount - - category - - channel - - customer - - customer-group - - discount-code - - key-value-document - - payment - - product - - product-type - - product-discount - - order - - review - - shopping-list - - shipping-method - - state - - store - - tax-category - - type - - zone - - inventory-entry - - order-edit - - Reference: - type: object - discriminator: typeId - properties: - typeId: - type: ReferenceTypeId - id: - type: string - - CategoryReference: - type: Reference - discriminatorValue: category - - ProductReference: - type: Reference - discriminatorValue: product - - ProductTypeReference: - type: Reference - discriminatorValue: product-type - - ProductVariant: - description: The product variant that contains the image. - properties: - product: - description: The product that contains this variant. - type: ProductReference - required: true - staged: - description: The state of the product variant. - type: boolean - required: true - variantId: - description: The id of the product variant. - type: number - format: int32 - required: true - - TaskStatusEnum: - type: string - enum: - - PENDING - - SUCCESS - - TaskToken: - description: - Represents a URL path to poll to get the results of an Asynchronous - Request. - properties: - taskId: - description: The ID for the task. Used to find the status of the task. - type: string - uriPath: - description: The URI path to poll for the status of the task. - type: string diff --git a/api-specs/ml/types/general-recommendations.raml b/api-specs/ml/types/general-recommendations.raml deleted file mode 100644 index 0505dbc97..000000000 --- a/api-specs/ml/types/general-recommendations.raml +++ /dev/null @@ -1,33 +0,0 @@ -#%RAML 1.0 Library -usage: General Category recommendations types -(annotations.package): general-category-recommendations - -uses: - common: ./common.raml - annotations: ./annotations.raml - -types: - GeneralCategoryRecommendation: - properties: - categoryName: - description: An English category name that is recommended for a product. - type: string - confidence: - description: Probability score for the category recommendation. - type: number - format: float - GeneralCategoryRecommendationPagedQueryResponse: - properties: - count: - type: number - format: int64 - total: - type: number - format: int64 - offset: - type: number - format: int64 - description: | - Number of [elements skipped](/../api/general-concepts#offset). - results: - type: GeneralCategoryRecommendation[] diff --git a/api-specs/ml/types/image-search-config.raml b/api-specs/ml/types/image-search-config.raml deleted file mode 100644 index 95a0bb6c7..000000000 --- a/api-specs/ml/types/image-search-config.raml +++ /dev/null @@ -1,39 +0,0 @@ -#%RAML 1.0 Library - -usage: Image search config endpoint -(annotations.package): image-search-config - -uses: - common: ./common.raml - annotations: ./annotations.raml - -types: - ImageSearchConfigStatus: - type: string - enum: - - 'on' - - 'off' - ImageSearchConfigUpdateAction: - discriminator: action - properties: - action: - type: string - - ChangeStatusUpdateAction: - type: ImageSearchConfigUpdateAction - discriminatorValue: changeStatus - properties: - status: - type: ImageSearchConfigStatus - - ImageSearchConfigRequest: - properties: - actions: - description: The list of update actions to be performed on the project. - type: ImageSearchConfigUpdateAction[] - ImageSearchConfigResponse: - properties: - status: - type: ImageSearchConfigStatus - description: The image search activation status. - lastModifiedAt: datetime diff --git a/api-specs/ml/types/image-search.raml b/api-specs/ml/types/image-search.raml deleted file mode 100644 index 110791bad..000000000 --- a/api-specs/ml/types/image-search.raml +++ /dev/null @@ -1,55 +0,0 @@ -#%RAML 1.0 Library -usage: Image search types -(annotations.package): image-search - -uses: - common: ./common.raml - annotations: ./annotations.raml - -types: - ImageSearchRequest: - type: file - description: | - Image file in .png, .jpg, .gif or .bmp format. Optimal dimensions are 224x224px. - Larger images will be scaled before search so that the largest - dimension matches 224px. - ImageSearchResponse: - description: | - Response format from image search endpoint. - properties: - count: - type: number - format: int32 - required: true - description: The maximum number of results to return from a query. - offset: - type: number - required: true - description: | - Number of [elements skipped](/../api/general-concepts#offset). - default: 0 - total: - type: number - format: int32 - required: true - description: The total number of product images that were have been analyzed. - results: - type: ResultItem[] - description: - An array of image URLs of images that are similar to the query image. - If no matching images are found, results is empty. - required: true - example: !include ../examples/image-search.json - ResultItem: - description: - An image URL and the product variants it is contained in. If no matching - images are found, ResultItem is not present. - properties: - imageUrl: - type: string - required: true - description: The URL of the image. - productVariants: - type: common.ProductVariant[] - required: true - description: An array of product variants containing the image URL. diff --git a/api-specs/ml/types/missing-data.raml b/api-specs/ml/types/missing-data.raml deleted file mode 100644 index 754dbadef..000000000 --- a/api-specs/ml/types/missing-data.raml +++ /dev/null @@ -1,512 +0,0 @@ -#%RAML 1.0 Library -usage: Missing data types -(annotations.package): missing-data - -uses: - common: ./common.raml - annotations: ./annotations.raml - -types: - AttributeCount: - (annotations.deprecated): true - (annotations.beta): true - properties: - productTypeAttributes: - description: Number of attributes defined in the product type. - type: number - format: int32 - variantAttributes: - description: Number of attributes defined in the variant. - type: number - format: int32 - missingAttributeValues: - description: Number of attributes missing values in the variant. - type: number - format: int32 - - AttributeCoverage: - (annotations.deprecated): true - (annotations.beta): true - properties: - names: - description: - The percentage of attributes from the product type defined in the - product variant. A value of `1.0` indicates a product variant contains - all attributes defined in the product type. - type: number - format: float - values: - description: - Represents the percentage of attributes in the product variant that - contain values. - type: number - format: float - - MissingAttributesDetails: - (annotations.deprecated): true - (annotations.beta): true - properties: - total: - description: Number of products scanned. - type: number - format: int32 - missingAttributeNames: - description: Number of products missing attribute names. - type: number - format: int32 - missingAttributeValues: - description: Number of products missing attribute values. - type: number - format: int32 - - MissingAttributes: - (annotations.deprecated): true - (annotations.beta): true - properties: - product: - type: common.ProductReference - productType: - type: common.ProductTypeReference - variantId: - description: ID of a ProductVariant. - type: number - format: int32 - missingAttributeValues: - description: - The names of the attributes of the product type that the variant is - missing, sorted by attribute importance in descending order. - type: string[] - missingAttributeNames?: - description: - The names of the attributes of the product type that the variant is - missing, sorted by attribute importance in descending order. - type: string[] - attributeCount?: - type: AttributeCount - attributeCoverage?: - type: AttributeCoverage - - MissingAttributesMeta: - (annotations.deprecated): true - (annotations.beta): true - properties: - productLevel: - type: MissingAttributesDetails - variantLevel: - type: MissingAttributesDetails - productTypeIds?: - description: The IDs of the product types containing the requested `attributeName`. - type: string[] - - MissingAttributesSearchRequest: - (annotations.deprecated): true - (annotations.beta): true - properties: - limit?: - type: number - format: int32 - description: | - Number of [results requested](/../api/general-concepts#limit). - offset?: - type: number - format: int32 - description: | - Number of [elements skipped](/../api/general-concepts#offset). - staged?: - description: - If true, searches data from staged products in addition to published - products. - type: boolean - default: false - productSetLimit?: - type: number - format: int32 - default: 100000 - description: Maximum number of products to scan. - includeVariants?: - description: - If true, searches all product variants. If false, only searches master - variants. - type: boolean - coverageMin?: - description: - Minimum attribute coverage of variants to display, applied to both - coverage types. - type: number - format: float - coverageMax?: - description: - Maximum attribute coverage of variants to display, applied to both - coverage types. - type: number - format: float - sortBy?: - description: | - Default value: `coverageAttributeValues` - Allowed values: [`coverageAttributeValues`, `coverageAttributeNames`] - `coverageAttributeValues` shows the product variants with the most missing attribute values first and `coverageAttributeNames` the ones with the most missing attribute names. - type: string - showMissingAttributeNames?: - description: If true, the `missingAttributeNames` will be included in the results. - type: boolean - productIds?: - description: | - Filters results by the provided Product IDs. - Cannot be applied in combination with any other filter. - type: string[] - productTypeIds?: - description: | - Filters results by the provided product type IDs. - Cannot be applied in combination with any other filter. - type: string[] - attributeName?: - description: | - Filters results by the provided attribute name. If provided, products are only checked for this attribute. Therefore, only products of product types which define the attribute name are considered. These product type IDs - are then listed in `MissingAttributesMeta`. The `attributeCount` and `attributeCoverage` fields are not part of the response when using this filter. Cannot be applied in combination with any other filter. - type: string - MissingAttributesPagedQueryResult: - (annotations.deprecated): true - (annotations.beta): true - properties: - count: - type: number - format: int64 - total: - type: number - format: int64 - offset: - type: number - format: int64 - description: | - Number of [elements skipped](/../api/general-concepts#offset). - results: - type: MissingAttributes[] - meta: - type: MissingAttributesMeta - - MissingDataTaskStatus: - (annotations.deprecated): true - (annotations.beta): true - description: - Represents a URL path to poll to get the results of an Asynchronous - Request. - properties: - state: common.TaskStatusEnum - expires: - description: | - The expiry date of the result. You cannot access the result after the expiry date. Default: 1 day after the result first becomes available. This is only available when the TaskStatus state is SUCCESS. - type: datetime - result: - description: - The response to an asynchronous request. The type depends on the - request initiated. Only populated when the status is `SUCCESS`. - type: MissingAttributesPagedQueryResult - ## Missing image section - MissingImages: - (annotations.deprecated): true - (annotations.beta): true - properties: - product: common.ProductReference - variantId: - description: ID of the variant - type: number - format: int64 - imageCount: - description: Number of images the variant contains. - type: number - format: int64 - - MissingImagesCount: - (annotations.deprecated): true - (annotations.beta): true - properties: - missingImages: - type: number - format: int64 - total: - description: Number of products scanned. - type: number - format: int64 - - MissingImagesProductLevel: - (annotations.deprecated): true - (annotations.beta): true - type: MissingImagesCount - properties: - missingImages: - description: Number of products missing images. - type: number - format: int64 - total: - description: Number of products scanned. - type: number - format: int64 - - MissingImagesVariantLevel: - (annotations.deprecated): true - (annotations.beta): true - type: MissingImagesCount - properties: - missingImages: - description: Number of product variants missing images. - type: number - format: int64 - total: - description: Number of products scanned. - type: number - format: int64 - - MissingImagesMeta: - (annotations.deprecated): true - (annotations.beta): true - properties: - productLevel: MissingImagesProductLevel - variantLevel: MissingImagesVariantLevel - threshold: - description: - The minimum number of images a product variant must have. Anything - below this value is considered a product variant with missing images. - type: number - format: int64 - - MissingImagesSearchRequest: - (annotations.deprecated): true - (annotations.beta): true - properties: - limit?: - type: number - format: int64 - description: | - Number of [results requested](/../api/general-concepts#limit). - offset?: - type: number - format: int64 - description: | - Number of [elements skipped](/../api/general-concepts#offset). - staged?: - description: - If true, searches data from staged products in addition to published - products. - type: boolean - default: false - productSetLimit?: - description: Maximum number of products to scan. - type: number - format: int64 - includeVariants?: - description: - If true, searches all product variants. If false, only searches master - variants. - type: boolean - default: true - autoThreshold?: - description: - If true, uses the median number of images per product variant as a - threshold value. - type: boolean - default: false - threshold?: - description: - The minimum number of images a product variant must have. Anything - below this value is considered a product variant with missing images. - type: number - format: int64 - productIds?: - description: - Filters results by the provided Product IDs. Cannot be applied in - combination with any other filter. - type: string[] - productTypeIds?: - description: - Filters results by the provided product type IDs. It cannot be applied - in combination with any other filter. - type: string[] - MissingImagesPagedQueryResult: - (annotations.deprecated): true - (annotations.beta): true - properties: - count: - type: number - format: int64 - total: - type: number - format: int64 - offset: - type: number - format: int64 - description: | - Number of [elements skipped](/../api/general-concepts#offset). - results: - type: MissingImages[] - meta: - type: MissingImagesMeta - MissingImagesTaskStatus: - (annotations.deprecated): true - (annotations.beta): true - description: - Represents a URL path to poll to get the results of an Asynchronous - Request. - properties: - state: common.TaskStatusEnum - expires: - description: | - The expiry date of the result. You cannot access the result after the expiry date. Default: 1 day after the result first becomes available. This is only available when the TaskStatus state is SUCCESS. - type: datetime - result: - description: - The response to an asynchronous request. The type depends on the - request initiated. Only populated when the status is `SUCCESS`. - type: MissingImagesPagedQueryResult - - # Missing prices section - MissingPrices: - (annotations.deprecated): true - (annotations.beta): true - properties: - product: common.ProductReference - variantId: - description: Id of the `ProductVariant`. - type: number - format: int64 - MissingPricesProductCount: - (annotations.deprecated): true - (annotations.beta): true - properties: - total: - type: number - format: int64 - missingPrices: - type: number - format: int64 - MissingPricesProductLevel: - (annotations.deprecated): true - (annotations.beta): true - type: MissingPricesProductCount - properties: - total: - description: Number of products scanned. - type: number - format: int64 - missingPrices: - description: Number of products missing prices. - type: number - format: int64 - - MissingPricesVariantLevel: - (annotations.deprecated): true - (annotations.beta): true - type: MissingPricesProductCount - properties: - total: - description: Number of product variants scanned. - type: number - format: int64 - missingPrices: - description: Number of product variants missing prices. - type: number - format: int64 - MissingPricesMeta: - (annotations.deprecated): true - (annotations.beta): true - properties: - productLevel: MissingPricesProductLevel - variantLevel: MissingPricesVariantLevel - - MissingPricesSearchRequest: - (annotations.deprecated): true - (annotations.beta): true - properties: - limit?: - type: number - format: int64 - description: | - Number of [results requested](/../api/general-concepts#limit). - offset?: - type: number - format: int64 - description: | - Number of [elements skipped](/../api/general-concepts#offset). - staged?: - description: - If true, searches data from staged products in addition to published - products. - type: boolean - default: false - productSetLimit?: - description: Maximum number of products to scan. - type: number - format: int64 - default: 10000 - includeVariants?: - description: - If true, searches all product variants. If false, only searches master - variants. - type: boolean - default: true - currencyCode?: - type: string - description: - If used, only checks if a product variant has a price in the provided - currency code. - checkDate?: - type: boolean - default: false - description: - If true, checks if there are prices for the specified date range and - time. - validFrom?: - type: datetime - description: - Starting date of the range to check. If no value is given, checks - prices valid at the time the search is initiated. - validUntil?: - type: datetime - description: - Ending date of the range to check. If no value is given, it is equal - to `validFrom`. - productIds?: - description: - Filters results by the provided Product IDs. Cannot be applied in - combination with the `productTypeIds` filter. - type: string[] - productTypeIds?: - description: - Filters results by the provided product type IDs. Cannot be applied in - combination with the `productIds` filter. - type: string[] - - MissingPricesPagedQueryResult: - (annotations.deprecated): true - (annotations.beta): true - properties: - count: - type: number - format: int64 - total: - type: number - format: int64 - offset: - type: number - format: int64 - description: | - Number of [elements skipped](/../api/general-concepts#offset). - results: - type: MissingPrices[] - meta: - type: MissingPricesMeta - MissingPricesTaskStatus: - (annotations.deprecated): true - (annotations.beta): true - description: - Represents a URL path to poll to get the results of an Asynchronous - Request. - properties: - state: common.TaskStatusEnum - expires: - description: | - The expiry date of the result. You cannot access the result after the expiry date. Default: 1 day after the result first becomes available. This is only available when the TaskStatus state is SUCCESS. - type: datetime - result: - description: - The response to an asynchronous request. The type depends on the - request initiated. Only populated when the status is `SUCCESS`. - type: MissingPricesPagedQueryResult diff --git a/api-specs/ml/types/similar-products.raml b/api-specs/ml/types/similar-products.raml deleted file mode 100644 index 89db79214..000000000 --- a/api-specs/ml/types/similar-products.raml +++ /dev/null @@ -1,201 +0,0 @@ -#%RAML 1.0 Library -usage: Missing data types -(annotations.package): similar-products - -uses: - common: ./common.raml - annotations: ./annotations.raml - -types: - ProductSetSelector: - description: - A set of ProductData for comparison. If no optional attributes are - specified, all `current` ProductData are selected for comparison. - properties: - projectKey: - type: string - description: The project containing the project set. - productIds?: - type: string[] - description: - An array of Product IDs to compare. If unspecified, no Product ID - filter is applied. - productTypeIds?: - type: string[] - description: - An array of product type IDs. Only products with product types in this - array are compared. If unspecified, no product type filter is applied. - staged?: - type: boolean - description: Specifies use of staged or current product data. - default: false - includeVariants?: - type: boolean - description: - Specifies use of product variants. If set to `true`, all product - variants are compared, not just the master variant. - default: false - productSetLimit?: - type: number - format: int64 - description: - Maximum number of products to check (if unspecified, all products are - considered). Note that the maximum number of product comparisons - between two productSets is 20,000,000. This limit cannot be exceeded. - If you need a higher limit, contact https://support.commercetools.com - SimilarityMeasures: - description: - Specify which ProductData attributes to use for estimating similarity and - how to weigh them. An attribute's weight can be any whole positive - integer, starting with 0. The larger the integer, the higher its weight. - properties: - name?: - description: Importance of the `name` attribute in overall similarity. - type: number - format: int64 - default: 1 - description?: - description: Importance of the `description` attribute in overall similarity. - type: number - format: int64 - default: 1 - attribute?: - description: Importance of the `description` attribute in overall similarity. - type: number - format: int64 - default: 1 - variantCount?: - description: Importance of the number of product variants in overall similarity. - type: number - format: int64 - default: 0 - price?: - description: Importance of the `price` attribute in overall similarity. - type: number - format: int64 - default: 0 - SimilarProductSearchRequest: - properties: - limit?: - type: number - format: int64 - default: 0 - description: | - Number of [results requested](/../api/general-concepts#limit). - offset?: - type: number - format: int64 - default: 0 - description: | - Number of [elements skipped](/../api/general-concepts#offset). - language?: - description: language tag used to prioritize language for text comparisons. - type: string - default: en - currencyCode?: - type: string - default: EUR - description: - The three-digit currency code to compare prices in. When a product - has multiple prices, all prices for the product are converted to the - currency provided by the currency attribute and the median price is - calculated for comparison. Currencies are converted using the ECB - currency exchange rates at the time the request is made. Of the - currency codes, only currencies with currency exchange rates provided - by the ECB are supported. - similarityMeasures?: - type: SimilarityMeasures - description: | - `similarityMeasures` defines the attributes taken into account to measure product similarity. - productSetSelectors?: - description: Array of length 2 of ProductSetSelector - type: ProductSetSelector[] - confidenceMin?: - type: number - format: float - default: 0 - confidenceMax?: - type: number - format: float - default: 1 - SimilarProduct: - description: One part of a SimilarProductPair. Refers to a specific ProductVariant. - properties: - product?: - description: Reference to Product - type: common.ProductReference - variantId?: - type: number - format: int64 - description: ID of the ProductVariant that was compared. - meta?: - description: - Supplementary information about the data used for similarity - estimation. This information helps you understand the estimated - confidence score, but it should not be used to identify a product. - type: SimilarProductMeta - - SimilarProductMeta: - properties: - name?: - type: common.LocalizedString - description: Localized product name used for similarity estimation. - description?: - type: common.LocalizedString - description: Localized product description used for similarity estimation. - price?: - description: The product price in cents using the currency defined in - SimilarProductSearchRequest If multiple prices exist, the median value - is taken as a representative amount. - type: common.Money - variantCount?: - description: Total number of variants associated with the product. - type: number - format: int64 - SimilarProductPair: - description: A pair of SimilarProducts - properties: - confidence: - type: number - format: float - default: 0 - description: The probability of product similarity. - products: SimilarProduct[] - SimilarProductSearchRequestMeta: - properties: - similarityMeasures: - description: The SimilarityMeasures used in this search. - type: SimilarityMeasures - - SimilarProductsPagedQueryResult: - properties: - count: - type: number - format: int64 - total: - type: number - format: int64 - offset: - type: number - format: int64 - description: | - Number of [elements skipped](/../api/general-concepts#offset). - results: - type: SimilarProductPair[] - meta: - type: SimilarProductSearchRequestMeta - SimilarProductsTaskStatus: - description: - Represents a URL path to poll to get the results of an Asynchronous - Request. - properties: - state: common.TaskStatusEnum - expires?: - description: | - The expiry date of the result. You cannot access the result after the expiry date. Default: 1 day after the result first becomes available. This is only available when the TaskStatus state is SUCCESS. - type: datetime - result: - description: - The response to an asynchronous request. The type depends on the - request initiated. Only populated when the status is `SUCCESS`. - type: SimilarProductsPagedQueryResult diff --git a/api-specs/readme.md b/api-specs/readme.md index 49d3fe864..2d6d0a603 100644 --- a/api-specs/readme.md +++ b/api-specs/readme.md @@ -550,7 +550,7 @@ or (markDeprecated): true ``` -In the RAMl spec for other libraries (such as the Machine Learning API in `api-specs/ml`) use the following format: +In the RAMl spec for other libraries (such as the Connect API in `api-specs/connect`) use the following format: ```raml uses: diff --git a/oas/api/openapi.yaml b/oas/api/openapi.yaml index a25e08546..cb64c817c 100644 --- a/oas/api/openapi.yaml +++ b/oas/api/openapi.yaml @@ -9770,6 +9770,67 @@ paths: - "manage_cart_discounts:{projectKey}" - "manage_cart_discounts:{projectKey}:{storeKey}" operationId: ByProjectKeyInStoreKeyByStoreKeyCartDiscountsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true responses: "200": description: |- @@ -9777,8 +9838,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CartDiscount' + $ref: '#/components/schemas/CartDiscountPagedQueryResponse' + "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: @@ -9800,6 +9875,24 @@ paths: $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: @@ -9810,6 +9903,16 @@ paths: operationId: ByProjectKeyInStoreKeyByStoreKeyCartDiscountsPost description: |- When using the endpoint, the Store specified in the path and the Stores specified in the payload's `stores` field are added to the CartDiscount. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true requestBody: content: application/json: @@ -9825,6 +9928,20 @@ paths: schema: $ref: '#/components/schemas/CartDiscount' + "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' /{projectKey}/in-store/key={storeKey}/cart-discounts/key={key}: parameters: - name: projectKey @@ -14257,10 +14374,12 @@ paths: operationId: ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet description: |- Gets the current or staged representation of a [Product](ctp:api:type:Product) by its key from the specified [Store](ctp:api:type:Store). - If the Store has defined some languages, countries, distribution or supply Channels, + If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection, they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices) and [inventory](ctp:api:type:ProductProjectionInventoryEntries). + If [ProductSelection](ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/projects/stores#products-available-in-store) in the specified Store. + When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections. parameters: - name: staged @@ -14392,10 +14511,12 @@ paths: operationId: ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet description: |- Gets the current or staged representation of a [Product](ctp:api:type:Product) by its ID from the specified [Store](ctp:api:type:Store). - If the Store has defined some languages, countries, distribution or supply Channels, + If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection, they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices) and [inventory](ctp:api:type:ProductProjectionInventoryEntries). + If [ProductSelection](ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/projects/stores#products-available-in-store) in the specified Store. + When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections. parameters: - name: staged @@ -24305,7 +24426,7 @@ paths: - "manage_products:{projectKey}" operationId: ByProjectKeyProductsPost description: |- - To create a new Product, send a representation that is going to become the initial _staged_ representation of the new Product in the master catalog. + To create a new Product, send a representation that is going to become the initial _staged_ and _current_ representation of the new Product in the catalog. If [Price Selection](ctp:api:type:ProductPriceSelection) query parameters are provided, selected Prices will be added to the response. Produces the [ProductCreated](/projects/messages#product-created) Message. parameters: @@ -33992,7 +34113,7 @@ components: Active: "The Business Unit can be used in Carts, Orders, Quote Requests, and Quotes and can be edited.n" Inactive: "The Business Unit cannot be used in Carts, Orders, Quote Requests, and - Quotes and can only be edited using the [general endpoint](ctp:api:endpoint:/{projectKey}/me/business-units:POST).n + Quotes and can only be edited using the [general endpoint](/../api/associates-overview#through-the-general-endpoints).n Status doesn't affect inheritance. Even if a parent unit is inactive, its children remain active and can inherit role assignments.n" BusinessUnitStoreMode: @@ -38894,6 +39015,8 @@ components: ReferenceTypeId: type: "string" enum: + - approval-flow + - approval-rule - associate-role - attribute-group - business-unit @@ -38933,6 +39056,8 @@ components: - zone x-annotation-package: "Common" x-annotation-enumDescriptions: + approval-flow: "References an [ApprovalFlow](ctp:api:type:ApprovalFlow).n" + approval-rule: "References an [ApprovalRule](ctp:api:type:ApprovalRule).n" associate-role: "References an [AssociateRole](ctp:api:type:AssociateRole).n" attribute-group: "References an [AttributeGroup](ctp:api:type:AttributeGroup).n" business-unit: "References a [BusinessUnit](ctp:api:type:BusinessUnit).n" @@ -41032,7 +41157,6 @@ components: MissingTaxRateForCountry: '#/components/schemas/MissingTaxRateForCountryError' MoneyOverflow: '#/components/schemas/MoneyOverflowError' NoMatchingProductDiscountFound: '#/components/schemas/NoMatchingProductDiscountFoundError' - NotEnabled: '#/components/schemas/NotEnabledError' ObjectNotFound: '#/components/schemas/ObjectNotFoundError' OutOfStock: '#/components/schemas/OutOfStockError' OverCapacity: '#/components/schemas/OverCapacityError' @@ -41555,20 +41679,6 @@ components: type: "string" additionalProperties: type: "string" - NotEnabledError: - allOf: - - $ref: '#/components/schemas/ErrorObject' - - type: "object" - required: - - code - - message - properties: - code: - type: "string" - message: - type: "string" - additionalProperties: - type: "string" ObjectNotFoundError: allOf: - $ref: '#/components/schemas/ErrorObject' @@ -42449,7 +42559,6 @@ components: MissingTaxRateForCountry: '#/components/schemas/GraphQLMissingTaxRateForCountryError' MoneyOverflow: '#/components/schemas/GraphQLMoneyOverflowError' NoMatchingProductDiscountFound: '#/components/schemas/GraphQLNoMatchingProductDiscountFoundError' - NotEnabled: '#/components/schemas/GraphQLNotEnabledError' ObjectNotFound: '#/components/schemas/GraphQLObjectNotFoundError' OutOfStock: '#/components/schemas/GraphQLOutOfStockError' OverCapacity: '#/components/schemas/GraphQLOverCapacityError' @@ -42858,17 +42967,6 @@ components: type: "string" additionalProperties: type: "string" - GraphQLNotEnabledError: - allOf: - - $ref: '#/components/schemas/GraphQLErrorObject' - - type: "object" - required: - - code - properties: - code: - type: "string" - additionalProperties: - type: "string" GraphQLObjectNotFoundError: allOf: - $ref: '#/components/schemas/GraphQLErrorObject' @@ -62658,7 +62756,10 @@ components: AttributeReferenceTypeId: type: "string" enum: + - associate-role + - business-unit - cart + - cart-discount - category - channel - customer @@ -62673,7 +62774,10 @@ components: x-annotation-package: "ProductType" x-annotation-docs-uri: "https://docs.commercetools.com/api/projects/productTypes#attributereferencetypeid" x-annotation-enumDescriptions: + associate-role: "References a [AssociateRole](ctp:api:type:AssociateRole).n" + business-unit: "References a [BusinessUnit](ctp:api:type:BusinessUnit).n" cart: "References a [Cart](ctp:api:type:Cart).n" + cart-discount: "References a [CartDiscount](ctp:api:type:CartDiscount).n" category: "References a [Category](ctp:api:type:Category).n" channel: "References a [Channel](ctp:api:type:Channel).n" customer: "References a [Customer](ctp:api:type:Customer).n" @@ -68291,6 +68395,8 @@ components: ChangeSubscriptionResourceTypeId: type: "string" enum: + - approval-flow + - approval-rule - associate-role - business-unit - cart @@ -68328,6 +68434,8 @@ components: - zone x-annotation-package: "Subscription" x-annotation-enumDescriptions: + approval-flow: "Changes related to [ApprovalFlows](ctp:api:type:ApprovalFlow).n" + approval-rule: "Changes related to [ApprovalRules](ctp:api:type:ApprovalRule).n" associate-role: "Changes related to [AssociateRoles](ctp:api:type:AssociateRole).n" business-unit: "Changes to [BusinessUnits](ctp:api:type:BusinessUnit).n" cart: "Changes to [Carts](ctp:api:type:Cart).n" @@ -68577,6 +68685,8 @@ components: MessageSubscriptionResourceTypeId: type: "string" enum: + - approval-flow + - approval-rule - associate-role - business-unit - category @@ -68597,6 +68707,8 @@ components: - store x-annotation-package: "Subscription" x-annotation-enumDescriptions: + approval-flow: "Messages related to [ApprovalFlows](ctp:api:type:ApprovalFlow).n" + approval-rule: "Messages related to [ApprovalRules](ctp:api:type:ApprovalRule).n" associate-role: "Messages related to [AssociateRoles](ctp:api:type:AssociateRole).n" business-unit: "Messages related to [BusinessUnits](ctp:api:type:BusinessUnit).n" category: "Messages related to [Categories](ctp:api:type:Category).n" diff --git a/oas/history/openapi.yaml b/oas/history/openapi.yaml index 8f52cdb41..b227c369d 100644 --- a/oas/history/openapi.yaml +++ b/oas/history/openapi.yaml @@ -1555,15 +1555,12 @@ components: required: - change - nextValue - - previousValue - type properties: type: type: "string" change: type: "string" - previousValue: - $ref: '#/components/schemas/Address' nextValue: $ref: '#/components/schemas/Address' AddAssetChange: @@ -1656,11 +1653,11 @@ components: previousValue: type: "array" items: - $ref: '#/components/schemas/ChannelRole' + $ref: '#/components/schemas/ChannelRoleEnum' nextValue: type: "array" items: - $ref: '#/components/schemas/ChannelRole' + $ref: '#/components/schemas/ChannelRoleEnum' AddCustomLineItemChange: allOf: - $ref: '#/components/schemas/Change' @@ -1834,7 +1831,7 @@ components: change: type: "string" nextValue: - $ref: '#/components/schemas/LocalizedEnumValue' + $ref: '#/components/schemas/AttributeLocalizedEnumValue' fieldName: type: "string" attributeName: @@ -1846,15 +1843,12 @@ components: required: - change - nextValue - - previousValue - type properties: type: type: "string" change: type: "string" - previousValue: - $ref: '#/components/schemas/Location' nextValue: $ref: '#/components/schemas/Location' AddOrderLineItemChange: @@ -1926,7 +1920,7 @@ components: change: type: "string" nextValue: - $ref: '#/components/schemas/EnumValue' + $ref: '#/components/schemas/AttributePlainEnumValue' attributeName: type: "string" AddPriceChange: @@ -2079,11 +2073,11 @@ components: previousValue: type: "array" items: - $ref: '#/components/schemas/StateRole' + $ref: '#/components/schemas/StateRoleEnum' nextValue: type: "array" items: - $ref: '#/components/schemas/StateRole' + $ref: '#/components/schemas/StateRoleEnum' AddTaxRateChange: allOf: - $ref: '#/components/schemas/Change' @@ -2390,6 +2384,26 @@ components: $ref: '#/components/schemas/TextInputHint' isSearchable: type: "boolean" + AttributeLocalizedEnumValue: + type: "object" + required: + - key + - label + properties: + key: + type: "string" + label: + $ref: '#/components/schemas/LocalizedString' + AttributePlainEnumValue: + type: "object" + required: + - key + - label + properties: + key: + type: "string" + label: + type: "string" AttributeType: type: "object" required: @@ -3580,9 +3594,9 @@ components: change: type: "string" previousValue: - $ref: '#/components/schemas/StateType' + $ref: '#/components/schemas/StateTypeEnum' nextValue: - $ref: '#/components/schemas/StateType' + $ref: '#/components/schemas/StateTypeEnum' ChangeStatusChange: allOf: - $ref: '#/components/schemas/Change' @@ -3964,7 +3978,7 @@ components: permyriad: type: "integer" format: "int32" - ChannelRole: + ChannelRoleEnum: type: "string" enum: - InventorySupply @@ -4904,11 +4918,11 @@ components: previousValue: type: "array" items: - $ref: '#/components/schemas/ChannelRole' + $ref: '#/components/schemas/ChannelRoleEnum' nextValue: type: "array" items: - $ref: '#/components/schemas/ChannelRole' + $ref: '#/components/schemas/ChannelRoleEnum' RemoveCustomLineItemChange: allOf: - $ref: '#/components/schemas/Change' @@ -5097,7 +5111,6 @@ components: - type: "object" required: - change - - nextValue - previousValue - type properties: @@ -5107,8 +5120,6 @@ components: type: "string" previousValue: $ref: '#/components/schemas/Location' - nextValue: - $ref: '#/components/schemas/Location' RemoveOrderLineItemChange: allOf: - $ref: '#/components/schemas/Change' @@ -5295,18 +5306,17 @@ components: previousValue: type: "array" items: - $ref: '#/components/schemas/StateRole' + $ref: '#/components/schemas/StateRoleEnum' nextValue: type: "array" items: - $ref: '#/components/schemas/StateRole' + $ref: '#/components/schemas/StateRoleEnum' RemoveTaxRateChange: allOf: - $ref: '#/components/schemas/Change' - type: "object" required: - change - - nextValue - previousValue - type properties: @@ -5316,8 +5326,6 @@ components: type: "string" previousValue: $ref: '#/components/schemas/TaxRate' - nextValue: - $ref: '#/components/schemas/TaxRate' RemoveTextLineItemChange: allOf: - $ref: '#/components/schemas/Change' @@ -5937,11 +5945,11 @@ components: previousValue: type: "array" items: - $ref: '#/components/schemas/ChannelRole' + $ref: '#/components/schemas/ChannelRoleEnum' nextValue: type: "array" items: - $ref: '#/components/schemas/ChannelRole' + $ref: '#/components/schemas/ChannelRoleEnum' SetCompanyNameChange: allOf: - $ref: '#/components/schemas/Change' @@ -8114,11 +8122,11 @@ components: previousValue: type: "array" items: - $ref: '#/components/schemas/StateRole' + $ref: '#/components/schemas/StateRoleEnum' nextValue: type: "array" items: - $ref: '#/components/schemas/StateRole' + $ref: '#/components/schemas/StateRoleEnum' SetStatusInterfaceCodeChange: allOf: - $ref: '#/components/schemas/Change' @@ -8676,13 +8684,13 @@ components: - Sent - Closed x-annotation-package: "Common" - StateRole: + StateRoleEnum: type: "string" enum: - ReviewIncludedInStatistics - Return x-annotation-package: "Common" - StateType: + StateTypeEnum: type: "string" enum: - OrderState @@ -8690,6 +8698,9 @@ components: - ProductState - ReviewState - PaymentState + - QuoteRequestState + - StagedQuoteState + - QuoteState x-annotation-package: "Common" StoreCountry: type: "object" diff --git a/oas/import/openapi.yaml b/oas/import/openapi.yaml index 684136b09..97fb42dfa 100644 --- a/oas/import/openapi.yaml +++ b/oas/import/openapi.yaml @@ -1794,6 +1794,7 @@ components: - $ref: '#/components/schemas/ImportResource' - type: "object" required: + - key - name - productType - slug @@ -1833,6 +1834,7 @@ components: - $ref: '#/components/schemas/ImportResource' - type: "object" required: + - key - name - productType - slug @@ -2128,6 +2130,7 @@ components: - type: "object" required: - description + - key - name properties: key: @@ -2496,6 +2499,7 @@ components: - type: "object" required: - isMasterVariant + - key - product properties: key: @@ -2544,6 +2548,7 @@ components: - $ref: '#/components/schemas/ImportResource' - type: "object" required: + - key - name - slug properties: @@ -2643,6 +2648,7 @@ components: - type: "object" required: - email + - key properties: key: type: "string" @@ -3459,6 +3465,7 @@ components: - $ref: '#/components/schemas/ImportResource' - type: "object" required: + - key - quantityOnStock - sku properties: @@ -4504,6 +4511,8 @@ components: type: "string" enum: - category + - customer + - inventory - order - order-patch - price @@ -4512,12 +4521,12 @@ components: - product-type - product-variant - product-variant-patch - - customer - - inventory - standalone-price - type x-annotation-enumDescriptions: category: "The [Category import](ctp:import:type:CategoryImport) resource type." + customer: "The [Customer import](ctp:import:type:CustomerImport) resource type." + inventory: "The [Inventory import](ctp:import:type:InventoryImport) resource type." order: "The [Order import](ctp:import:type:OrderImport) resource type." order-patch: "The [Order patch import](ctp:import:type:OrderPatchImport) resource type." @@ -4531,10 +4540,9 @@ components: resource type." product-variant-patch: "The [Product Variant patch](ctp:import:type:ProductVariantPatch) resource type." - customer: "The [Customer import](ctp:import:type:CustomerImport) resource type." - inventory: "The [Inventory import](ctp:import:type:InventoryImport) resource type." standalone-price: "The [Standalone Price import](ctp:import:type:StandalonePriceImport) resource type." + type: "The [Type import](ctp:import:type:TypeImport) resource type." ReferenceType: type: "string" enum: diff --git a/oas/ml/openapi.yaml b/oas/ml/openapi.yaml deleted file mode 100644 index 1d71d6234..000000000 --- a/oas/ml/openapi.yaml +++ /dev/null @@ -1,1312 +0,0 @@ -openapi: "3.0.0" -info: - title: commercetools Composable Commerce Machine Learning API - version: "v1" - -servers: - - url: https://ml-eu.europe-west1.gcp.commercetools.com - -paths: - /{projectKey}/image-search: - description: |- - Search for similar products using an image as search input. - parameters: - - name: projectKey - in: path - required: true - schema: - type: "string" - post: - operationId: ByProjectKeyImageSearchPost - description: |- - Accepts an image file and returns similar products from product catalogue. - parameters: - - name: limit - x-annotation-default: 5 - in: query - required: false - style: form - schema: - type: "integer" - format: "int32" - explode: true - - name: offset - x-annotation-default: 0 - in: query - required: false - style: form - schema: - type: "integer" - format: "int32" - explode: true - requestBody: - content: - "*/*": - schema: - type: string - responses: - "200": - description: |- - 200 - content: - application/json: - schema: - $ref: '#/components/schemas/ImageSearchResponse' - - /{projectKey}/image-search/config: - parameters: - - name: projectKey - in: path - required: true - schema: - type: "string" - get: - operationId: ByProjectKeyImageSearchConfigGet - description: |- - Get the current image search config. - responses: - "200": - description: |- - 200 - content: - application/json: - schema: - $ref: '#/components/schemas/ImageSearchConfigResponse' - - post: - operationId: ByProjectKeyImageSearchConfigPost - description: |- - Endpoint to update the image search config. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ImageSearchConfigRequest' - - responses: - "200": - description: |- - 200 - content: - application/json: - schema: - $ref: '#/components/schemas/ImageSearchConfigResponse' - - /{projectKey}/missing-data/attributes: - parameters: - - name: projectKey - in: path - required: true - schema: - type: "string" - post: - operationId: ByProjectKeyMissingDataAttributesPost - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MissingAttributesSearchRequest' - - responses: - "202": - description: |- - 202 - content: - application/json: - schema: - $ref: '#/components/schemas/TaskToken' - - /{projectKey}/missing-data/attributes/status/{taskId}: - parameters: - - name: projectKey - in: path - required: true - schema: - type: "string" - - name: taskId - in: path - required: true - schema: - type: "string" - get: - operationId: ByProjectKeyMissingDataAttributesStatusByTaskIdGet - responses: - "200": - description: |- - 200 - content: - application/json: - schema: - $ref: '#/components/schemas/MissingDataTaskStatus' - - /{projectKey}/missing-data/images: - parameters: - - name: projectKey - in: path - required: true - schema: - type: "string" - post: - operationId: ByProjectKeyMissingDataImagesPost - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MissingImagesSearchRequest' - - responses: - "202": - description: |- - 202 - content: - application/json: - schema: - $ref: '#/components/schemas/TaskToken' - - /{projectKey}/missing-data/images/status/{taskId}: - parameters: - - name: projectKey - in: path - required: true - schema: - type: "string" - - name: taskId - in: path - required: true - schema: - type: "string" - get: - operationId: ByProjectKeyMissingDataImagesStatusByTaskIdGet - responses: - "200": - description: |- - 200 - content: - application/json: - schema: - $ref: '#/components/schemas/MissingImagesTaskStatus' - - /{projectKey}/missing-data/prices: - parameters: - - name: projectKey - in: path - required: true - schema: - type: "string" - post: - operationId: ByProjectKeyMissingDataPricesPost - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MissingPricesSearchRequest' - - responses: - "202": - description: |- - 202 - content: - application/json: - schema: - $ref: '#/components/schemas/TaskToken' - - /{projectKey}/missing-data/prices/status/{taskId}: - parameters: - - name: projectKey - in: path - required: true - schema: - type: "string" - - name: taskId - in: path - required: true - schema: - type: "string" - get: - operationId: ByProjectKeyMissingDataPricesStatusByTaskIdGet - responses: - "200": - description: |- - 200 - content: - application/json: - schema: - $ref: '#/components/schemas/MissingPricesTaskStatus' - - /{projectKey}/recommendations/general-categories: - parameters: - - name: projectKey - in: path - required: true - schema: - type: "string" - get: - operationId: ByProjectKeyRecommendationsGeneralCategoriesGet - description: |- - This endpoint takes arbitrary product names or image URLs and generates recommendations from a general set of categories, which cover a broad range of industries. The full list of supported categories can be found [here](https://docs.commercetools.com/category_recommendations_supported_categories.txt). These are independent of the categories that are actually defined in your project. The main purpose of this API is to provide a quick way to test the behavior of the category recommendations engine for different names and images. In contrast to the [project-specific endpoint](https://docs.commercetools.com/http-api-projects-categoryrecommendations#project-specific-category-recommendations), this endpoint does not have [activation criteria](https://docs.commercetools.com/http-api-projects-categoryrecommendations#activating-the-api) and is enabled for all projects. - parameters: - - name: productImageUrl - in: query - required: false - style: form - schema: - type: "string" - explode: true - - name: productName - in: query - required: true - style: form - schema: - type: "string" - explode: true - - name: limit - x-annotation-default: 3 - in: query - required: false - style: form - schema: - type: "integer" - format: "int32" - explode: true - - name: offset - x-annotation-default: 0 - in: query - required: false - style: form - schema: - type: "integer" - format: "int32" - explode: true - - name: confidenceMin - in: query - required: false - style: form - schema: - type: "number" - format: "double" - explode: true - - name: confidenceMax - in: query - required: false - style: form - schema: - type: "number" - format: "double" - explode: true - responses: - "200": - description: |- - 200 - content: - application/json: - schema: - $ref: '#/components/schemas/GeneralCategoryRecommendationPagedQueryResponse' - - /{projectKey}/recommendations/project-categories/{productId}: - parameters: - - name: projectKey - in: path - required: true - schema: - type: "string" - - name: productId - in: path - required: true - schema: - type: "string" - get: - operationId: ByProjectKeyRecommendationsProjectCategoriesByProductIdGet - description: |- - Response Representation: PagedQueryResult with a results array of ProjectCategoryrecommendation, sorted by confidence scores in descending order and the meta information of ProjectCategoryrecommendationMeta. - parameters: - - name: limit - x-annotation-default: 3 - in: query - required: false - style: form - schema: - type: "integer" - format: "int32" - explode: true - - name: offset - x-annotation-default: 0 - in: query - required: false - style: form - schema: - type: "integer" - format: "int32" - explode: true - - name: staged - in: query - required: false - style: form - schema: - type: "boolean" - explode: true - - name: confidenceMin - in: query - required: false - style: form - schema: - type: "number" - format: "double" - explode: true - - name: confidenceMax - in: query - required: false - style: form - schema: - type: "number" - format: "double" - explode: true - responses: - "200": - description: |- - 200 - content: - application/json: - schema: - $ref: '#/components/schemas/ProjectCategoryRecommendationPagedQueryResponse' - - /{projectKey}/similarities/products: - parameters: - - name: projectKey - in: path - required: true - schema: - type: "string" - post: - operationId: ByProjectKeySimilaritiesProductsPost - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SimilarProductSearchRequest' - - responses: - "202": - description: |- - 202 - content: - application/json: - schema: - $ref: '#/components/schemas/TaskToken' - - /{projectKey}/similarities/products/status/{taskId}: - parameters: - - name: projectKey - in: path - required: true - schema: - type: "string" - - name: taskId - in: path - required: true - schema: - type: "string" - get: - operationId: ByProjectKeySimilaritiesProductsStatusByTaskIdGet - responses: - "200": - description: |- - 200 - content: - application/json: - schema: - $ref: '#/components/schemas/SimilarProductsTaskStatus' - - -components: - - securitySchemes: - oauth_2_0: - type: oauth2 - description: | - HTTP API authorization uses [OAuth2](https://datatracker.ietf.org/doc/html/rfc6750){:target="_blank"}. - - Clients must obtain an access token from the auth service using one of - the authorization flows described below, before they are able to make authorized requests - to other SPHERE.IO services. On successful completion of an authorization flow, - a client will be given an `access_token`, which they need to include in requests - to authorized service endpoints via the HTTP `Authorization` header like this: - - flows: - clientCredentials: - tokenUrl: https://auth.sphere.io/oauth/token - scopes: - "manage_project:{projectKey}": "" - "manage_products:{projectKey}": "" - "view_products:{projectKey}": "" - "manage_orders:{projectKey}": "" - "view_orders:{projectKey}": "" - "manage_customers:{projectKey}": "" - "view_customers:{projectKey}": "" - "manage_payments:{projectKey}": "" - "view_payments:{projectKey}": "" - "manage_subscriptions:{projectKey}": "" - "manage_extensions:{projectKey}": "" - "manage_types:{projectKey}": "" - "view_types:{projectKey}": "" - "view_shopping_lists:{projectKey}": "" - "manage_shopping_lists:{projectKey}": "" - "manage_my_orders:{projectKey}": "" - "manage_my_profile:{projectKey}": "" - "view_project_settings:{projectKey}": "" - - - schemas: - ProjectCategoryRecommendation: - type: "object" - required: - - category - - confidence - - path - properties: - category: - $ref: '#/components/schemas/CategoryReference' - confidence: - type: "number" - format: "double" - path: - type: "string" - ProjectCategoryRecommendationMeta: - type: "object" - required: - - generalCategoryNames - properties: - productName: - type: "string" - productImageUrl: - type: "string" - generalCategoryNames: - type: "array" - items: - type: "string" - ProjectCategoryRecommendationPagedQueryResponse: - type: "object" - required: - - count - - meta - - offset - - results - - total - properties: - count: - type: "number" - format: "double" - total: - type: "number" - format: "double" - offset: - type: "number" - format: "double" - results: - type: "array" - items: - $ref: '#/components/schemas/ProjectCategoryRecommendation' - meta: - $ref: '#/components/schemas/ProjectCategoryRecommendationMeta' - GeneralCategoryRecommendation: - type: "object" - required: - - categoryName - - confidence - properties: - categoryName: - type: "string" - confidence: - type: "number" - format: "double" - GeneralCategoryRecommendationPagedQueryResponse: - type: "object" - required: - - count - - offset - - results - - total - properties: - count: - type: "number" - format: "double" - total: - type: "number" - format: "double" - offset: - type: "number" - format: "double" - results: - type: "array" - items: - $ref: '#/components/schemas/GeneralCategoryRecommendation' - ImageSearchRequest: - {} - ImageSearchResponse: - type: "object" - required: - - count - - offset - - results - - total - properties: - count: - type: "number" - format: "double" - offset: - type: "number" - format: "double" - total: - type: "number" - format: "double" - results: - type: "array" - items: - $ref: '#/components/schemas/ResultItem' - ResultItem: - type: "object" - required: - - imageUrl - - productVariants - properties: - imageUrl: - type: "string" - productVariants: - type: "array" - items: - $ref: '#/components/schemas/ProductVariant' - ImageSearchConfigStatus: - type: "string" - enum: - - on - - off - ImageSearchConfigUpdateAction: - type: "object" - discriminator: - propertyName: action - mapping: - changeStatus: '#/components/schemas/ChangeStatusUpdateAction' - required: - - action - properties: - action: - type: "string" - ChangeStatusUpdateAction: - allOf: - - $ref: '#/components/schemas/ImageSearchConfigUpdateAction' - - type: "object" - required: - - status - properties: - action: - type: "string" - status: - $ref: '#/components/schemas/ImageSearchConfigStatus' - ImageSearchConfigRequest: - type: "object" - required: - - actions - properties: - actions: - type: "array" - items: - $ref: '#/components/schemas/ImageSearchConfigUpdateAction' - ImageSearchConfigResponse: - type: "object" - required: - - lastModifiedAt - - status - properties: - status: - $ref: '#/components/schemas/ImageSearchConfigStatus' - lastModifiedAt: - type: "string" - format: "datetime" - AttributeCount: - type: "object" - required: - - missingAttributeValues - - productTypeAttributes - - variantAttributes - properties: - productTypeAttributes: - type: "number" - format: "double" - variantAttributes: - type: "number" - format: "double" - missingAttributeValues: - type: "number" - format: "double" - AttributeCoverage: - type: "object" - required: - - names - - values - properties: - names: - type: "number" - format: "double" - values: - type: "number" - format: "double" - MissingAttributesDetails: - type: "object" - required: - - missingAttributeNames - - missingAttributeValues - - total - properties: - total: - type: "number" - format: "double" - missingAttributeNames: - type: "number" - format: "double" - missingAttributeValues: - type: "number" - format: "double" - MissingAttributes: - type: "object" - required: - - missingAttributeValues - - product - - productType - - variantId - properties: - product: - $ref: '#/components/schemas/ProductReference' - productType: - $ref: '#/components/schemas/ProductTypeReference' - variantId: - type: "number" - format: "double" - missingAttributeValues: - type: "array" - items: - type: "string" - missingAttributeNames: - type: "array" - items: - type: "string" - attributeCount: - $ref: '#/components/schemas/AttributeCount' - attributeCoverage: - $ref: '#/components/schemas/AttributeCoverage' - MissingAttributesMeta: - type: "object" - required: - - productLevel - - variantLevel - properties: - productLevel: - $ref: '#/components/schemas/MissingAttributesDetails' - variantLevel: - $ref: '#/components/schemas/MissingAttributesDetails' - productTypeIds: - type: "array" - items: - type: "string" - MissingAttributesSearchRequest: - type: "object" - properties: - limit: - type: "number" - format: "double" - offset: - type: "number" - format: "double" - staged: - type: "boolean" - productSetLimit: - type: "number" - format: "double" - includeVariants: - type: "boolean" - coverageMin: - type: "number" - format: "double" - coverageMax: - type: "number" - format: "double" - sortBy: - type: "string" - showMissingAttributeNames: - type: "boolean" - productIds: - type: "array" - items: - type: "string" - productTypeIds: - type: "array" - items: - type: "string" - attributeName: - type: "string" - MissingAttributesPagedQueryResult: - type: "object" - required: - - count - - meta - - offset - - results - - total - properties: - count: - type: "number" - format: "double" - total: - type: "number" - format: "double" - offset: - type: "number" - format: "double" - results: - type: "array" - items: - $ref: '#/components/schemas/MissingAttributes' - meta: - $ref: '#/components/schemas/MissingAttributesMeta' - MissingDataTaskStatus: - type: "object" - required: - - expires - - result - - state - properties: - state: - $ref: '#/components/schemas/TaskStatusEnum' - expires: - type: "string" - format: "datetime" - result: - $ref: '#/components/schemas/MissingAttributesPagedQueryResult' - MissingImages: - type: "object" - required: - - imageCount - - product - - variantId - properties: - product: - $ref: '#/components/schemas/ProductReference' - variantId: - type: "number" - format: "double" - imageCount: - type: "number" - format: "double" - MissingImagesCount: - type: "object" - required: - - missingImages - - total - properties: - missingImages: - type: "number" - format: "double" - total: - type: "number" - format: "double" - MissingImagesProductLevel: - allOf: - - $ref: '#/components/schemas/MissingImagesCount' - - type: "object" - required: - - missingImages - - total - properties: - missingImages: - type: "number" - format: "double" - total: - type: "number" - format: "double" - MissingImagesVariantLevel: - allOf: - - $ref: '#/components/schemas/MissingImagesCount' - - type: "object" - required: - - missingImages - - total - properties: - missingImages: - type: "number" - format: "double" - total: - type: "number" - format: "double" - MissingImagesMeta: - type: "object" - required: - - productLevel - - threshold - - variantLevel - properties: - productLevel: - $ref: '#/components/schemas/MissingImagesProductLevel' - variantLevel: - $ref: '#/components/schemas/MissingImagesVariantLevel' - threshold: - type: "number" - format: "double" - MissingImagesSearchRequest: - type: "object" - properties: - limit: - type: "number" - format: "double" - offset: - type: "number" - format: "double" - staged: - type: "boolean" - productSetLimit: - type: "number" - format: "double" - includeVariants: - type: "boolean" - autoThreshold: - type: "boolean" - threshold: - type: "number" - format: "double" - productIds: - type: "array" - items: - type: "string" - productTypeIds: - type: "array" - items: - type: "string" - MissingImagesPagedQueryResult: - type: "object" - required: - - count - - meta - - offset - - results - - total - properties: - count: - type: "number" - format: "double" - total: - type: "number" - format: "double" - offset: - type: "number" - format: "double" - results: - type: "array" - items: - $ref: '#/components/schemas/MissingImages' - meta: - $ref: '#/components/schemas/MissingImagesMeta' - MissingImagesTaskStatus: - type: "object" - required: - - expires - - result - - state - properties: - state: - $ref: '#/components/schemas/TaskStatusEnum' - expires: - type: "string" - format: "datetime" - result: - $ref: '#/components/schemas/MissingImagesPagedQueryResult' - MissingPrices: - type: "object" - required: - - product - - variantId - properties: - product: - $ref: '#/components/schemas/ProductReference' - variantId: - type: "number" - format: "double" - MissingPricesProductCount: - type: "object" - required: - - missingPrices - - total - properties: - total: - type: "number" - format: "double" - missingPrices: - type: "number" - format: "double" - MissingPricesProductLevel: - allOf: - - $ref: '#/components/schemas/MissingPricesProductCount' - - type: "object" - required: - - missingPrices - - total - properties: - total: - type: "number" - format: "double" - missingPrices: - type: "number" - format: "double" - MissingPricesVariantLevel: - allOf: - - $ref: '#/components/schemas/MissingPricesProductCount' - - type: "object" - required: - - missingPrices - - total - properties: - total: - type: "number" - format: "double" - missingPrices: - type: "number" - format: "double" - MissingPricesMeta: - type: "object" - required: - - productLevel - - variantLevel - properties: - productLevel: - $ref: '#/components/schemas/MissingPricesProductLevel' - variantLevel: - $ref: '#/components/schemas/MissingPricesVariantLevel' - MissingPricesSearchRequest: - type: "object" - properties: - limit: - type: "number" - format: "double" - offset: - type: "number" - format: "double" - staged: - type: "boolean" - productSetLimit: - type: "number" - format: "double" - includeVariants: - type: "boolean" - currencyCode: - type: "string" - checkDate: - type: "boolean" - validFrom: - type: "string" - format: "datetime" - validUntil: - type: "string" - format: "datetime" - productIds: - type: "array" - items: - type: "string" - productTypeIds: - type: "array" - items: - type: "string" - MissingPricesPagedQueryResult: - type: "object" - required: - - count - - meta - - offset - - results - - total - properties: - count: - type: "number" - format: "double" - total: - type: "number" - format: "double" - offset: - type: "number" - format: "double" - results: - type: "array" - items: - $ref: '#/components/schemas/MissingPrices' - meta: - $ref: '#/components/schemas/MissingPricesMeta' - MissingPricesTaskStatus: - type: "object" - required: - - expires - - result - - state - properties: - state: - $ref: '#/components/schemas/TaskStatusEnum' - expires: - type: "string" - format: "datetime" - result: - $ref: '#/components/schemas/MissingPricesPagedQueryResult' - LocalizedString: - type: "object" - required: - - /^[a-z]{2}(-[A-Z]{2})?$/ - additionalProperties: - type: "string" - CurrencyCode: - type: "string" - Money: - type: "object" - required: - - centAmount - - currencyCode - properties: - centAmount: - type: "number" - format: "double" - currencyCode: - $ref: '#/components/schemas/CurrencyCode' - ReferenceTypeId: - type: "string" - enum: - - cart - - cart-discount - - category - - channel - - customer - - customer-group - - discount-code - - key-value-document - - payment - - product - - product-type - - product-discount - - order - - review - - shopping-list - - shipping-method - - state - - store - - tax-category - - type - - zone - - inventory-entry - - order-edit - Reference: - type: "object" - discriminator: - propertyName: typeId - mapping: - category: '#/components/schemas/CategoryReference' - product: '#/components/schemas/ProductReference' - product-type: '#/components/schemas/ProductTypeReference' - required: - - id - - typeId - properties: - typeId: - $ref: '#/components/schemas/ReferenceTypeId' - id: - type: "string" - CategoryReference: - allOf: - - $ref: '#/components/schemas/Reference' - - type: "object" - properties: - typeId: - $ref: '#/components/schemas/ReferenceTypeId' - id: - type: "string" - ProductReference: - allOf: - - $ref: '#/components/schemas/Reference' - - type: "object" - properties: - typeId: - $ref: '#/components/schemas/ReferenceTypeId' - id: - type: "string" - ProductTypeReference: - allOf: - - $ref: '#/components/schemas/Reference' - - type: "object" - properties: - typeId: - $ref: '#/components/schemas/ReferenceTypeId' - id: - type: "string" - ProductVariant: - type: "object" - required: - - product - - staged - - variantId - properties: - product: - $ref: '#/components/schemas/ProductReference' - staged: - type: "boolean" - variantId: - type: "number" - format: "double" - TaskStatusEnum: - type: "string" - enum: - - PENDING - - SUCCESS - TaskToken: - type: "object" - required: - - taskId - - uriPath - properties: - taskId: - type: "string" - uriPath: - type: "string" - ProductSetSelector: - type: "object" - required: - - projectKey - properties: - projectKey: - type: "string" - productIds: - type: "array" - items: - type: "string" - productTypeIds: - type: "array" - items: - type: "string" - staged: - type: "boolean" - includeVariants: - type: "boolean" - productSetLimit: - type: "number" - format: "double" - SimilarityMeasures: - type: "object" - properties: - name: - type: "number" - format: "double" - description: - type: "number" - format: "double" - attribute: - type: "number" - format: "double" - variantCount: - type: "number" - format: "double" - price: - type: "number" - format: "double" - SimilarProductSearchRequest: - type: "object" - properties: - limit: - type: "number" - format: "double" - offset: - type: "number" - format: "double" - language: - type: "string" - currencyCode: - type: "string" - similarityMeasures: - $ref: '#/components/schemas/SimilarityMeasures' - productSetSelectors: - type: "array" - items: - $ref: '#/components/schemas/ProductSetSelector' - confidenceMin: - type: "number" - format: "double" - confidenceMax: - type: "number" - format: "double" - SimilarProduct: - type: "object" - properties: - product: - $ref: '#/components/schemas/ProductReference' - variantId: - type: "number" - format: "double" - meta: - $ref: '#/components/schemas/SimilarProductMeta' - SimilarProductMeta: - type: "object" - properties: - name: - $ref: '#/components/schemas/LocalizedString' - description: - $ref: '#/components/schemas/LocalizedString' - price: - $ref: '#/components/schemas/Money' - variantCount: - type: "number" - format: "double" - SimilarProductPair: - type: "object" - required: - - confidence - - products - properties: - confidence: - type: "number" - format: "double" - products: - type: "array" - items: - $ref: '#/components/schemas/SimilarProduct' - SimilarProductSearchRequestMeta: - type: "object" - required: - - similarityMeasures - properties: - similarityMeasures: - $ref: '#/components/schemas/SimilarityMeasures' - SimilarProductsPagedQueryResult: - type: "object" - required: - - count - - meta - - offset - - results - - total - properties: - count: - type: "number" - format: "double" - total: - type: "number" - format: "double" - offset: - type: "number" - format: "double" - results: - type: "array" - items: - $ref: '#/components/schemas/SimilarProductPair' - meta: - $ref: '#/components/schemas/SimilarProductSearchRequestMeta' - SimilarProductsTaskStatus: - type: "object" - required: - - result - - state - properties: - state: - $ref: '#/components/schemas/TaskStatusEnum' - expires: - type: "string" - format: "datetime" - result: - $ref: '#/components/schemas/SimilarProductsPagedQueryResult' diff --git a/uml/api/AttributeReferenceTypeId.puml b/uml/api/AttributeReferenceTypeId.puml index ec150ef56..9bea3ed0f 100644 --- a/uml/api/AttributeReferenceTypeId.puml +++ b/uml/api/AttributeReferenceTypeId.puml @@ -2,7 +2,10 @@ hide methods enum AttributeReferenceTypeId { + ASSOCIATE_ROLE + BUSINESS_UNIT CART + CART_DISCOUNT CATEGORY CHANNEL CUSTOMER diff --git a/uml/api/ChangeSubscriptionResourceTypeId.puml b/uml/api/ChangeSubscriptionResourceTypeId.puml index b424f911c..3f39e438c 100644 --- a/uml/api/ChangeSubscriptionResourceTypeId.puml +++ b/uml/api/ChangeSubscriptionResourceTypeId.puml @@ -2,6 +2,8 @@ hide methods enum ChangeSubscriptionResourceTypeId { + APPROVAL_FLOW + APPROVAL_RULE ASSOCIATE_ROLE BUSINESS_UNIT CART diff --git a/uml/api/ErrorObject.puml b/uml/api/ErrorObject.puml index 650b0e01e..4e9150df9 100644 --- a/uml/api/ErrorObject.puml +++ b/uml/api/ErrorObject.puml @@ -293,10 +293,6 @@ interface NoMatchingProductDiscountFoundError [[NoMatchingProductDiscountFoundEr code: String message: String } -interface NotEnabledError [[NotEnabledError.svg]] { - code: String - message: String -} interface ObjectNotFoundError [[ObjectNotFoundError.svg]] { code: String message: String @@ -484,7 +480,6 @@ ErrorObject --> MissingRoleOnChannelError #blue;text:blue : "code : MissingRoleO ErrorObject --> MissingTaxRateForCountryError #blue;text:blue : "code : MissingTaxRateForCountry" ErrorObject --> MoneyOverflowError #blue;text:blue : "code : MoneyOverflow" ErrorObject --> NoMatchingProductDiscountFoundError #blue;text:blue : "code : NoMatchingProductDiscountFound" -ErrorObject --> NotEnabledError #blue;text:blue : "code : NotEnabled" ErrorObject --> ObjectNotFoundError #blue;text:blue : "code : ObjectNotFound" ErrorObject --> OutOfStockError #blue;text:blue : "code : OutOfStock" ErrorObject --> OverCapacityError #blue;text:blue : "code : OverCapacity" diff --git a/uml/api/GraphQLErrorObject.puml b/uml/api/GraphQLErrorObject.puml index c66d274e5..fa54b49ef 100644 --- a/uml/api/GraphQLErrorObject.puml +++ b/uml/api/GraphQLErrorObject.puml @@ -241,9 +241,6 @@ interface GraphQLMoneyOverflowError [[GraphQLMoneyOverflowError.svg]] { interface GraphQLNoMatchingProductDiscountFoundError [[GraphQLNoMatchingProductDiscountFoundError.svg]] { code: String } -interface GraphQLNotEnabledError [[GraphQLNotEnabledError.svg]] { - code: String -} interface GraphQLObjectNotFoundError [[GraphQLObjectNotFoundError.svg]] { code: String } @@ -392,7 +389,6 @@ GraphQLErrorObject --> GraphQLMissingRoleOnChannelError #blue;text:blue : "code GraphQLErrorObject --> GraphQLMissingTaxRateForCountryError #blue;text:blue : "code : MissingTaxRateForCountry" GraphQLErrorObject --> GraphQLMoneyOverflowError #blue;text:blue : "code : MoneyOverflow" GraphQLErrorObject --> GraphQLNoMatchingProductDiscountFoundError #blue;text:blue : "code : NoMatchingProductDiscountFound" -GraphQLErrorObject --> GraphQLNotEnabledError #blue;text:blue : "code : NotEnabled" GraphQLErrorObject --> GraphQLObjectNotFoundError #blue;text:blue : "code : ObjectNotFound" GraphQLErrorObject --> GraphQLOutOfStockError #blue;text:blue : "code : OutOfStock" GraphQLErrorObject --> GraphQLOverCapacityError #blue;text:blue : "code : OverCapacity" diff --git a/uml/api/GraphQLNotEnabledError.puml b/uml/api/GraphQLNotEnabledError.puml deleted file mode 100644 index 07768d85e..000000000 --- a/uml/api/GraphQLNotEnabledError.puml +++ /dev/null @@ -1,22 +0,0 @@ -@startuml - -hide empty fields -hide empty methods -legend -|= |= line | -| | inheritance | -| | property reference | -| | discriminated class | -endlegend -interface GraphQLNotEnabledError [[GraphQLNotEnabledError.svg]] extends GraphQLErrorObject { - code: String -} -interface GraphQLErrorObject [[GraphQLErrorObject.svg]] { - code: String -} - - - - - -@enduml diff --git a/uml/api/MessageSubscriptionResourceTypeId.puml b/uml/api/MessageSubscriptionResourceTypeId.puml index fc52b8ac7..f45f718a5 100644 --- a/uml/api/MessageSubscriptionResourceTypeId.puml +++ b/uml/api/MessageSubscriptionResourceTypeId.puml @@ -2,6 +2,8 @@ hide methods enum MessageSubscriptionResourceTypeId { + APPROVAL_FLOW + APPROVAL_RULE ASSOCIATE_ROLE BUSINESS_UNIT CATEGORY diff --git a/uml/api/NotEnabledError.puml b/uml/api/NotEnabledError.puml deleted file mode 100644 index d91527cd1..000000000 --- a/uml/api/NotEnabledError.puml +++ /dev/null @@ -1,24 +0,0 @@ -@startuml - -hide empty fields -hide empty methods -legend -|= |= line | -| | inheritance | -| | property reference | -| | discriminated class | -endlegend -interface NotEnabledError [[NotEnabledError.svg]] extends ErrorObject { - code: String - message: String -} -interface ErrorObject [[ErrorObject.svg]] { - code: String - message: String -} - - - - - -@enduml diff --git a/uml/api/ReferenceTypeId.puml b/uml/api/ReferenceTypeId.puml index 8a0c13bd4..2b7042105 100644 --- a/uml/api/ReferenceTypeId.puml +++ b/uml/api/ReferenceTypeId.puml @@ -2,6 +2,8 @@ hide methods enum ReferenceTypeId { + APPROVAL_FLOW + APPROVAL_RULE ASSOCIATE_ROLE ATTRIBUTE_GROUP BUSINESS_UNIT diff --git a/uml/api/_index.puml b/uml/api/_index.puml index 04b10219c..272c9f9f8 100644 --- a/uml/api/_index.puml +++ b/uml/api/_index.puml @@ -985,7 +985,7 @@ **** /cart-discounts *****: GET responses: - [[CartDiscount.svg CartDiscount]] + [[CartDiscountPagedQueryResponse.svg CartDiscountPagedQueryResponse]] ; *****: HEAD responses: diff --git a/uml/api/svg/AttributeReferenceTypeId.svg b/uml/api/svg/AttributeReferenceTypeId.svg index afe543060..15f86d175 100644 --- a/uml/api/svg/AttributeReferenceTypeId.svg +++ b/uml/api/svg/AttributeReferenceTypeId.svg @@ -1,11 +1,14 @@ -AttributeReferenceTypeIdCARTCATEGORYCHANNELCUSTOMERKEY_VALUE_DOCUMENTORDERPRODUCTPRODUCT_TYPEREVIEWSHIPPING_METHODSTATEZONEAttributeReferenceTypename: StringreferenceTypeId:AttributeReferenceTypeIdreferenceTypeIdAttributeReferenceTypeIdASSOCIATE_ROLEBUSINESS_UNITCARTCART_DISCOUNTCATEGORYCHANNELCUSTOMERKEY_VALUE_DOCUMENTORDERPRODUCTPRODUCT_TYPEREVIEWSHIPPING_METHODSTATEZONEAttributeReferenceTypename: StringreferenceTypeId:AttributeReferenceTypeIdreferenceTypeIdChangeSubscriptionResourceTypeIdASSOCIATE_ROLEBUSINESS_UNITCARTCART_DISCOUNTCATEGORYCHANNELCUSTOMERCUSTOMER_EMAIL_TOKENCUSTOMER_GROUPCUSTOMER_PASSWORD_TOKENDISCOUNT_CODEEXTENSIONINVENTORY_ENTRYKEY_VALUE_DOCUMENTORDERORDER_EDITPAYMENTPRODUCTPRODUCT_DISCOUNTPRODUCT_PRICEPRODUCT_SELECTIONPRODUCT_TYPEQUOTEQUOTE_REQUESTREVIEWSHIPPING_METHODSHOPPING_LISTSTAGED_QUOTESTANDALONE_PRICESTATESTORESUBSCRIPTIONTAX_CATEGORYTYPEZONEChangeSubscriptionresourceTypeId:ChangeSubscriptionResourceTypeIdresourceTypeIdChangeSubscriptionResourceTypeIdAPPROVAL_FLOWAPPROVAL_RULEASSOCIATE_ROLEBUSINESS_UNITCARTCART_DISCOUNTCATEGORYCHANNELCUSTOMERCUSTOMER_EMAIL_TOKENCUSTOMER_GROUPCUSTOMER_PASSWORD_TOKENDISCOUNT_CODEEXTENSIONINVENTORY_ENTRYKEY_VALUE_DOCUMENTORDERORDER_EDITPAYMENTPRODUCTPRODUCT_DISCOUNTPRODUCT_PRICEPRODUCT_SELECTIONPRODUCT_TYPEQUOTEQUOTE_REQUESTREVIEWSHIPPING_METHODSHOPPING_LISTSTAGED_QUOTESTANDALONE_PRICESTATESTORESUBSCRIPTIONTAX_CATEGORYTYPEZONEChangeSubscriptionresourceTypeId:ChangeSubscriptionResourceTypeIdresourceTypeIdErrorObjectcode: Stringmessage: StringAnonymousIdAlreadyInUseErrorcode: Stringmessage: StringAssociateMissingPermissionErrorcode: Stringmessage: Stringassociate:CustomerResourceIdentifierbusinessUnit:BusinessUnitResourceIdentifierassociateOnBehalf:CustomerResourceIdentifierpermissions:List<Permission>AttributeDefinitionAlreadyExistsErrorcode: Stringmessage: StringconflictingProductTypeId: StringconflictingProductTypeName: StringconflictingAttributeName: StringAttributeDefinitionTypeConflictErrorcode: Stringmessage: StringconflictingProductTypeId: StringconflictingProductTypeName: StringconflictingAttributeName: StringAttributeNameDoesNotExistErrorcode: Stringmessage: StringinvalidAttributeName: StringBadGatewayErrorcode: Stringmessage: StringConcurrentModificationErrorcode: Stringmessage: StringcurrentVersion: LongContentTooLargeErrorcode: Stringmessage: StringCountryNotConfiguredInStoreErrorcode: Stringmessage: StringstoreCountries:List<String>country: StringDiscountCodeNonApplicableErrorcode: Stringmessage: StringdiscountCode: Stringreason: StringdiscountCodeId: StringvalidFrom: DateTimevalidUntil: DateTimevalidityCheckTime: DateTimeDuplicateAttributeValueErrorcode: Stringmessage: Stringattribute:AttributeDuplicateAttributeValuesErrorcode: Stringmessage: Stringattributes:List<Attribute>DuplicateEnumValuesErrorcode: Stringmessage: Stringduplicates:List<String>DuplicateFieldErrorcode: Stringmessage: Stringfield: StringduplicateValue:ObjectDuplicateFieldWithConflictingResourceErrorcode: Stringmessage: Stringfield: StringduplicateValue:ObjectconflictingResource:ReferenceDuplicatePriceKeyErrorcode: Stringmessage: StringconflictingPrice:PriceDuplicatePriceScopeErrorcode: Stringmessage: StringconflictingPrice:PriceDuplicateStandalonePriceScopeErrorcode: Stringmessage: StringconflictingStandalonePrice:StandalonePriceReferencesku: Stringcurrency: Stringcountry: StringcustomerGroup:CustomerGroupResourceIdentifierchannel:ChannelResourceIdentifiervalidFrom: DateTimevalidUntil: DateTimeDuplicateVariantValuesErrorcode: Stringmessage: StringvariantValues:VariantValuesEditPreviewFailedErrorcode: Stringmessage: Stringresult:OrderEditPreviewFailureEnumKeyAlreadyExistsErrorcode: Stringmessage: StringconflictingEnumKey: StringconflictingAttributeName: StringEnumKeyDoesNotExistErrorcode: Stringmessage: StringconflictingEnumKey: StringconflictingAttributeName: StringEnumValueIsUsedErrorcode: Stringmessage: StringEnumValuesMustMatchErrorcode: Stringmessage: StringExtensionBadResponseErrorcode: Stringmessage: StringlocalizedMessage:LocalizedStringextensionExtraInfo:ObjectextensionErrors:List<ExtensionError>extensionBody: StringextensionStatusCode: IntegerextensionId: StringextensionKey: StringExtensionNoResponseErrorcode: Stringmessage: StringextensionId: StringextensionKey: StringExtensionPredicateEvaluationFailedErrorcode: Stringmessage: StringerrorByExtension:ErrorByExtensionExtensionUpdateActionsFailedErrorcode: Stringmessage: StringlocalizedMessage:LocalizedStringextensionExtraInfo:ObjectextensionErrors:List<ExtensionError>ExternalOAuthFailedErrorcode: Stringmessage: StringFeatureRemovedErrorcode: Stringmessage: StringGeneralErrorcode: Stringmessage: StringInsufficientScopeErrorcode: Stringmessage: StringInternalConstraintViolatedErrorcode: Stringmessage: StringInvalidCredentialsErrorcode: Stringmessage: StringInvalidCurrentPasswordErrorcode: Stringmessage: StringInvalidFieldErrorcode: Stringmessage: Stringfield: StringinvalidValue:ObjectallowedValues:List<Object>InvalidInputErrorcode: Stringmessage: StringInvalidItemShippingDetailsErrorcode: Stringmessage: Stringsubject: StringitemId: StringInvalidJsonInputErrorcode: Stringmessage: StringdetailedErrorMessage: StringInvalidOperationErrorcode: Stringmessage: StringInvalidSubjectErrorcode: Stringmessage: StringInvalidTokenErrorcode: Stringmessage: StringLanguageUsedInStoresErrorcode: Stringmessage: StringMatchingPriceNotFoundErrorcode: Stringmessage: StringproductId: StringvariantId: Integercurrency: Stringcountry: StringcustomerGroup:CustomerGroupReferencechannel:ChannelReferenceMaxCartDiscountsReachedErrorcode: Stringmessage: StringMaxResourceLimitExceededErrorcode: Stringmessage: StringexceededResource:ReferenceTypeIdMaxStoreReferencesReachedErrorcode: Stringmessage: StringMissingRoleOnChannelErrorcode: Stringmessage: Stringchannel:ChannelResourceIdentifiermissingRole:ChannelRoleEnumMissingTaxRateForCountryErrorcode: Stringmessage: StringtaxCategoryId: Stringcountry: Stringstate: StringMoneyOverflowErrorcode: Stringmessage: StringNoMatchingProductDiscountFoundErrorcode: Stringmessage: StringNotEnabledErrorcode: Stringmessage: StringObjectNotFoundErrorcode: Stringmessage: StringOutOfStockErrorcode: Stringmessage: StringlineItems:List<String>skus:List<String>OverCapacityErrorcode: Stringmessage: StringOverlappingStandalonePriceValidityErrorcode: Stringmessage: StringconflictingStandalonePrice:StandalonePriceReferencesku: Stringcurrency: Stringcountry: StringcustomerGroup:CustomerGroupResourceIdentifierchannel:ChannelResourceIdentifiervalidFrom: DateTimevalidUntil: DateTimeconflictingValidFrom: DateTimeconflictingValidUntil: DateTimePendingOperationErrorcode: Stringmessage: StringPriceChangedErrorcode: Stringmessage: StringlineItems:List<String>shipping: BooleanProductAssignmentMissingErrorcode: Stringmessage: Stringproduct:ProductReferenceProductPresentWithDifferentVariantSelectionErrorcode: Stringmessage: Stringproduct:ProductReferenceexistingVariantSelection:ProductVariantSelectionProjectNotConfiguredForLanguagesErrorcode: Stringmessage: Stringlanguages:List<String>QueryComplexityLimitExceededErrorcode: Stringmessage: StringQueryTimedOutErrorcode: Stringmessage: StringReferenceExistsErrorcode: Stringmessage: StringreferencedBy:ReferenceTypeIdReferencedResourceNotFoundErrorcode: Stringmessage: StringtypeId:ReferenceTypeIdid: Stringkey: StringRequiredFieldErrorcode: Stringmessage: Stringfield: StringResourceNotFoundErrorcode: Stringmessage: StringResourceSizeLimitExceededErrorcode: Stringmessage: StringSearchDeactivatedErrorcode: Stringmessage: StringSearchExecutionFailureErrorcode: Stringmessage: StringSearchFacetPathNotFoundErrorcode: Stringmessage: StringSearchIndexingInProgressErrorcode: Stringmessage: StringSemanticErrorErrorcode: Stringmessage: StringShippingMethodDoesNotMatchCartErrorcode: Stringmessage: StringStoreCartDiscountsLimitReachedErrorcode: Stringmessage: Stringstores:List<StoreKeyReference>SyntaxErrorErrorcode: Stringmessage: StringAuthErrorResponsestatusCode: Integermessage: Stringerrors:List<ErrorObject>error: Stringerror_description: StringOrderEditPreviewFailuretype: Stringerrors:List<ErrorObject>ErrorResponsestatusCode: Integermessage: Stringerrors:List<ErrorObject>code : AnonymousIdAlreadyInUsecode : AssociateMissingPermissioncode : AttributeDefinitionAlreadyExistscode : AttributeDefinitionTypeConflictcode : AttributeNameDoesNotExistcode : BadGatewaycode : ConcurrentModificationcode : ContentTooLargecode : CountryNotConfiguredInStorecode : DiscountCodeNonApplicablecode : DuplicateAttributeValuecode : DuplicateAttributeValuescode : DuplicateEnumValuescode : DuplicateFieldcode : DuplicateFieldWithConflictingResourcecode : DuplicatePriceKeycode : DuplicatePriceScopecode : DuplicateStandalonePriceScopecode : DuplicateVariantValuescode : EditPreviewFailedcode : EnumKeyAlreadyExistscode : EnumKeyDoesNotExistcode : EnumValueIsUsedcode : EnumValuesMustMatchcode : ExtensionBadResponsecode : ExtensionNoResponsecode : ExtensionPredicateEvaluationFailedcode : ExtensionUpdateActionsFailedcode : ExternalOAuthFailedcode : FeatureRemovedcode : Generalcode : insufficient_scopecode : InternalConstraintViolatedcode : InvalidCredentialscode : InvalidCurrentPasswordcode : InvalidFieldcode : InvalidInputcode : InvalidItemShippingDetailscode : InvalidJsonInputcode : InvalidOperationcode : InvalidSubjectcode : invalid_tokencode : LanguageUsedInStorescode : MatchingPriceNotFoundcode : MaxCartDiscountsReachedcode : MaxResourceLimitExceededcode : MaxStoreReferencesReachedcode : MissingRoleOnChannelcode : MissingTaxRateForCountrycode : MoneyOverflowcode : NoMatchingProductDiscountFoundcode : NotEnabledcode : ObjectNotFoundcode : OutOfStockcode : OverCapacitycode : OverlappingStandalonePriceValiditycode : PendingOperationcode : PriceChangedcode : ProductAssignmentMissingcode : ProductPresentWithDifferentVariantSelectioncode : ProjectNotConfiguredForLanguagescode : QueryComplexityLimitExceededcode : QueryTimedOutcode : ReferenceExistscode : ReferencedResourceNotFoundcode : RequiredFieldcode : ResourceNotFoundcode : ResourceSizeLimitExceededcode : SearchDeactivatedcode : SearchExecutionFailurecode : SearchFacetPathNotFoundcode : SearchIndexingInProgresscode : SemanticErrorcode : ShippingMethodDoesNotMatchCartcode : StoreCartDiscountsLimitReachedcode : SyntaxErrorerrorserrorserrors line   inheritance   property reference   discriminated classErrorObjectcode: Stringmessage: StringAnonymousIdAlreadyInUseErrorcode: Stringmessage: StringAssociateMissingPermissionErrorcode: Stringmessage: Stringassociate:CustomerResourceIdentifierbusinessUnit:BusinessUnitResourceIdentifierassociateOnBehalf:CustomerResourceIdentifierpermissions:List<Permission>AttributeDefinitionAlreadyExistsErrorcode: Stringmessage: StringconflictingProductTypeId: StringconflictingProductTypeName: StringconflictingAttributeName: StringAttributeDefinitionTypeConflictErrorcode: Stringmessage: StringconflictingProductTypeId: StringconflictingProductTypeName: StringconflictingAttributeName: StringAttributeNameDoesNotExistErrorcode: Stringmessage: StringinvalidAttributeName: StringBadGatewayErrorcode: Stringmessage: StringConcurrentModificationErrorcode: Stringmessage: StringcurrentVersion: LongContentTooLargeErrorcode: Stringmessage: StringCountryNotConfiguredInStoreErrorcode: Stringmessage: StringstoreCountries:List<String>country: StringDiscountCodeNonApplicableErrorcode: Stringmessage: StringdiscountCode: Stringreason: StringdiscountCodeId: StringvalidFrom: DateTimevalidUntil: DateTimevalidityCheckTime: DateTimeDuplicateAttributeValueErrorcode: Stringmessage: Stringattribute:AttributeDuplicateAttributeValuesErrorcode: Stringmessage: Stringattributes:List<Attribute>DuplicateEnumValuesErrorcode: Stringmessage: Stringduplicates:List<String>DuplicateFieldErrorcode: Stringmessage: Stringfield: StringduplicateValue:ObjectDuplicateFieldWithConflictingResourceErrorcode: Stringmessage: Stringfield: StringduplicateValue:ObjectconflictingResource:ReferenceDuplicatePriceKeyErrorcode: Stringmessage: StringconflictingPrice:PriceDuplicatePriceScopeErrorcode: Stringmessage: StringconflictingPrice:PriceDuplicateStandalonePriceScopeErrorcode: Stringmessage: StringconflictingStandalonePrice:StandalonePriceReferencesku: Stringcurrency: Stringcountry: StringcustomerGroup:CustomerGroupResourceIdentifierchannel:ChannelResourceIdentifiervalidFrom: DateTimevalidUntil: DateTimeDuplicateVariantValuesErrorcode: Stringmessage: StringvariantValues:VariantValuesEditPreviewFailedErrorcode: Stringmessage: Stringresult:OrderEditPreviewFailureEnumKeyAlreadyExistsErrorcode: Stringmessage: StringconflictingEnumKey: StringconflictingAttributeName: StringEnumKeyDoesNotExistErrorcode: Stringmessage: StringconflictingEnumKey: StringconflictingAttributeName: StringEnumValueIsUsedErrorcode: Stringmessage: StringEnumValuesMustMatchErrorcode: Stringmessage: StringExtensionBadResponseErrorcode: Stringmessage: StringlocalizedMessage:LocalizedStringextensionExtraInfo:ObjectextensionErrors:List<ExtensionError>extensionBody: StringextensionStatusCode: IntegerextensionId: StringextensionKey: StringExtensionNoResponseErrorcode: Stringmessage: StringextensionId: StringextensionKey: StringExtensionPredicateEvaluationFailedErrorcode: Stringmessage: StringerrorByExtension:ErrorByExtensionExtensionUpdateActionsFailedErrorcode: Stringmessage: StringlocalizedMessage:LocalizedStringextensionExtraInfo:ObjectextensionErrors:List<ExtensionError>ExternalOAuthFailedErrorcode: Stringmessage: StringFeatureRemovedErrorcode: Stringmessage: StringGeneralErrorcode: Stringmessage: StringInsufficientScopeErrorcode: Stringmessage: StringInternalConstraintViolatedErrorcode: Stringmessage: StringInvalidCredentialsErrorcode: Stringmessage: StringInvalidCurrentPasswordErrorcode: Stringmessage: StringInvalidFieldErrorcode: Stringmessage: Stringfield: StringinvalidValue:ObjectallowedValues:List<Object>InvalidInputErrorcode: Stringmessage: StringInvalidItemShippingDetailsErrorcode: Stringmessage: Stringsubject: StringitemId: StringInvalidJsonInputErrorcode: Stringmessage: StringdetailedErrorMessage: StringInvalidOperationErrorcode: Stringmessage: StringInvalidSubjectErrorcode: Stringmessage: StringInvalidTokenErrorcode: Stringmessage: StringLanguageUsedInStoresErrorcode: Stringmessage: StringMatchingPriceNotFoundErrorcode: Stringmessage: StringproductId: StringvariantId: Integercurrency: Stringcountry: StringcustomerGroup:CustomerGroupReferencechannel:ChannelReferenceMaxCartDiscountsReachedErrorcode: Stringmessage: StringMaxResourceLimitExceededErrorcode: Stringmessage: StringexceededResource:ReferenceTypeIdMaxStoreReferencesReachedErrorcode: Stringmessage: StringMissingRoleOnChannelErrorcode: Stringmessage: Stringchannel:ChannelResourceIdentifiermissingRole:ChannelRoleEnumMissingTaxRateForCountryErrorcode: Stringmessage: StringtaxCategoryId: Stringcountry: Stringstate: StringMoneyOverflowErrorcode: Stringmessage: StringNoMatchingProductDiscountFoundErrorcode: Stringmessage: StringObjectNotFoundErrorcode: Stringmessage: StringOutOfStockErrorcode: Stringmessage: StringlineItems:List<String>skus:List<String>OverCapacityErrorcode: Stringmessage: StringOverlappingStandalonePriceValidityErrorcode: Stringmessage: StringconflictingStandalonePrice:StandalonePriceReferencesku: Stringcurrency: Stringcountry: StringcustomerGroup:CustomerGroupResourceIdentifierchannel:ChannelResourceIdentifiervalidFrom: DateTimevalidUntil: DateTimeconflictingValidFrom: DateTimeconflictingValidUntil: DateTimePendingOperationErrorcode: Stringmessage: StringPriceChangedErrorcode: Stringmessage: StringlineItems:List<String>shipping: BooleanProductAssignmentMissingErrorcode: Stringmessage: Stringproduct:ProductReferenceProductPresentWithDifferentVariantSelectionErrorcode: Stringmessage: Stringproduct:ProductReferenceexistingVariantSelection:ProductVariantSelectionProjectNotConfiguredForLanguagesErrorcode: Stringmessage: Stringlanguages:List<String>QueryComplexityLimitExceededErrorcode: Stringmessage: StringQueryTimedOutErrorcode: Stringmessage: StringReferenceExistsErrorcode: Stringmessage: StringreferencedBy:ReferenceTypeIdReferencedResourceNotFoundErrorcode: Stringmessage: StringtypeId:ReferenceTypeIdid: Stringkey: StringRequiredFieldErrorcode: Stringmessage: Stringfield: StringResourceNotFoundErrorcode: Stringmessage: StringResourceSizeLimitExceededErrorcode: Stringmessage: StringSearchDeactivatedErrorcode: Stringmessage: StringSearchExecutionFailureErrorcode: Stringmessage: StringSearchFacetPathNotFoundErrorcode: Stringmessage: StringSearchIndexingInProgressErrorcode: Stringmessage: StringSemanticErrorErrorcode: Stringmessage: StringShippingMethodDoesNotMatchCartErrorcode: Stringmessage: StringStoreCartDiscountsLimitReachedErrorcode: Stringmessage: Stringstores:List<StoreKeyReference>SyntaxErrorErrorcode: Stringmessage: StringAuthErrorResponsestatusCode: Integermessage: Stringerrors:List<ErrorObject>error: Stringerror_description: StringOrderEditPreviewFailuretype: Stringerrors:List<ErrorObject>ErrorResponsestatusCode: Integermessage: Stringerrors:List<ErrorObject>code : AnonymousIdAlreadyInUsecode : AssociateMissingPermissioncode : AttributeDefinitionAlreadyExistscode : AttributeDefinitionTypeConflictcode : AttributeNameDoesNotExistcode : BadGatewaycode : ConcurrentModificationcode : ContentTooLargecode : CountryNotConfiguredInStorecode : DiscountCodeNonApplicablecode : DuplicateAttributeValuecode : DuplicateAttributeValuescode : DuplicateEnumValuescode : DuplicateFieldcode : DuplicateFieldWithConflictingResourcecode : DuplicatePriceKeycode : DuplicatePriceScopecode : DuplicateStandalonePriceScopecode : DuplicateVariantValuescode : EditPreviewFailedcode : EnumKeyAlreadyExistscode : EnumKeyDoesNotExistcode : EnumValueIsUsedcode : EnumValuesMustMatchcode : ExtensionBadResponsecode : ExtensionNoResponsecode : ExtensionPredicateEvaluationFailedcode : ExtensionUpdateActionsFailedcode : ExternalOAuthFailedcode : FeatureRemovedcode : Generalcode : insufficient_scopecode : InternalConstraintViolatedcode : InvalidCredentialscode : InvalidCurrentPasswordcode : InvalidFieldcode : InvalidInputcode : InvalidItemShippingDetailscode : InvalidJsonInputcode : InvalidOperationcode : InvalidSubjectcode : invalid_tokencode : LanguageUsedInStorescode : MatchingPriceNotFoundcode : MaxCartDiscountsReachedcode : MaxResourceLimitExceededcode : MaxStoreReferencesReachedcode : MissingRoleOnChannelcode : MissingTaxRateForCountrycode : MoneyOverflowcode : NoMatchingProductDiscountFoundcode : ObjectNotFoundcode : OutOfStockcode : OverCapacitycode : OverlappingStandalonePriceValiditycode : PendingOperationcode : PriceChangedcode : ProductAssignmentMissingcode : ProductPresentWithDifferentVariantSelectioncode : ProjectNotConfiguredForLanguagescode : QueryComplexityLimitExceededcode : QueryTimedOutcode : ReferenceExistscode : ReferencedResourceNotFoundcode : RequiredFieldcode : ResourceNotFoundcode : ResourceSizeLimitExceededcode : SearchDeactivatedcode : SearchExecutionFailurecode : SearchFacetPathNotFoundcode : SearchIndexingInProgresscode : SemanticErrorcode : ShippingMethodDoesNotMatchCartcode : StoreCartDiscountsLimitReachedcode : SyntaxErrorerrorserrorserrors line   inheritance   property reference   discriminated classGraphQLErrorObjectcode: StringGraphQLAnonymousIdAlreadyInUseErrorcode: StringGraphQLAssociateMissingPermissionErrorcode: Stringassociate:CustomerResourceIdentifierbusinessUnit:BusinessUnitResourceIdentifierassociateOnBehalf:CustomerResourceIdentifierpermissions:List<Permission>GraphQLAttributeDefinitionAlreadyExistsErrorcode: StringconflictingProductTypeId: StringconflictingProductTypeName: StringconflictingAttributeName: StringGraphQLAttributeDefinitionTypeConflictErrorcode: StringconflictingProductTypeId: StringconflictingProductTypeName: StringconflictingAttributeName: StringGraphQLAttributeNameDoesNotExistErrorcode: StringinvalidAttributeName: StringGraphQLBadGatewayErrorcode: StringGraphQLConcurrentModificationErrorcode: StringcurrentVersion: LongGraphQLContentTooLargeErrorcode: StringGraphQLCountryNotConfiguredInStoreErrorcode: StringstoreCountries:List<String>country: StringGraphQLDiscountCodeNonApplicableErrorcode: StringdiscountCode: Stringreason: StringdiscountCodeId: StringvalidFrom: DateTimevalidUntil: DateTimevalidityCheckTime: DateTimeGraphQLDuplicateAttributeValueErrorcode: Stringattribute:AttributeGraphQLDuplicateAttributeValuesErrorcode: Stringattributes:List<Attribute>GraphQLDuplicateEnumValuesErrorcode: Stringduplicates:List<String>GraphQLDuplicateFieldErrorcode: Stringfield: StringduplicateValue:ObjectGraphQLDuplicateFieldWithConflictingResourceErrorcode: Stringfield: StringduplicateValue:ObjectconflictingResource:ReferenceGraphQLDuplicatePriceKeyErrorcode: StringconflictingPrice:PriceGraphQLDuplicatePriceScopeErrorcode: StringconflictingPrice:PriceGraphQLDuplicateStandalonePriceScopeErrorcode: StringconflictingStandalonePrice:StandalonePriceReferencesku: Stringcurrency: Stringcountry: StringcustomerGroup:CustomerGroupResourceIdentifierchannel:ChannelResourceIdentifiervalidFrom: DateTimevalidUntil: DateTimeGraphQLDuplicateVariantValuesErrorcode: StringvariantValues:VariantValuesGraphQLEditPreviewFailedErrorcode: Stringresult:OrderEditPreviewFailureGraphQLEnumKeyAlreadyExistsErrorcode: StringconflictingEnumKey: StringconflictingAttributeName: StringGraphQLEnumKeyDoesNotExistErrorcode: StringconflictingEnumKey: StringconflictingAttributeName: StringGraphQLEnumValueIsUsedErrorcode: StringGraphQLEnumValuesMustMatchErrorcode: StringGraphQLExtensionBadResponseErrorcode: StringlocalizedMessage:LocalizedStringextensionExtraInfo:ObjectextensionErrors:List<ExtensionError>extensionBody: StringextensionStatusCode: IntegerextensionId: StringextensionKey: StringGraphQLExtensionNoResponseErrorcode: StringextensionId: StringextensionKey: StringGraphQLExtensionPredicateEvaluationFailedErrorcode: StringerrorByExtension:ErrorByExtensionGraphQLExtensionUpdateActionsFailedErrorcode: StringlocalizedMessage:LocalizedStringextensionExtraInfo:ObjectextensionErrors:List<ExtensionError>GraphQLExternalOAuthFailedErrorcode: StringGraphQLFeatureRemovedErrorcode: StringGraphQLGeneralErrorcode: StringGraphQLInsufficientScopeErrorcode: StringGraphQLInternalConstraintViolatedErrorcode: StringGraphQLInvalidCredentialsErrorcode: StringGraphQLInvalidCurrentPasswordErrorcode: StringGraphQLInvalidFieldErrorcode: Stringfield: StringinvalidValue:ObjectallowedValues:List<Object>GraphQLInvalidInputErrorcode: StringGraphQLInvalidItemShippingDetailsErrorcode: Stringsubject: StringitemId: StringGraphQLInvalidJsonInputErrorcode: StringdetailedErrorMessage: StringGraphQLInvalidOperationErrorcode: StringGraphQLInvalidSubjectErrorcode: StringGraphQLInvalidTokenErrorcode: StringGraphQLLanguageUsedInStoresErrorcode: StringGraphQLMatchingPriceNotFoundErrorcode: StringproductId: StringvariantId: Integercurrency: Stringcountry: StringcustomerGroup:CustomerGroupReferencechannel:ChannelReferenceGraphQLMaxCartDiscountsReachedErrorcode: StringGraphQLMaxResourceLimitExceededErrorcode: StringexceededResource:ReferenceTypeIdGraphQLMaxStoreReferencesReachedErrorcode: StringGraphQLMissingRoleOnChannelErrorcode: Stringchannel:ChannelResourceIdentifiermissingRole:ChannelRoleEnumGraphQLMissingTaxRateForCountryErrorcode: StringtaxCategoryId: Stringcountry: Stringstate: StringGraphQLMoneyOverflowErrorcode: StringGraphQLNoMatchingProductDiscountFoundErrorcode: StringGraphQLNotEnabledErrorcode: StringGraphQLObjectNotFoundErrorcode: StringGraphQLOutOfStockErrorcode: StringlineItems:List<String>skus:List<String>GraphQLOverCapacityErrorcode: StringGraphQLOverlappingStandalonePriceValidityErrorcode: StringconflictingStandalonePrice:StandalonePriceReferencesku: Stringcurrency: Stringcountry: StringcustomerGroup:CustomerGroupResourceIdentifierchannel:ChannelResourceIdentifiervalidFrom: DateTimevalidUntil: DateTimeconflictingValidFrom: DateTimeconflictingValidUntil: DateTimeGraphQLPendingOperationErrorcode: StringGraphQLPriceChangedErrorcode: StringlineItems:List<String>shipping: BooleanGraphQLProductAssignmentMissingErrorcode: Stringproduct:ProductReferenceGraphQLProductPresentWithDifferentVariantSelectionErrorcode: Stringproduct:ProductReferenceexistingVariantSelection:ProductVariantSelectionGraphQLProjectNotConfiguredForLanguagesErrorcode: Stringlanguages:List<String>GraphQLQueryComplexityLimitExceededErrorcode: StringGraphQLQueryTimedOutErrorcode: StringGraphQLReferenceExistsErrorcode: StringreferencedBy:ReferenceTypeIdGraphQLReferencedResourceNotFoundErrorcode: StringtypeId:ReferenceTypeIdid: Stringkey: StringGraphQLRequiredFieldErrorcode: Stringfield: StringGraphQLResourceNotFoundErrorcode: StringGraphQLResourceSizeLimitExceededErrorcode: StringGraphQLSearchDeactivatedErrorcode: StringGraphQLSearchExecutionFailureErrorcode: StringGraphQLSearchFacetPathNotFoundErrorcode: StringGraphQLSearchIndexingInProgressErrorcode: StringGraphQLSemanticErrorErrorcode: StringGraphQLShippingMethodDoesNotMatchCartErrorcode: StringGraphQLStoreCartDiscountsLimitReachedErrorcode: Stringstores:List<StoreKeyReference>GraphQLSyntaxErrorErrorcode: Stringcode : AnonymousIdAlreadyInUsecode : AssociateMissingPermissioncode : AttributeDefinitionAlreadyExistscode : AttributeDefinitionTypeConflictcode : AttributeNameDoesNotExistcode : BadGatewaycode : ConcurrentModificationcode : ContentTooLargecode : CountryNotConfiguredInStorecode : DiscountCodeNonApplicablecode : DuplicateAttributeValuecode : DuplicateAttributeValuescode : DuplicateEnumValuescode : DuplicateFieldcode : DuplicateFieldWithConflictingResourcecode : DuplicatePriceKeycode : DuplicatePriceScopecode : DuplicateStandalonePriceScopecode : DuplicateVariantValuescode : EditPreviewFailedcode : EnumKeyAlreadyExistscode : EnumKeyDoesNotExistcode : EnumValueIsUsedcode : EnumValuesMustMatchcode : ExtensionBadResponsecode : ExtensionNoResponsecode : ExtensionPredicateEvaluationFailedcode : ExtensionUpdateActionsFailedcode : ExternalOAuthFailedcode : FeatureRemovedcode : Generalcode : insufficient_scopecode : InternalConstraintViolatedcode : InvalidCredentialscode : InvalidCurrentPasswordcode : InvalidFieldcode : InvalidInputcode : InvalidItemShippingDetailscode : InvalidJsonInputcode : InvalidOperationcode : InvalidSubjectcode : invalid_tokencode : LanguageUsedInStorescode : MatchingPriceNotFoundcode : MaxCartDiscountsReachedcode : MaxResourceLimitExceededcode : MaxStoreReferencesReachedcode : MissingRoleOnChannelcode : MissingTaxRateForCountrycode : MoneyOverflowcode : NoMatchingProductDiscountFoundcode : NotEnabledcode : ObjectNotFoundcode : OutOfStockcode : OverCapacitycode : OverlappingStandalonePriceValiditycode : PendingOperationcode : PriceChangedcode : ProductAssignmentMissingcode : ProductPresentWithDifferentVariantSelectioncode : ProjectNotConfiguredForLanguagescode : QueryComplexityLimitExceededcode : QueryTimedOutcode : ReferenceExistscode : ReferencedResourceNotFoundcode : RequiredFieldcode : ResourceNotFoundcode : ResourceSizeLimitExceededcode : SearchDeactivatedcode : SearchExecutionFailurecode : SearchFacetPathNotFoundcode : SearchIndexingInProgresscode : SemanticErrorcode : ShippingMethodDoesNotMatchCartcode : StoreCartDiscountsLimitReachedcode : SyntaxError line   inheritance   property reference   discriminated classGraphQLErrorObjectcode: StringGraphQLAnonymousIdAlreadyInUseErrorcode: StringGraphQLAssociateMissingPermissionErrorcode: Stringassociate:CustomerResourceIdentifierbusinessUnit:BusinessUnitResourceIdentifierassociateOnBehalf:CustomerResourceIdentifierpermissions:List<Permission>GraphQLAttributeDefinitionAlreadyExistsErrorcode: StringconflictingProductTypeId: StringconflictingProductTypeName: StringconflictingAttributeName: StringGraphQLAttributeDefinitionTypeConflictErrorcode: StringconflictingProductTypeId: StringconflictingProductTypeName: StringconflictingAttributeName: StringGraphQLAttributeNameDoesNotExistErrorcode: StringinvalidAttributeName: StringGraphQLBadGatewayErrorcode: StringGraphQLConcurrentModificationErrorcode: StringcurrentVersion: LongGraphQLContentTooLargeErrorcode: StringGraphQLCountryNotConfiguredInStoreErrorcode: StringstoreCountries:List<String>country: StringGraphQLDiscountCodeNonApplicableErrorcode: StringdiscountCode: Stringreason: StringdiscountCodeId: StringvalidFrom: DateTimevalidUntil: DateTimevalidityCheckTime: DateTimeGraphQLDuplicateAttributeValueErrorcode: Stringattribute:AttributeGraphQLDuplicateAttributeValuesErrorcode: Stringattributes:List<Attribute>GraphQLDuplicateEnumValuesErrorcode: Stringduplicates:List<String>GraphQLDuplicateFieldErrorcode: Stringfield: StringduplicateValue:ObjectGraphQLDuplicateFieldWithConflictingResourceErrorcode: Stringfield: StringduplicateValue:ObjectconflictingResource:ReferenceGraphQLDuplicatePriceKeyErrorcode: StringconflictingPrice:PriceGraphQLDuplicatePriceScopeErrorcode: StringconflictingPrice:PriceGraphQLDuplicateStandalonePriceScopeErrorcode: StringconflictingStandalonePrice:StandalonePriceReferencesku: Stringcurrency: Stringcountry: StringcustomerGroup:CustomerGroupResourceIdentifierchannel:ChannelResourceIdentifiervalidFrom: DateTimevalidUntil: DateTimeGraphQLDuplicateVariantValuesErrorcode: StringvariantValues:VariantValuesGraphQLEditPreviewFailedErrorcode: Stringresult:OrderEditPreviewFailureGraphQLEnumKeyAlreadyExistsErrorcode: StringconflictingEnumKey: StringconflictingAttributeName: StringGraphQLEnumKeyDoesNotExistErrorcode: StringconflictingEnumKey: StringconflictingAttributeName: StringGraphQLEnumValueIsUsedErrorcode: StringGraphQLEnumValuesMustMatchErrorcode: StringGraphQLExtensionBadResponseErrorcode: StringlocalizedMessage:LocalizedStringextensionExtraInfo:ObjectextensionErrors:List<ExtensionError>extensionBody: StringextensionStatusCode: IntegerextensionId: StringextensionKey: StringGraphQLExtensionNoResponseErrorcode: StringextensionId: StringextensionKey: StringGraphQLExtensionPredicateEvaluationFailedErrorcode: StringerrorByExtension:ErrorByExtensionGraphQLExtensionUpdateActionsFailedErrorcode: StringlocalizedMessage:LocalizedStringextensionExtraInfo:ObjectextensionErrors:List<ExtensionError>GraphQLExternalOAuthFailedErrorcode: StringGraphQLFeatureRemovedErrorcode: StringGraphQLGeneralErrorcode: StringGraphQLInsufficientScopeErrorcode: StringGraphQLInternalConstraintViolatedErrorcode: StringGraphQLInvalidCredentialsErrorcode: StringGraphQLInvalidCurrentPasswordErrorcode: StringGraphQLInvalidFieldErrorcode: Stringfield: StringinvalidValue:ObjectallowedValues:List<Object>GraphQLInvalidInputErrorcode: StringGraphQLInvalidItemShippingDetailsErrorcode: Stringsubject: StringitemId: StringGraphQLInvalidJsonInputErrorcode: StringdetailedErrorMessage: StringGraphQLInvalidOperationErrorcode: StringGraphQLInvalidSubjectErrorcode: StringGraphQLInvalidTokenErrorcode: StringGraphQLLanguageUsedInStoresErrorcode: StringGraphQLMatchingPriceNotFoundErrorcode: StringproductId: StringvariantId: Integercurrency: Stringcountry: StringcustomerGroup:CustomerGroupReferencechannel:ChannelReferenceGraphQLMaxCartDiscountsReachedErrorcode: StringGraphQLMaxResourceLimitExceededErrorcode: StringexceededResource:ReferenceTypeIdGraphQLMaxStoreReferencesReachedErrorcode: StringGraphQLMissingRoleOnChannelErrorcode: Stringchannel:ChannelResourceIdentifiermissingRole:ChannelRoleEnumGraphQLMissingTaxRateForCountryErrorcode: StringtaxCategoryId: Stringcountry: Stringstate: StringGraphQLMoneyOverflowErrorcode: StringGraphQLNoMatchingProductDiscountFoundErrorcode: StringGraphQLObjectNotFoundErrorcode: StringGraphQLOutOfStockErrorcode: StringlineItems:List<String>skus:List<String>GraphQLOverCapacityErrorcode: StringGraphQLOverlappingStandalonePriceValidityErrorcode: StringconflictingStandalonePrice:StandalonePriceReferencesku: Stringcurrency: Stringcountry: StringcustomerGroup:CustomerGroupResourceIdentifierchannel:ChannelResourceIdentifiervalidFrom: DateTimevalidUntil: DateTimeconflictingValidFrom: DateTimeconflictingValidUntil: DateTimeGraphQLPendingOperationErrorcode: StringGraphQLPriceChangedErrorcode: StringlineItems:List<String>shipping: BooleanGraphQLProductAssignmentMissingErrorcode: Stringproduct:ProductReferenceGraphQLProductPresentWithDifferentVariantSelectionErrorcode: Stringproduct:ProductReferenceexistingVariantSelection:ProductVariantSelectionGraphQLProjectNotConfiguredForLanguagesErrorcode: Stringlanguages:List<String>GraphQLQueryComplexityLimitExceededErrorcode: StringGraphQLQueryTimedOutErrorcode: StringGraphQLReferenceExistsErrorcode: StringreferencedBy:ReferenceTypeIdGraphQLReferencedResourceNotFoundErrorcode: StringtypeId:ReferenceTypeIdid: Stringkey: StringGraphQLRequiredFieldErrorcode: Stringfield: StringGraphQLResourceNotFoundErrorcode: StringGraphQLResourceSizeLimitExceededErrorcode: StringGraphQLSearchDeactivatedErrorcode: StringGraphQLSearchExecutionFailureErrorcode: StringGraphQLSearchFacetPathNotFoundErrorcode: StringGraphQLSearchIndexingInProgressErrorcode: StringGraphQLSemanticErrorErrorcode: StringGraphQLShippingMethodDoesNotMatchCartErrorcode: StringGraphQLStoreCartDiscountsLimitReachedErrorcode: Stringstores:List<StoreKeyReference>GraphQLSyntaxErrorErrorcode: Stringcode : AnonymousIdAlreadyInUsecode : AssociateMissingPermissioncode : AttributeDefinitionAlreadyExistscode : AttributeDefinitionTypeConflictcode : AttributeNameDoesNotExistcode : BadGatewaycode : ConcurrentModificationcode : ContentTooLargecode : CountryNotConfiguredInStorecode : DiscountCodeNonApplicablecode : DuplicateAttributeValuecode : DuplicateAttributeValuescode : DuplicateEnumValuescode : DuplicateFieldcode : DuplicateFieldWithConflictingResourcecode : DuplicatePriceKeycode : DuplicatePriceScopecode : DuplicateStandalonePriceScopecode : DuplicateVariantValuescode : EditPreviewFailedcode : EnumKeyAlreadyExistscode : EnumKeyDoesNotExistcode : EnumValueIsUsedcode : EnumValuesMustMatchcode : ExtensionBadResponsecode : ExtensionNoResponsecode : ExtensionPredicateEvaluationFailedcode : ExtensionUpdateActionsFailedcode : ExternalOAuthFailedcode : FeatureRemovedcode : Generalcode : insufficient_scopecode : InternalConstraintViolatedcode : InvalidCredentialscode : InvalidCurrentPasswordcode : InvalidFieldcode : InvalidInputcode : InvalidItemShippingDetailscode : InvalidJsonInputcode : InvalidOperationcode : InvalidSubjectcode : invalid_tokencode : LanguageUsedInStorescode : MatchingPriceNotFoundcode : MaxCartDiscountsReachedcode : MaxResourceLimitExceededcode : MaxStoreReferencesReachedcode : MissingRoleOnChannelcode : MissingTaxRateForCountrycode : MoneyOverflowcode : NoMatchingProductDiscountFoundcode : ObjectNotFoundcode : OutOfStockcode : OverCapacitycode : OverlappingStandalonePriceValiditycode : PendingOperationcode : PriceChangedcode : ProductAssignmentMissingcode : ProductPresentWithDifferentVariantSelectioncode : ProjectNotConfiguredForLanguagescode : QueryComplexityLimitExceededcode : QueryTimedOutcode : ReferenceExistscode : ReferencedResourceNotFoundcode : RequiredFieldcode : ResourceNotFoundcode : ResourceSizeLimitExceededcode : SearchDeactivatedcode : SearchExecutionFailurecode : SearchFacetPathNotFoundcode : SearchIndexingInProgresscode : SemanticErrorcode : ShippingMethodDoesNotMatchCartcode : StoreCartDiscountsLimitReachedcode : SyntaxError line   inheritance   property reference   discriminated classGraphQLNotEnabledErrorcode: StringGraphQLErrorObjectcode: String line   inheritance   property reference   discriminated class diff --git a/uml/api/svg/MessageSubscriptionResourceTypeId.svg b/uml/api/svg/MessageSubscriptionResourceTypeId.svg index dbe3e1d36..de819d0fd 100644 --- a/uml/api/svg/MessageSubscriptionResourceTypeId.svg +++ b/uml/api/svg/MessageSubscriptionResourceTypeId.svg @@ -1,10 +1,12 @@ -MessageSubscriptionResourceTypeIdASSOCIATE_ROLEBUSINESS_UNITCATEGORYCUSTOMERCUSTOMER_EMAIL_TOKENCUSTOMER_GROUPCUSTOMER_PASSWORD_TOKENINVENTORY_ENTRYORDERPAYMENTPRODUCTPRODUCT_SELECTIONQUOTEQUOTE_REQUESTREVIEWSTAGED_QUOTESTANDALONE_PRICESTOREMessageSubscriptionresourceTypeId:MessageSubscriptionResourceTypeIdtypes:List<String>resourceTypeIdMessageSubscriptionResourceTypeIdAPPROVAL_FLOWAPPROVAL_RULEASSOCIATE_ROLEBUSINESS_UNITCATEGORYCUSTOMERCUSTOMER_EMAIL_TOKENCUSTOMER_GROUPCUSTOMER_PASSWORD_TOKENINVENTORY_ENTRYORDERPAYMENTPRODUCTPRODUCT_SELECTIONQUOTEQUOTE_REQUESTREVIEWSTAGED_QUOTESTANDALONE_PRICESTOREMessageSubscriptionresourceTypeId:MessageSubscriptionResourceTypeIdtypes:List<String>resourceTypeIdNotEnabledErrorcode: Stringmessage: StringErrorObjectcode: Stringmessage: String line   inheritance   property reference   discriminated class diff --git a/uml/api/svg/ReferenceTypeId.svg b/uml/api/svg/ReferenceTypeId.svg index e58abeeda..b03d668b4 100644 --- a/uml/api/svg/ReferenceTypeId.svg +++ b/uml/api/svg/ReferenceTypeId.svg @@ -1,18 +1,20 @@ -ReferenceTypeIdASSOCIATE_ROLEATTRIBUTE_GROUPBUSINESS_UNITCARTCART_DISCOUNTCATEGORYCHANNELCUSTOMERCUSTOMER_EMAIL_TOKENCUSTOMER_GROUPCUSTOMER_PASSWORD_TOKENDIRECT_DISCOUNTDISCOUNT_CODEEXTENSIONINVENTORY_ENTRYKEY_VALUE_DOCUMENTORDERORDER_EDITPAYMENTPRODUCTPRODUCT_DISCOUNTPRODUCT_PRICEPRODUCT_SELECTIONPRODUCT_TYPEQUOTEQUOTE_REQUESTREVIEWSHIPPING_METHODSHOPPING_LISTSTAGED_QUOTESTANDALONE_PRICESTATESTORESUBSCRIPTIONTAX_CATEGORYTYPEZONEKeyReferencetypeId:ReferenceTypeIdkey: StringReferencetypeId:ReferenceTypeIdid: StringResourceIdentifiertypeId:ReferenceTypeIdid: Stringkey: StringMaxResourceLimitExceededErrorcode: Stringmessage: StringexceededResource:ReferenceTypeIdReferenceExistsErrorcode: Stringmessage: StringreferencedBy:ReferenceTypeIdReferencedResourceNotFoundErrorcode: Stringmessage: StringtypeId:ReferenceTypeIdid: Stringkey: StringGraphQLMaxResourceLimitExceededErrorcode: StringexceededResource:ReferenceTypeIdGraphQLReferenceExistsErrorcode: StringreferencedBy:ReferenceTypeIdGraphQLReferencedResourceNotFoundErrorcode: StringtypeId:ReferenceTypeIdid: Stringkey: StringtypeIdtypeIdtypeIdexceededResourcereferencedBytypeIdexceededResourcereferencedBytypeIdReferenceTypeIdAPPROVAL_FLOWAPPROVAL_RULEASSOCIATE_ROLEATTRIBUTE_GROUPBUSINESS_UNITCARTCART_DISCOUNTCATEGORYCHANNELCUSTOMERCUSTOMER_EMAIL_TOKENCUSTOMER_GROUPCUSTOMER_PASSWORD_TOKENDIRECT_DISCOUNTDISCOUNT_CODEEXTENSIONINVENTORY_ENTRYKEY_VALUE_DOCUMENTORDERORDER_EDITPAYMENTPRODUCTPRODUCT_DISCOUNTPRODUCT_PRICEPRODUCT_SELECTIONPRODUCT_TYPEQUOTEQUOTE_REQUESTREVIEWSHIPPING_METHODSHOPPING_LISTSTAGED_QUOTESTANDALONE_PRICESTATESTORESUBSCRIPTIONTAX_CATEGORYTYPEZONEKeyReferencetypeId:ReferenceTypeIdkey: StringReferencetypeId:ReferenceTypeIdid: StringResourceIdentifiertypeId:ReferenceTypeIdid: Stringkey: StringMaxResourceLimitExceededErrorcode: Stringmessage: StringexceededResource:ReferenceTypeIdReferenceExistsErrorcode: Stringmessage: StringreferencedBy:ReferenceTypeIdReferencedResourceNotFoundErrorcode: Stringmessage: StringtypeId:ReferenceTypeIdid: Stringkey: StringGraphQLMaxResourceLimitExceededErrorcode: StringexceededResource:ReferenceTypeIdGraphQLReferenceExistsErrorcode: StringreferencedBy:ReferenceTypeIdGraphQLReferencedResourceNotFoundErrorcode: StringtypeId:ReferenceTypeIdid: Stringkey: StringtypeIdtypeIdtypeIdexceededResourcereferencedBytypeIdexceededResourcereferencedBytypeId