diff --git a/api-specs/api/types/common/CentPrecisionMoney.raml b/api-specs/api/types/common/CentPrecisionMoney.raml index 54f3924ab..e383ee6ca 100644 --- a/api-specs/api/types/common/CentPrecisionMoney.raml +++ b/api-specs/api/types/common/CentPrecisionMoney.raml @@ -3,8 +3,7 @@ displayName: CentPrecisionMoney type: TypedMoney discriminatorValue: centPrecision -description: | - Object that stores cent amounts in a specific currency. +description: Object that stores money in cent amounts of a specific currency. example: !include ../../examples/Common/CentPrecisionMoney.json properties: fractionDigits: diff --git a/api-specs/api/types/common/HighPrecisionMoney.raml b/api-specs/api/types/common/HighPrecisionMoney.raml index d5cc902e1..1a16a77ee 100644 --- a/api-specs/api/types/common/HighPrecisionMoney.raml +++ b/api-specs/api/types/common/HighPrecisionMoney.raml @@ -3,7 +3,7 @@ displayName: HighPrecisionMoney type: TypedMoney discriminatorValue: highPrecision -description: Money object that stores an amount of a fraction of the smallest indivisible unit of the specified currency. +description: Object that stores money as a fraction of the smallest indivisible unit of a specific currency. example: !include ../../examples/Common/HighPrecisionMoney.json properties: preciseAmount: diff --git a/api-specs/api/types/common/HighPrecisionMoneyDraft.raml b/api-specs/api/types/common/HighPrecisionMoneyDraft.raml index 9cd005340..aff2bff3a 100644 --- a/api-specs/api/types/common/HighPrecisionMoneyDraft.raml +++ b/api-specs/api/types/common/HighPrecisionMoneyDraft.raml @@ -3,7 +3,7 @@ displayName: HighPrecisionMoneyDraft type: TypedMoneyDraft discriminatorValue: highPrecision -description: Money draft object to store an amount of a fraction of the smallest indivisible unit of the specified currency. +description: Draft object to store money as a fraction of the smallest indivisible unit for a specific currency. example: !include ../../examples/Common/HighPrecisionMoneyDraft.json properties: fractionDigits: diff --git a/api-specs/api/types/common/Money.raml b/api-specs/api/types/common/Money.raml index 074a7fd6b..94c6e8f5c 100644 --- a/api-specs/api/types/common/Money.raml +++ b/api-specs/api/types/common/Money.raml @@ -2,8 +2,7 @@ (package): Common displayName: Money type: object -description: | - Draft type that stores amounts only in cent precision for the specified currency. +description: Draft object to store money in cent amounts for a specific currency. example: !include ../../examples/Common/Money.json (ignoreValidators): [PolymorphicSubtypesRule] properties: diff --git a/api-specs/api/types/message/OrderLineItemDiscountSetMessage.raml b/api-specs/api/types/message/OrderLineItemDiscountSetMessage.raml index 6e0bb9e1e..1e69914d1 100644 --- a/api-specs/api/types/message/OrderLineItemDiscountSetMessage.raml +++ b/api-specs/api/types/message/OrderLineItemDiscountSetMessage.raml @@ -19,7 +19,7 @@ properties: description: | Array of [DiscountedLineItemPriceForQuantity](ctp:api:type:DiscountedLineItemPriceForQuantity) after the Discount recalculation. totalPrice: - type: Money + type: CentPrecisionMoney description: | Total Price of the [Line Item](ctp:api:type:LineItem) after the Discount recalculation. taxedPrice?: diff --git a/api-specs/api/types/message/StandalonePriceValueChangedMessage.raml b/api-specs/api/types/message/StandalonePriceValueChangedMessage.raml index 24f9869c4..0892ed707 100644 --- a/api-specs/api/types/message/StandalonePriceValueChangedMessage.raml +++ b/api-specs/api/types/message/StandalonePriceValueChangedMessage.raml @@ -7,7 +7,7 @@ description: | Generated after a successful [Change Value](ctp:api:type:StandalonePriceChangeValueAction) update action. properties: value: - type: Money + type: TypedMoney description: | The new value of the updated [StandalonePrice](ctp:api:type:StandalonePrice). staged: @@ -16,7 +16,7 @@ properties: description: | Whether the new value was applied to the current or the staged representation of the StandalonePrice. Staged changes are stored on the [StagedStandalonePrice](ctp:api:type:StagedStandalonePrice). oldValue?: - type: Money + type: TypedMoney description: | The old value of the updated [StandalonePrice](ctp:api:type:StandalonePrice). Present on Messages created after 3 February 2023. Optional for backwards compatibility. diff --git a/api-specs/api/types/message/payload/OrderLineItemDiscountSetMessagePayload.raml b/api-specs/api/types/message/payload/OrderLineItemDiscountSetMessagePayload.raml index 2ea572434..ab83df9d3 100644 --- a/api-specs/api/types/message/payload/OrderLineItemDiscountSetMessagePayload.raml +++ b/api-specs/api/types/message/payload/OrderLineItemDiscountSetMessagePayload.raml @@ -19,7 +19,7 @@ properties: description: | Array of [DiscountedLineItemPriceForQuantity](ctp:api:type:DiscountedLineItemPriceForQuantity) after the Discount recalculation. totalPrice: - type: Money + type: CentPrecisionMoney description: | Total Price of the [Line Item](ctp:api:type:LineItem) after the Discount recalculation. taxedPrice?: diff --git a/api-specs/api/types/message/payload/StandalonePriceValueChangedMessagePayload.raml b/api-specs/api/types/message/payload/StandalonePriceValueChangedMessagePayload.raml index 3fa381f01..15f9b7675 100644 --- a/api-specs/api/types/message/payload/StandalonePriceValueChangedMessagePayload.raml +++ b/api-specs/api/types/message/payload/StandalonePriceValueChangedMessagePayload.raml @@ -7,7 +7,7 @@ description: | Generated after a successful [Change Value](ctp:api:type:StandalonePriceChangeValueAction) update action. properties: value: - type: Money + type: TypedMoney description: | The new value of the updated [StandalonePrice](ctp:api:type:StandalonePrice). staged: @@ -16,7 +16,7 @@ properties: description: | Whether the new value was applied to the current or the staged representation of the StandalonePrice. Staged changes are stored on the [StagedStandalonePrice](ctp:api:type:StagedStandalonePrice). oldValue?: - type: Money + type: TypedMoney description: | The old value of the updated [StandalonePrice](ctp:api:type:StandalonePrice). Present on Messages created after 3 February 2023. Optional for backwards compatibility. diff --git a/api-specs/api/types/shipping-method/ShippingRate.raml b/api-specs/api/types/shipping-method/ShippingRate.raml index dfa4c8b9a..ba0b7d45e 100644 --- a/api-specs/api/types/shipping-method/ShippingRate.raml +++ b/api-specs/api/types/shipping-method/ShippingRate.raml @@ -4,10 +4,10 @@ displayName: ShippingRate type: object properties: price: - type: TypedMoney + type: CentPrecisionMoney description: Currency amount of the ShippingRate. freeAbove?: - type: TypedMoney + type: CentPrecisionMoney description: |- [Free shipping](/../api/shipping-delivery-overview#free-shipping) is applied if the sum of the (Custom) Line Item Prices reaches the specified value. isMatching?: