From 4d22983a0c7da40eff11c3a659970da22f129605 Mon Sep 17 00:00:00 2001 From: Auto Mation Date: Mon, 27 May 2024 13:05:01 +0000 Subject: [PATCH] Updated api-reference from documentation release --- api-specs/api/resources/products.raml | 14 +++++++------- api-specs/api/resources/standalone-prices.raml | 5 ++++- api-specs/api/traits/price-selecting.raml | 8 ++++---- api-specs/api/types/cart/Cart.raml | 4 ++-- api-specs/api/types/cart/CartDraft.raml | 4 ++-- api-specs/api/types/cart/DirectDiscountDraft.raml | 6 +----- api-specs/api/types/cart/LineItem.raml | 2 +- api-specs/api/types/cart/LineItemDraft.raml | 2 +- api-specs/api/types/cart/LineItemPriceMode.raml | 2 +- .../types/cart/updates/CartAddLineItemAction.raml | 4 ++-- .../updates/CartChangeLineItemQuantityAction.raml | 4 ++-- .../cart/updates/CartRemoveLineItemAction.raml | 2 +- .../CartSetLineItemDistributionChannelAction.raml | 2 +- .../cart/updates/CartSetShippingAddressAction.raml | 2 +- api-specs/api/types/channel/ChannelRoleEnum.raml | 2 +- api-specs/api/types/common/Price.raml | 2 +- api-specs/api/types/common/ReferenceTypeId.raml | 2 +- api-specs/api/types/common/ScopedPrice.raml | 2 +- api-specs/api/types/me/MyCartDraft.raml | 2 +- api-specs/api/types/me/MyLineItemDraft.raml | 2 +- .../types/me/updates/MyCartAddLineItemAction.raml | 5 +++-- .../me/updates/MyCartRemoveLineItemAction.raml | 2 +- ...MyCartSetLineItemDistributionChannelAction.raml | 2 +- .../me/updates/MyCartSetShippingAddressAction.raml | 2 +- .../types/message/ProductPriceAddedMessage.raml | 2 +- .../types/message/ProductPriceChangedMessage.raml | 6 +++--- .../ProductPriceDiscountsSetUpdatedPrice.raml | 2 +- .../types/message/ProductPriceRemovedMessage.raml | 2 +- .../payload/ProductPriceAddedMessagePayload.raml | 2 +- .../payload/ProductPriceChangedMessagePayload.raml | 6 +++--- .../payload/ProductPriceRemovedMessagePayload.raml | 2 +- .../updates/StagedOrderAddLineItemAction.raml | 4 ++-- .../StagedOrderChangeLineItemQuantityAction.raml | 4 ++-- .../updates/StagedOrderRemoveLineItemAction.raml | 2 +- ...dOrderSetLineItemDistributionChannelAction.raml | 2 +- api-specs/api/types/order/LineItemImportDraft.raml | 2 +- api-specs/api/types/order/Order.raml | 4 ++-- .../ProductSearchProjectionParams.raml | 8 ++++---- .../api/types/product/ProductPriceModeEnum.raml | 3 ++- api-specs/api/types/product/ProductVariant.raml | 6 +++--- .../product/updates/ProductSetPriceKeyAction.raml | 4 ++-- .../types/standalone-price/StandalonePrice.raml | 6 +++--- .../standalone-price/StandalonePriceDraft.raml | 6 +----- .../StandalonePricePagedQueryResponse.raml | 2 ++ api-specs/api/types/type/ResourceTypeId.raml | 2 +- 45 files changed, 80 insertions(+), 81 deletions(-) diff --git a/api-specs/api/resources/products.raml b/api-specs/api/resources/products.raml index 65318d56b2..3d2e528cf4 100644 --- a/api-specs/api/resources/products.raml +++ b/api-specs/api/resources/products.raml @@ -25,7 +25,7 @@ get: is: - priceSelecting description: |- - If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response. + If [Product price selection query parameters](/../api/pricing-and-discounts-overview#product-price-selection) are provided, the selected Prices are added to the response. queryParameters: where: type: QueryPredicate[] @@ -54,7 +54,7 @@ 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_ 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. + If [Product price selection query parameters](/../api/pricing-and-discounts-overview#product-price-selection) are provided, selected Prices will be added to the response. Produces the [ProductCreated](/projects/messages#product-created) Message. is: - priceSelecting @@ -78,7 +78,7 @@ post: is: - priceSelecting description: |- - If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response. + If [Product price selection query parameters]](/../api/pricing-and-discounts-overview#product-price-selection) are provided, the selected Prices are added to the response. responses: 200: body: @@ -102,7 +102,7 @@ post: example: !include ../examples/product.example.json delete: description: |- - If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response. + If [Product price selection query parameters](/../api/pricing-and-discounts-overview#product-price-selection) are provided, the selected Prices are added to the response. Produces the [ProductDeleted](/projects/messages#product-deleted) Message. securedBy: [oauth_2_0: { scopes: ['manage_products:{projectKey}'] }] is: @@ -139,7 +139,7 @@ post: is: - priceSelecting description: |- - If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response. + If [Product price selection query parameters](/../api/pricing-and-discounts-overview#product-price-selection) are provided, the selected Prices are added to the response. responses: 200: body: @@ -153,7 +153,7 @@ post: is: - priceSelecting description: |- - If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response. + If [Product price selection query parameters](/../api/pricing-and-discounts-overview#product-price-selection) are provided, the selected Prices are added to the response. A failed response can return a [DuplicatePriceScope](ctp:api:type:DuplicatePriceScopeError), [DuplicateVariantValues](ctp:api:type:DuplicateVariantValuesError), [DuplicateAttributeValue](ctp:api:type:DuplicateAttributeValueError), or [DuplicateAttributeValues](ctp:api:type:DuplicateAttributeValuesError) error. body: @@ -166,7 +166,7 @@ post: example: !include ../examples/product.example.json delete: description: |- - If [Price selection](ctp:api:type:ProductPriceSelection) query parameters are provided, the selected Prices are added to the response. + If [Product price selection query parameters](/../api/pricing-and-discounts-overview#product-price-selection) are provided, the selected Prices are added to the response. Produces the [ProductDeleted](/projects/messages#product-deleted) Message. securedBy: [oauth_2_0: { scopes: ['manage_products:{projectKey}'] }] is: diff --git a/api-specs/api/resources/standalone-prices.raml b/api-specs/api/resources/standalone-prices.raml index e9aca8d33e..6deec7de01 100644 --- a/api-specs/api/resources/standalone-prices.raml +++ b/api-specs/api/resources/standalone-prices.raml @@ -26,7 +26,10 @@ head: type: QueryPredicate[] post: description: | - Produces the [StandalonePriceCreated](ctp:api:type:StandalonePriceCreatedMessage) Message. + Creating a Standalone Price produces the [StandalonePriceCreated](ctp:api:type:StandalonePriceCreatedMessage) Message. + + - If the Standalone Price has the same price scope as an existing Standalone Price, a [DuplicateStandalonePriceScope](ctp:api:type:DuplicateStandalonePriceScopeError) error is returned. + - If the Standalone Price has overlapping validity periods within the same price scope, a [OverlappingStandalonePriceValidity](ctp:api:type:OverlappingStandalonePriceValidityError) error is returned. A Price without validity period does not conflict with a Price defined for a time period. securedBy: [oauth_2_0: { scopes: ['manage_standalone_prices:{projectKey}'] }] body: application/json: diff --git a/api-specs/api/traits/price-selecting.raml b/api-specs/api/traits/price-selecting.raml index 4fed195f65..b4c165fff7 100644 --- a/api-specs/api/traits/price-selecting.raml +++ b/api-specs/api/traits/price-selecting.raml @@ -5,22 +5,22 @@ queryParameters: type: CurrencyCode required: false description: | - The currency used for [Price selection](/projects/products#price-selection). + The currency used for [Product price selection](/../api/pricing-and-discounts-overview#product-price-selection). priceCountry: type: CountryCode required: false description: | - The country used for [Price selection](/projects/products#price-selection). Can only be used **in conjunction with** the `priceCurrency` parameter. + The country used for [Product price selection](/../api/pricing-and-discounts-overview#product-price-selection). Can only be used **in conjunction with** the `priceCurrency` parameter. priceCustomerGroup: type: string required: false description: | - `id` of an existing [CustomerGroup](ctp:api:type:CustomerGroup) used for [Price selection](ctp:api:type:ProductPriceSelection). Can only be used **in conjunction with** the `priceCurrency` parameter. + `id` of an existing [CustomerGroup](ctp:api:type:CustomerGroup) used for [Product price selection](/../api/pricing-and-discounts-overview#product-price-selection). Can only be used **in conjunction with** the `priceCurrency` parameter. priceChannel: type: string required: false description: | - `id` of an existing [Channel](ctp:api:type:Channel) used for [Price selection](ctp:api:type:ProductPriceSelection). Can only be used **in conjunction with** the `priceCurrency` parameter. + `id` of an existing [Channel](ctp:api:type:Channel) used for [Product price selection](/../api/pricing-and-discounts-overview#product-price-selection). Can only be used **in conjunction with** the `priceCurrency` parameter. localeProjection: type: Locale[] required: false diff --git a/api-specs/api/types/cart/Cart.raml b/api-specs/api/types/cart/Cart.raml index e8bcfa3f0e..2f71f31c54 100644 --- a/api-specs/api/types/cart/Cart.raml +++ b/api-specs/api/types/cart/Cart.raml @@ -32,7 +32,7 @@ properties: customerGroup?: type: CustomerGroupReference description: | - [Reference](ctp:api:type:Reference) to the Customer Group of the Customer that the Cart belongs to. Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + [Reference](ctp:api:type:Reference) to the Customer Group of the Customer that the Cart belongs to. Used for [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). anonymousId?: type: string description: | @@ -170,7 +170,7 @@ properties: country?: type: CountryCode description: | - Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + Used for [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). locale?: type: Locale description: | diff --git a/api-specs/api/types/cart/CartDraft.raml b/api-specs/api/types/cart/CartDraft.raml index f3f66fd321..968e25aa88 100644 --- a/api-specs/api/types/cart/CartDraft.raml +++ b/api-specs/api/types/cart/CartDraft.raml @@ -25,7 +25,7 @@ properties: customerGroup?: type: CustomerGroupResourceIdentifier description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Customer Group of the Customer that the Cart belongs to. Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Customer Group of the Customer that the Cart belongs to. Used for [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). It is automatically set if the Customer referenced in `customerId` belongs to a Customer Group. It can also be set explicitly when no `customerId` is present. @@ -123,7 +123,7 @@ properties: country?: type: CountryCode description: | - Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + Used for [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). If used for [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/carts:POST), the provided country must be one of the [Store's](ctp:api:type:Store) `countries`. locale?: type: Locale diff --git a/api-specs/api/types/cart/DirectDiscountDraft.raml b/api-specs/api/types/cart/DirectDiscountDraft.raml index d4e809bb56..2c992718ca 100644 --- a/api-specs/api/types/cart/DirectDiscountDraft.raml +++ b/api-specs/api/types/cart/DirectDiscountDraft.raml @@ -6,11 +6,7 @@ example: !include ../../examples/Cart/CartDirectDiscountDraft.json description: | Represents a [CartDiscount](ctp:api:type:CartDiscount) that can only be associated with a single Cart or Order. - Direct Discounts are always active and valid, and have the default `Stacking` [StackingMode](ctp:api:type:StackingMode). - They apply in the order in which they are listed in the `directDiscounts` array of [Carts](ctp:api:type:Cart) or [Orders](ctp:api:type:Order), and do not have a sorting order like Cart Discounts. - - If a Direct Discount is present, any matching Cart Discounts in the Project are ignored. - Additionally, a Cart or Order supports either Discount Codes or Direct Discounts at the same time. + For an introduction to Direct Discounts and to understand how they work in Composable Commerce, see the [Direct Discounts overview](/pricing-and-discounts-overview#direct-discounts). properties: value: type: CartDiscountValueDraft diff --git a/api-specs/api/types/cart/LineItem.raml b/api-specs/api/types/cart/LineItem.raml index 1602ae63db..0beefb25ea 100644 --- a/api-specs/api/types/cart/LineItem.raml +++ b/api-specs/api/types/cart/LineItem.raml @@ -97,7 +97,7 @@ properties: distributionChannel?: type: ChannelReference description: | - Used to [select](ctp:api:type:LineItemPriceSelection) a Product Price. The referenced Channel has the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum). + Used to [select](/../api/pricing-and-discounts-overview#line-item-price-selection) a Product Price. The referenced Channel has the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum). priceMode: type: LineItemPriceMode description: | diff --git a/api-specs/api/types/cart/LineItemDraft.raml b/api-specs/api/types/cart/LineItemDraft.raml index 62435a743e..2730d24474 100644 --- a/api-specs/api/types/cart/LineItemDraft.raml +++ b/api-specs/api/types/cart/LineItemDraft.raml @@ -42,7 +42,7 @@ properties: distributionChannel?: type: ChannelResourceIdentifier description: | - Used to [select](ctp:api:type:LineItemPriceSelection) a Product Price. + Used to [select](/../api/pricing-and-discounts-overview#line-item-price-selection) a Product Price. The referenced Channel must have the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum). If the Cart is bound to a [Store](ctp:api:type:Store) with `distributionChannels` set, diff --git a/api-specs/api/types/cart/LineItemPriceMode.raml b/api-specs/api/types/cart/LineItemPriceMode.raml index 47ffcfee00..823d179de6 100644 --- a/api-specs/api/types/cart/LineItemPriceMode.raml +++ b/api-specs/api/types/cart/LineItemPriceMode.raml @@ -10,7 +10,7 @@ enum: - ExternalTotal (enumDescriptions): Platform: | - The [price is selected](ctp:api:type:LineItemPriceSelection) from the Product Variant. + The price is [selected](/../api/pricing-and-discounts-overview#line-item-price-selection) from the Product Variant. This is the default mode. ExternalPrice: | The Line Item price is set externally. diff --git a/api-specs/api/types/cart/updates/CartAddLineItemAction.raml b/api-specs/api/types/cart/updates/CartAddLineItemAction.raml index 6a28ef57fd..3f859f6597 100644 --- a/api-specs/api/types/cart/updates/CartAddLineItemAction.raml +++ b/api-specs/api/types/cart/updates/CartAddLineItemAction.raml @@ -8,7 +8,7 @@ description: | If the Cart contains a [LineItem](ctp:api:type:LineItem) for a Product Variant with the same [LineItemMode](ctp:api:type:LineItemMode), [Custom Fields](/../api/projects/custom-fields), supply and distribution channel, then only the quantity of the existing Line Item is increased. If [LineItem](ctp:api:type:LineItem) `shippingDetails` is set, it is merged. All addresses will be present afterwards and, for address keys present in both shipping details, the quantity will be summed up. A new Line Item is added when the `externalPrice` or `externalTotalPrice` is set in this update action. - The [LineItem](ctp:api:type:LineItem) price is set as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + The [LineItem](ctp:api:type:LineItem) price is set as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). If the Tax Rate is not set, a [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) error is returned. @@ -57,7 +57,7 @@ properties: distributionChannel?: type: ChannelResourceIdentifier description: | - Used to [select](ctp:api:type:LineItemPriceSelection) a Product Price. + Used to [select](/../api/pricing-and-discounts-overview#line-item-price-selection) a Product Price. The Channel must have the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum). If the Cart is bound to a [Store](ctp:api:type:Store) with `distributionChannels` set, the Channel must match one of the Store's distribution channels. supplyChannel?: diff --git a/api-specs/api/types/cart/updates/CartChangeLineItemQuantityAction.raml b/api-specs/api/types/cart/updates/CartChangeLineItemQuantityAction.raml index a0e84b5589..bcda95f376 100644 --- a/api-specs/api/types/cart/updates/CartChangeLineItemQuantityAction.raml +++ b/api-specs/api/types/cart/updates/CartChangeLineItemQuantityAction.raml @@ -15,7 +15,7 @@ description: | use this update action in combination with the [Set LineItem ShippingDetails](ctp:api:type:CartSetLineItemShippingDetailsAction) update action in a single Cart update command. - The [LineItem](ctp:api:type:LineItem) price is set as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + The [LineItem](ctp:api:type:LineItem) price is set as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). properties: lineItemId?: type: string @@ -39,7 +39,7 @@ properties: Required when the Line Item uses `ExternalPrice` [LineItemPriceMode](ctp:api:type:LineItemPriceMode). Sets the [LineItem](ctp:api:type:LineItem) `price` to the given value when changing the quantity of a Line Item. - The LineItem price is updated as described in LineItem Price selection. + The LineItem price is updated as described in Line Item price selection. externalTotalPrice?: type: ExternalLineItemTotalPrice description: | diff --git a/api-specs/api/types/cart/updates/CartRemoveLineItemAction.raml b/api-specs/api/types/cart/updates/CartRemoveLineItemAction.raml index f52860afeb..253aabac9b 100644 --- a/api-specs/api/types/cart/updates/CartRemoveLineItemAction.raml +++ b/api-specs/api/types/cart/updates/CartRemoveLineItemAction.raml @@ -5,7 +5,7 @@ displayName: CartRemoveLineItemAction discriminatorValue: removeLineItem example: !include ../../../examples/Cart/CartRemoveLineItemAction.json description: | - The [LineItem](ctp:api:type:LineItem) price is updated as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + The [LineItem](ctp:api:type:LineItem) price is updated as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). properties: lineItemId?: type: string diff --git a/api-specs/api/types/cart/updates/CartSetLineItemDistributionChannelAction.raml b/api-specs/api/types/cart/updates/CartSetLineItemDistributionChannelAction.raml index 8e8d8479f6..47c8805569 100644 --- a/api-specs/api/types/cart/updates/CartSetLineItemDistributionChannelAction.raml +++ b/api-specs/api/types/cart/updates/CartSetLineItemDistributionChannelAction.raml @@ -5,7 +5,7 @@ displayName: CartSetLineItemDistributionChannelAction discriminatorValue: setLineItemDistributionChannel example: !include ../../../examples/Cart/CartSetLineItemDistributionChannelAction.json description: | - Setting a distribution channel for a [LineItem](ctp:api:type:LineItem) can lead to an updated `price` as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + Setting a distribution channel for a [LineItem](ctp:api:type:LineItem) can lead to an updated `price` as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). properties: lineItemId?: type: string diff --git a/api-specs/api/types/cart/updates/CartSetShippingAddressAction.raml b/api-specs/api/types/cart/updates/CartSetShippingAddressAction.raml index 70ec192e7c..976d005159 100644 --- a/api-specs/api/types/cart/updates/CartSetShippingAddressAction.raml +++ b/api-specs/api/types/cart/updates/CartSetShippingAddressAction.raml @@ -7,7 +7,7 @@ example: !include ../../../examples/Cart/CartSetShippingAddressAction.json description: | Setting the shipping address also sets the [TaxRate](ctp:api:type:TaxRate) of Line Items and calculates the [TaxedPrice](ctp:api:type:TaxedPrice). - If a matching price cannot be found for the given shipping address during [Line Item Price selection](ctp:api:type:LineItemPriceSelection), + If a matching price cannot be found for the given shipping address during [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection), a [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) error is returned. If you want to allow shipping to states inside a country that are not explicitly covered by a TaxRate, diff --git a/api-specs/api/types/channel/ChannelRoleEnum.raml b/api-specs/api/types/channel/ChannelRoleEnum.raml index af27245401..e7976ea8a6 100644 --- a/api-specs/api/types/channel/ChannelRoleEnum.raml +++ b/api-specs/api/types/channel/ChannelRoleEnum.raml @@ -15,7 +15,7 @@ enum: Channel can be used to track inventory entries (for example, Channels with this role can be treated as warehouses). ProductDistribution: | Channel can be used to expose Products to a specific distribution Channel. - The Channel can be used by a Cart to [select](ctp:api:type:LineItemPriceSelection) a Product Price. + The Channel can be used by a Cart to [select](/../api/pricing-and-discounts-overview#line-item-price-selection) a Product Price. OrderExport: | Channel can be used to track order export activities. OrderImport: | diff --git a/api-specs/api/types/common/Price.raml b/api-specs/api/types/common/Price.raml index c99f75f719..84209a48d9 100644 --- a/api-specs/api/types/common/Price.raml +++ b/api-specs/api/types/common/Price.raml @@ -45,7 +45,7 @@ properties: type: DiscountedPrice description: | Is set if a [ProductDiscount](ctp:api:type:ProductDiscount) has been applied. - If set, the API uses the DiscountedPrice value for the [Line Item Price selection](ctp:api:type:LineItemPriceSelection). + If set, the API uses the DiscountedPrice value for the [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). When a [relative discount](ctp:api:type:ProductDiscountValueRelative) has been applied and the fraction part of the DiscountedPrice `value` is 0.5, the `value` is rounded in favor of the customer with [half-down rounding](https://en.wikipedia.org/wiki/Rounding#Round_half_down). tiers?: type: PriceTier[] diff --git a/api-specs/api/types/common/ReferenceTypeId.raml b/api-specs/api/types/common/ReferenceTypeId.raml index 22c9199a48..39b83a837f 100644 --- a/api-specs/api/types/common/ReferenceTypeId.raml +++ b/api-specs/api/types/common/ReferenceTypeId.raml @@ -93,7 +93,7 @@ enum: product-discount: | References a [ProductDiscount](ctp:api:type:ProductDiscount). product-price: | - References an [Embedded Price](/projects/products#embedded-price). + References an [Embedded Price](ctp:api:type:Price). product-selection: | References a [ProductSelection](ctp:api:type:ProductSelection). product-tailoring: | diff --git a/api-specs/api/types/common/ScopedPrice.raml b/api-specs/api/types/common/ScopedPrice.raml index bad452fdf8..27516259e9 100644 --- a/api-specs/api/types/common/ScopedPrice.raml +++ b/api-specs/api/types/common/ScopedPrice.raml @@ -4,7 +4,7 @@ displayName: ScopedPrice type: object description: | Scoped Price is contained in a [ProductVariant](ctp:api:type:ProductVariant) which is returned in response to a - [Product Projection Search](ctp:api:type:ProductProjectionSearchFilterScopedPrice) request when [Scoped Price Search](ctp:api:type:ScopedPriceSearch) is used. + [Product Projection Search](ctp:api:type:ProductProjectionSearchFilterScopedPrice) request when [Scoped Price Search](/../api/pricing-and-discounts-overview#scoped-price-search) is used. properties: id: type: string diff --git a/api-specs/api/types/me/MyCartDraft.raml b/api-specs/api/types/me/MyCartDraft.raml index b659dbbf6b..5f54082869 100644 --- a/api-specs/api/types/me/MyCartDraft.raml +++ b/api-specs/api/types/me/MyCartDraft.raml @@ -70,7 +70,7 @@ properties: country?: type: CountryCode description: | - Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + Used for [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). If used for [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/me/carts:POST), the provided country must be one of the [Store's](ctp:api:type:Store) `countries`. locale?: type: Locale diff --git a/api-specs/api/types/me/MyLineItemDraft.raml b/api-specs/api/types/me/MyLineItemDraft.raml index c4297a003e..76813104fa 100644 --- a/api-specs/api/types/me/MyLineItemDraft.raml +++ b/api-specs/api/types/me/MyLineItemDraft.raml @@ -47,7 +47,7 @@ properties: distributionChannel?: type: ChannelResourceIdentifier description: | - Used to [select](ctp:api:type:LineItemPriceSelection) a Product Price. + Used to [select](/../api/pricing-and-discounts-overview#line-item-price-selection) a Product Price. The Channel must have the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum). If the Cart is bound to a [Store](ctp:api:type:Store) with `distributionChannels` set, diff --git a/api-specs/api/types/me/updates/MyCartAddLineItemAction.raml b/api-specs/api/types/me/updates/MyCartAddLineItemAction.raml index 9f0a4fbc87..f569655558 100644 --- a/api-specs/api/types/me/updates/MyCartAddLineItemAction.raml +++ b/api-specs/api/types/me/updates/MyCartAddLineItemAction.raml @@ -7,7 +7,8 @@ example: !include ../../../examples/Cart/CartAddLineItemAction.json description: | If the Cart contains a [LineItem](ctp:api:type:LineItem) for a Product Variant with the same [LineItemMode](ctp:api:type:LineItemMode), [Custom Fields](/../api/projects/custom-fields), supply and distribution channel, then only the quantity of the existing Line Item is increased. If [LineItem](ctp:api:type:LineItem) `shippingDetails` is set, it is merged. All addresses will be present afterwards and, for address keys present in both shipping details, the quantity will be summed up. - The [LineItem](ctp:api:type:LineItem) price is set as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + A new Line Item is added when the `externalPrice` or `externalTotalPrice` is set in this update action. + The [LineItem](ctp:api:type:LineItem) price is set as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). If the Tax Rate is not set, a [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) error is returned. @@ -57,7 +58,7 @@ properties: distributionChannel?: type: ChannelResourceIdentifier description: | - Used to [select](ctp:api:type:LineItemPriceSelection) a Product Price. + Used to [select](/../api/pricing-and-discounts-overview#line-item-price-selection) a Product Price. The Channel must have the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum). If the Cart is bound to a [Store](ctp:api:type:Store) with `distributionChannels` set, the Channel must match one of the Store's distribution channels. supplyChannel?: diff --git a/api-specs/api/types/me/updates/MyCartRemoveLineItemAction.raml b/api-specs/api/types/me/updates/MyCartRemoveLineItemAction.raml index afceaa1afb..65e6055ae4 100644 --- a/api-specs/api/types/me/updates/MyCartRemoveLineItemAction.raml +++ b/api-specs/api/types/me/updates/MyCartRemoveLineItemAction.raml @@ -5,7 +5,7 @@ displayName: MyCartRemoveLineItemAction discriminatorValue: removeLineItem example: !include ../../../examples/Cart/CartRemoveLineItemAction.json description: | - The [LineItem](ctp:api:type:LineItem) price is updated as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + The [LineItem](ctp:api:type:LineItem) price is updated as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). properties: lineItemId?: type: string diff --git a/api-specs/api/types/me/updates/MyCartSetLineItemDistributionChannelAction.raml b/api-specs/api/types/me/updates/MyCartSetLineItemDistributionChannelAction.raml index 086b953eb9..f02657afac 100644 --- a/api-specs/api/types/me/updates/MyCartSetLineItemDistributionChannelAction.raml +++ b/api-specs/api/types/me/updates/MyCartSetLineItemDistributionChannelAction.raml @@ -5,7 +5,7 @@ displayName: MyCartSetLineItemDistributionChannelAction discriminatorValue: setLineItemDistributionChannel example: !include ../../../examples/Cart/CartSetLineItemDistributionChannelAction.json description: | - Setting a distribution channel for a [LineItem](ctp:api:type:LineItem) can lead to an updated `price` as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + Setting a distribution channel for a [LineItem](ctp:api:type:LineItem) can lead to an updated `price` as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). properties: lineItemId?: type: string diff --git a/api-specs/api/types/me/updates/MyCartSetShippingAddressAction.raml b/api-specs/api/types/me/updates/MyCartSetShippingAddressAction.raml index cb1f2d38fb..d028f77cea 100644 --- a/api-specs/api/types/me/updates/MyCartSetShippingAddressAction.raml +++ b/api-specs/api/types/me/updates/MyCartSetShippingAddressAction.raml @@ -7,7 +7,7 @@ example: !include ../../../examples/Cart/CartSetShippingAddressAction.json description: | Setting the shipping address also sets the [TaxRate](ctp:api:type:TaxRate) of Line Items and calculates the [TaxedPrice](ctp:api:type:TaxedPrice). - If a matching price cannot be found for the given shipping address during [Line Item Price selection](ctp:api:type:LineItemPriceSelection), + If a matching price cannot be found for the given shipping address during [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection), a [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) error is returned. If you want to allow shipping to states inside a country that are not explicitly covered by a TaxRate, diff --git a/api-specs/api/types/message/ProductPriceAddedMessage.raml b/api-specs/api/types/message/ProductPriceAddedMessage.raml index f496b55d65..f8bca5b020 100644 --- a/api-specs/api/types/message/ProductPriceAddedMessage.raml +++ b/api-specs/api/types/message/ProductPriceAddedMessage.raml @@ -14,7 +14,7 @@ properties: price: type: Price description: | - The [Embedded Price](/projects/products#embedded-price) that was added to the [ProductVariant](ctp:api:type:ProductVariant). + The Embedded Price that was added to the [ProductVariant](ctp:api:type:ProductVariant). staged: type: boolean description: | diff --git a/api-specs/api/types/message/ProductPriceChangedMessage.raml b/api-specs/api/types/message/ProductPriceChangedMessage.raml index 49d65aae85..ba79df3411 100644 --- a/api-specs/api/types/message/ProductPriceChangedMessage.raml +++ b/api-specs/api/types/message/ProductPriceChangedMessage.raml @@ -14,11 +14,11 @@ properties: oldPrice: type: Price description: | - The current [Embedded Price](/projects/products#embedded-price) before the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action. + The current Embedded Price before the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action. newPrice: type: Price description: | - The [Embedded Price](/projects/products#embedded-price) after the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action. + The Embedded Price after the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action. staged: type: boolean description: | @@ -26,4 +26,4 @@ properties: oldStagedPrice?: type: Price description: | - The staged [Embedded Price](/projects/products#embedded-price) before the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action. + The staged Embedded Price before the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action. diff --git a/api-specs/api/types/message/ProductPriceDiscountsSetUpdatedPrice.raml b/api-specs/api/types/message/ProductPriceDiscountsSetUpdatedPrice.raml index dc66c7a695..5fd8d1a737 100644 --- a/api-specs/api/types/message/ProductPriceDiscountsSetUpdatedPrice.raml +++ b/api-specs/api/types/message/ProductPriceDiscountsSetUpdatedPrice.raml @@ -3,7 +3,7 @@ type: object displayName: ProductPriceDiscountsSetUpdatedPrice description: | - Details about a [Embedded Price](/projects/products#embedded-price) that was updated due to a Discount. Specific to [Product Price Discounts Set](ctp:api:type:ProductPriceDiscountsSetMessage) Message. + Details about an [Embedded Price](ctp:api:type:Price) that was updated due to a Discount. Specific to [Product Price Discounts Set](ctp:api:type:ProductPriceDiscountsSetMessage) Message. properties: variantId: type: integer diff --git a/api-specs/api/types/message/ProductPriceRemovedMessage.raml b/api-specs/api/types/message/ProductPriceRemovedMessage.raml index 61a30ef54a..fa0a3e9651 100644 --- a/api-specs/api/types/message/ProductPriceRemovedMessage.raml +++ b/api-specs/api/types/message/ProductPriceRemovedMessage.raml @@ -14,7 +14,7 @@ properties: price: type: Price description: | - The [Embedded Price](/projects/products#embedded-price) that was removed from the [ProductVariant](ctp:api:type:ProductVariant). + The Embedded Price that was removed from the [ProductVariant](ctp:api:type:ProductVariant). staged: type: boolean description: | diff --git a/api-specs/api/types/message/payload/ProductPriceAddedMessagePayload.raml b/api-specs/api/types/message/payload/ProductPriceAddedMessagePayload.raml index 7b18fe3d52..80f3dfd58d 100644 --- a/api-specs/api/types/message/payload/ProductPriceAddedMessagePayload.raml +++ b/api-specs/api/types/message/payload/ProductPriceAddedMessagePayload.raml @@ -14,7 +14,7 @@ properties: price: type: Price description: | - The [Embedded Price](/projects/products#embedded-price) that was added to the [ProductVariant](ctp:api:type:ProductVariant). + The Embedded Price that was added to the [ProductVariant](ctp:api:type:ProductVariant). staged: type: boolean description: | diff --git a/api-specs/api/types/message/payload/ProductPriceChangedMessagePayload.raml b/api-specs/api/types/message/payload/ProductPriceChangedMessagePayload.raml index 4e6c800dcc..0d375f811c 100644 --- a/api-specs/api/types/message/payload/ProductPriceChangedMessagePayload.raml +++ b/api-specs/api/types/message/payload/ProductPriceChangedMessagePayload.raml @@ -14,11 +14,11 @@ properties: oldPrice: type: Price description: | - The current [Embedded Price](/projects/products#embedded-price) before the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action. + The current Embedded Price before the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action. newPrice: type: Price description: | - The [Embedded Price](/projects/products#embedded-price) after the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action. + The Embedded Price after the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action. staged: type: boolean description: | @@ -26,4 +26,4 @@ properties: oldStagedPrice?: type: Price description: | - The staged [Embedded Price](/projects/products#embedded-price) before the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action. + The staged Embedded Price before the [Change Embedded Price](ctp:api:type:ProductChangePriceAction) update action. diff --git a/api-specs/api/types/message/payload/ProductPriceRemovedMessagePayload.raml b/api-specs/api/types/message/payload/ProductPriceRemovedMessagePayload.raml index a5b8f74454..800abeb98c 100644 --- a/api-specs/api/types/message/payload/ProductPriceRemovedMessagePayload.raml +++ b/api-specs/api/types/message/payload/ProductPriceRemovedMessagePayload.raml @@ -14,7 +14,7 @@ properties: price: type: Price description: | - The [Embedded Price](/projects/products#embedded-price) that was removed from the [ProductVariant](ctp:api:type:ProductVariant). + The Embedded Price that was removed from the [ProductVariant](ctp:api:type:ProductVariant). staged: type: boolean description: | diff --git a/api-specs/api/types/order-edit/updates/StagedOrderAddLineItemAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderAddLineItemAction.raml index a322d804f1..9f83be00f1 100644 --- a/api-specs/api/types/order-edit/updates/StagedOrderAddLineItemAction.raml +++ b/api-specs/api/types/order-edit/updates/StagedOrderAddLineItemAction.raml @@ -8,7 +8,7 @@ description: | If the Cart contains a [LineItem](ctp:api:type:LineItem) for a Product Variant with the same [LineItemMode](ctp:api:type:LineItemMode), [Custom Fields](/../api/projects/custom-fields), supply and distribution channel, then only the quantity of the existing Line Item is increased. If [LineItem](ctp:api:type:LineItem) `shippingDetails` is set, it is merged. All addresses will be present afterwards and, for address keys present in both shipping details, the quantity will be summed up. A new Line Item is added when the `externalPrice` or `externalTotalPrice` is set in this update action. - The [LineItem](ctp:api:type:LineItem) price is set as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + The [LineItem](ctp:api:type:LineItem) price is set as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). If the Tax Rate is not set, a [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) error is returned. @@ -57,7 +57,7 @@ properties: distributionChannel?: type: ChannelResourceIdentifier description: | - Used to [select](/../api/carts-orders-overview#line-item-price-selection) a Product Price. + Used to [select](/../api/pricing-and-discounts-overview#line-item-price-selection) a Product Price. The Channel must have the `ProductDistribution` [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum). If the Cart is bound to a [Store](ctp:api:type:Store) with `distributionChannels` set, the Channel must match one of the Store's distribution channels. supplyChannel?: diff --git a/api-specs/api/types/order-edit/updates/StagedOrderChangeLineItemQuantityAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderChangeLineItemQuantityAction.raml index 4917d0deb5..c3fa4f9b1e 100644 --- a/api-specs/api/types/order-edit/updates/StagedOrderChangeLineItemQuantityAction.raml +++ b/api-specs/api/types/order-edit/updates/StagedOrderChangeLineItemQuantityAction.raml @@ -9,7 +9,7 @@ description: | To change the Line Item quantity and shipping details together, use this update action in combination with the [Set LineItem ShippingDetails](ctp:api:type:StagedOrderSetLineItemShippingDetailsAction) update action in a single Order update command. - The [LineItem](ctp:api:type:LineItem) price is updated as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + The [LineItem](ctp:api:type:LineItem) price is updated as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). properties: lineItemId?: type: string @@ -32,7 +32,7 @@ properties: Required when the Line Item uses `ExternalPrice` [LineItemPriceMode](ctp:api:type:LineItemPriceMode). Sets the [LineItem](ctp:api:type:LineItem) `price` to the given value when changing the quantity of a Line Item. - The [LineItem](ctp:api:type:LineItem) price is updated as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + The [LineItem](ctp:api:type:LineItem) price is updated as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). externalTotalPrice?: type: ExternalLineItemTotalPrice description: | diff --git a/api-specs/api/types/order-edit/updates/StagedOrderRemoveLineItemAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderRemoveLineItemAction.raml index a11447a47a..2338de8055 100644 --- a/api-specs/api/types/order-edit/updates/StagedOrderRemoveLineItemAction.raml +++ b/api-specs/api/types/order-edit/updates/StagedOrderRemoveLineItemAction.raml @@ -5,7 +5,7 @@ type: StagedOrderUpdateAction displayName: StagedOrderRemoveLineItemAction discriminatorValue: removeLineItem description: | - The [LineItem](ctp:api:type:LineItem) price is updated as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + The [LineItem](ctp:api:type:LineItem) price is updated as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). properties: lineItemId?: type: string diff --git a/api-specs/api/types/order-edit/updates/StagedOrderSetLineItemDistributionChannelAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderSetLineItemDistributionChannelAction.raml index 6e380702a2..3d34889540 100644 --- a/api-specs/api/types/order-edit/updates/StagedOrderSetLineItemDistributionChannelAction.raml +++ b/api-specs/api/types/order-edit/updates/StagedOrderSetLineItemDistributionChannelAction.raml @@ -5,7 +5,7 @@ type: StagedOrderUpdateAction displayName: StagedOrderSetLineItemDistributionChannelAction discriminatorValue: setLineItemDistributionChannel description: | - Setting a distribution channel for a [LineItem](ctp:api:type:LineItem) can lead to an updated `price` as described in [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + Setting a distribution channel for a [LineItem](ctp:api:type:LineItem) can lead to an updated `price` as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). Produces the [OrderLineItemDistributionChannelSet](ctp:api:type:OrderLineItemDistributionChannelSetMessage) Message. properties: diff --git a/api-specs/api/types/order/LineItemImportDraft.raml b/api-specs/api/types/order/LineItemImportDraft.raml index 11e4680dab..547b4de70f 100644 --- a/api-specs/api/types/order/LineItemImportDraft.raml +++ b/api-specs/api/types/order/LineItemImportDraft.raml @@ -41,7 +41,7 @@ properties: distributionChannel?: type: ChannelResourceIdentifier description: |- - The Channel used to [select a Price](ctp:api:type:LineItemPriceSelection). + The Channel used to [select a Price](/../api/pricing-and-discounts-overview#line-item-price-selection). This Channel must have the `ProductDistribution` role. supplyChannel?: type: ChannelResourceIdentifier diff --git a/api-specs/api/types/order/Order.raml b/api-specs/api/types/order/Order.raml index 9a1d0e4b74..873ecf56d1 100644 --- a/api-specs/api/types/order/Order.raml +++ b/api-specs/api/types/order/Order.raml @@ -37,7 +37,7 @@ properties: type: CustomerGroupReference description: |- [Reference](ctp:api:type:Reference) to the Customer Group of the Customer that the Order belongs to. - Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + Used for [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). anonymousId?: type: string description: | @@ -166,7 +166,7 @@ properties: country?: type: CountryCode description: |- - Used for [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + Used for [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). locale?: type: Locale description: | diff --git a/api-specs/api/types/product-search/ProductSearchProjectionParams.raml b/api-specs/api/types/product-search/ProductSearchProjectionParams.raml index 1408908fa7..556625187c 100644 --- a/api-specs/api/types/product-search/ProductSearchProjectionParams.raml +++ b/api-specs/api/types/product-search/ProductSearchProjectionParams.raml @@ -16,19 +16,19 @@ properties: priceCurrency?: type: CurrencyCode description: | - The currency used for [Price selection](/projects/products#price-selection). + The currency used for [Product price selection](/../api/pricing-and-discounts-overview#product-price-selection). priceCountry?: type: CountryCode description: | - The country used for [Price selection](/projects/products#price-selection). Can only be used **in conjunction with** the `priceCurrency` parameter. + The country used for [Product price selection](/../api/pricing-and-discounts-overview#product-price-selection). Can only be used **in conjunction with** the `priceCurrency` parameter. priceCustomerGroup?: type: string description: | - `id` of an existing [CustomerGroup](ctp:api:type:CustomerGroup) used for [Price selection](ctp:api:type:ProductPriceSelection). Can only be used **in conjunction with** the `priceCurrency` parameter. + `id` of an existing [CustomerGroup](ctp:api:type:CustomerGroup) used for [Product price selection](/../api/pricing-and-discounts-overview#product-price-selection). Can only be used **in conjunction with** the `priceCurrency` parameter. priceChannel?: type: string description: | - `id` of an existing [Channel](ctp:api:type:Channel) used for [Price selection](ctp:api:type:ProductPriceSelection). Can only be used **in conjunction with** the `priceCurrency` parameter. + `id` of an existing [Channel](ctp:api:type:Channel) used for [Product price selection](/../api/pricing-and-discounts-overview#product-price-selection). Can only be used **in conjunction with** the `priceCurrency` parameter. localeProjection?: type: Locale[] description: | diff --git a/api-specs/api/types/product/ProductPriceModeEnum.raml b/api-specs/api/types/product/ProductPriceModeEnum.raml index 4d1b9eb706..e67c224d2c 100644 --- a/api-specs/api/types/product/ProductPriceModeEnum.raml +++ b/api-specs/api/types/product/ProductPriceModeEnum.raml @@ -4,7 +4,8 @@ displayName: ProductPriceModeEnum type: string description: | - This mode determines the type of Prices used for [Product Price Selection](ctp:api:type:ProductPriceSelection) and for [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + This mode determines the type of Prices used for [price selection](/../api/pricing-and-discounts-overview#price-selection) by Line Items and Products. + For more information about the difference between the Prices, see [Pricing](/../api/pricing-and-discounts-overview). (enumDescriptions): Embedded: Composable Commerce uses the [Embedded Prices](ctp:api:type:Price) located inside the `prices` field in [ProductVariant](ctp:api:type:ProductVariant). Standalone: Composable Commerce uses [StandalonePrices](ctp:api:type:StandalonePrice), which are associated with the [ProductVariant](ctp:api:type:ProductVariant) through the `sku` field. diff --git a/api-specs/api/types/product/ProductVariant.raml b/api-specs/api/types/product/ProductVariant.raml index 938c3141d4..a8b64090e9 100644 --- a/api-specs/api/types/product/ProductVariant.raml +++ b/api-specs/api/types/product/ProductVariant.raml @@ -32,7 +32,7 @@ properties: price?: type: Price description: | - Only available when [Price selection](#price-selection) is used. + Only available when [price selection](/../api/pricing-and-discounts-overview#price-selection) is used. Cannot be used in a [Query Predicate](ctp:api:type:QueryPredicate). images?: type: Image[] @@ -57,10 +57,10 @@ properties: type: ScopedPrice description: | Only available in response to a [Product Projection Search](ctp:api:type:ProductProjectionSearch) request - with [price selection](ctp:api:type:ProductPriceSelection). + with [Product price selection](/../api/pricing-and-discounts-overview#product-price-selection). Can be used to sort, [filter](ctp:api:type:ProductProjectionSearchFilterScopedPrice), and facet. scopedPriceDiscounted?: type: boolean description: | Only available in response to a [Product Projection Search](ctp:api:type:ProductProjectionSearchFilterScopedPrice) request - with [price selection](ctp:api:type:ProductPriceSelection). + with [Product price selection](/../api/pricing-and-discounts-overview#product-price-selection). diff --git a/api-specs/api/types/product/updates/ProductSetPriceKeyAction.raml b/api-specs/api/types/product/updates/ProductSetPriceKeyAction.raml index 2375764839..3863cf37f3 100644 --- a/api-specs/api/types/product/updates/ProductSetPriceKeyAction.raml +++ b/api-specs/api/types/product/updates/ProductSetPriceKeyAction.raml @@ -5,7 +5,7 @@ displayName: ProductSetPriceKeyAction discriminatorValue: setPriceKey example: !include ../../../examples/Product/ProductSetPriceKeyAction.json description: | - Sets the key of an [Embedded Price](/projects/products#embedded-price). Produces the [ProductPriceKeySet](ctp:api:type:ProductPriceKeySetMessage) Message. + Sets the key of an [Embedded Price](ctp:api:type:Price). Produces the [ProductPriceKeySet](ctp:api:type:ProductPriceKeySetMessage) Message. properties: priceId: type: string @@ -14,7 +14,7 @@ properties: staged?: type: boolean description: | - If `true`, only the staged [Embedded Price](/projects/products#embedded-price) is updated. If `false`, both the current and staged Embedded Price are updated. + If `true`, only the staged [Embedded Price](ctp:api:type:Price) is updated. If `false`, both the current and staged Embedded Price are updated. default: true key?: type: string diff --git a/api-specs/api/types/standalone-price/StandalonePrice.raml b/api-specs/api/types/standalone-price/StandalonePrice.raml index 5e3c255d48..91f5737d71 100644 --- a/api-specs/api/types/standalone-price/StandalonePrice.raml +++ b/api-specs/api/types/standalone-price/StandalonePrice.raml @@ -76,7 +76,7 @@ properties: discounted?: type: DiscountedPrice description: | - Set if a matching [ProductDiscount](ctp:api:type:ProductDiscount) exists. If set, the API uses the `discounted` value for the [LineItem Price selection](ctp:api:type:LineItemPriceSelection). + Set if a matching [ProductDiscount](ctp:api:type:ProductDiscount) exists. If set, the API uses the `discounted` value for the [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection). When a [relative discount](/../api/projects/productDiscounts#productdiscountvaluerelative) is applied and the fraction part of the `discounted` price is 0.5, the discounted price is rounded in favor of the customer with the [half down rounding](https://en.wikipedia.org/wiki/Rounding#Round_half_down). custom?: type: CustomFields @@ -90,5 +90,5 @@ properties: type: boolean default: true description: | - If set to `true`, the StandalonePrice is considered during [price selection](ctp:api:type:ProductPriceSelection). - If set to `false`, the StandalonePrice is not considered during [price selection](ctp:api:type:ProductPriceSelection). + If set to `true`, the StandalonePrice is considered during [Product price selection](/../api/pricing-and-discounts-overview#product-price-selection). + If set to `false`, the StandalonePrice is not considered during [Product price selection](/../api/pricing-and-discounts-overview#product-price-selection). diff --git a/api-specs/api/types/standalone-price/StandalonePriceDraft.raml b/api-specs/api/types/standalone-price/StandalonePriceDraft.raml index d97a592b9e..60eff524a8 100644 --- a/api-specs/api/types/standalone-price/StandalonePriceDraft.raml +++ b/api-specs/api/types/standalone-price/StandalonePriceDraft.raml @@ -2,10 +2,6 @@ (package): StandalonePrice displayName: StandalonePriceDraft type: object -description: |- - Standalone Prices are defined with a scope consisting of `currency` and optionally `country`, `customerGroup`, and `channel` and/or a validity period (`validFrom` and/or `validTo`). For more information see [price selection](/../api/projects/products#price-selection). - - Creating a Standalone Price for an SKU which has a Standalone Price with exactly the same price scope, or with overlapping validity periods within the same price scope returns the [DuplicateStandalonePriceScope](ctp:api:type:DuplicateStandalonePriceScopeError) and [OverlappingStandalonePriceValidity](ctp:api:type:OverlappingStandalonePriceValidityError) errors, respectively. A Price without validity period does not conflict with a Price defined for a time period. properties: key?: type: string @@ -65,4 +61,4 @@ properties: type: boolean default: true description: | - Set to `false`, if the StandalonePrice should not be considered during [price selection](ctp:api:type:ProductPriceSelection). + Set to `false`, if the StandalonePrice should not be considered during [Prodct price selection](/../api/pricing-and-discounts-overview#product-price-selection). diff --git a/api-specs/api/types/standalone-price/StandalonePricePagedQueryResponse.raml b/api-specs/api/types/standalone-price/StandalonePricePagedQueryResponse.raml index 803f186277..8d130faa15 100644 --- a/api-specs/api/types/standalone-price/StandalonePricePagedQueryResponse.raml +++ b/api-specs/api/types/standalone-price/StandalonePricePagedQueryResponse.raml @@ -2,6 +2,8 @@ (package): StandalonePrice displayName: StandalonePricePagedQueryResponse type: object +description: | + [PagedQueryResult](/general-concepts#pagedqueryresult) with `results` containing an array of [StandalonePrice](ctp:api:type:StandalonePrice). properties: limit: type: number diff --git a/api-specs/api/types/type/ResourceTypeId.raml b/api-specs/api/types/type/ResourceTypeId.raml index 788e7a1548..9adff3c82e 100644 --- a/api-specs/api/types/type/ResourceTypeId.raml +++ b/api-specs/api/types/type/ResourceTypeId.raml @@ -83,7 +83,7 @@ enum: payment-interface-interaction: | [InterfaceInteraction](ctp:api:type:PaymentAddInterfaceInteractionAction) on [Payment](ctp:api:type:Payment) product-price: | - [Embedded Price](/projects/products#embedded-price) on [ProductVariant](ctp:api:type:ProductVariant) + [Embedded Price](ctp:api:type:Price) on [ProductVariant](ctp:api:type:ProductVariant) product-selection: | [ProductSelection](ctp:api:type:ProductSelection) quote: |