Updated API from documentation release

ct-sdks[bot] · ct-sdks[bot] · commit 86902295ef43 · 2025-04-28T12:39:15.000Z
diff --git a/api-specs/api/types/business-unit/BusinessUnitDraft.raml b/api-specs/api/types/business-unit/BusinessUnitDraft.raml
@@ -60,7 +60,7 @@ properties:
       For [Companies](ctp:api:type:BusinessUnitType), the value of this field is always `Explicit`.
       For [Divisions](ctp:api:type:BusinessUnitType), the default value is `ExplicitAndFromParent`.
   addresses?:
-    type: BaseAddress[]
+    type: AddressDraft[]
     description: |
       Addresses used by the Business Unit.
   shippingAddresses?:
diff --git a/api-specs/api/types/business-unit/updates/BusinessUnitAddAddressAction.raml b/api-specs/api/types/business-unit/updates/BusinessUnitAddAddressAction.raml
@@ -8,6 +8,6 @@ description: |
   Adding an address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAddressAdded](ctp:api:type:BusinessUnitAddressAddedMessage) Message.
 properties:
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Address to add to the addresses of the [Business Unit](ctp:api:type:BusinessUnit).
diff --git a/api-specs/api/types/business-unit/updates/BusinessUnitChangeAddressAction.raml b/api-specs/api/types/business-unit/updates/BusinessUnitChangeAddressAction.raml
@@ -16,6 +16,6 @@ properties:
     description: |
       Key of the address to change. Either `addressId` or `addressKey` is required.
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       New address to set.
diff --git a/api-specs/api/types/cart/CartDraft.raml b/api-specs/api/types/cart/CartDraft.raml
@@ -74,11 +74,11 @@ properties:
       Determines how stock quantities are tracked for Line Items in the Cart.
     default: None
   billingAddress?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Billing address associated with the Cart.
   shippingAddress?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       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.
       Must be one of the `itemShippingAddresses` when that field is also provided.
@@ -110,7 +110,7 @@ properties:
     description: |-
       Shipping Methods for a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
   itemShippingAddresses?:
-    type: BaseAddress[]
+    type: AddressDraft[]
     description: |
       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`.
diff --git a/api-specs/api/types/cart/CustomShippingDraft.raml b/api-specs/api/types/cart/CustomShippingDraft.raml
@@ -12,7 +12,7 @@ properties:
     description: |
       Name of the custom Shipping Method.
   shippingAddress?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Determines the shipping rate and Tax Rate of the associated Line Items.
   shippingRate:
diff --git a/api-specs/api/types/cart/ShippingDraft.raml b/api-specs/api/types/cart/ShippingDraft.raml
@@ -14,7 +14,7 @@ properties:
     description: |
       Shipping Methods added to the Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
   shippingAddress:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Determines the shipping rate and Tax Rate of the associated Line Items.
   shippingRateInput?:
diff --git a/api-specs/api/types/cart/updates/CartAddCustomShippingMethodAction.raml b/api-specs/api/types/cart/updates/CartAddCustomShippingMethodAction.raml
@@ -17,7 +17,7 @@ properties:
     description: |
       Name of the custom Shipping Method.
   shippingAddress:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Determines the shipping rate and Tax Rate of the associated Line Items.
   shippingRate:
diff --git a/api-specs/api/types/cart/updates/CartAddItemShippingAddressAction.raml b/api-specs/api/types/cart/updates/CartAddItemShippingAddressAction.raml
@@ -8,7 +8,7 @@ description: |
   Adds an address to a Cart when shipping to multiple addresses is desired.
 properties:
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Address to append to `itemShippingAddresses`.
 
diff --git a/api-specs/api/types/cart/updates/CartAddShippingMethodAction.raml b/api-specs/api/types/cart/updates/CartAddShippingMethodAction.raml
@@ -17,7 +17,7 @@ properties:
       ResourceIdentifier to a [ShippingMethod](ctp:api:type:ShippingMethod) to add to the Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
       If the referenced Shipping Method has a predicate that does not match the Cart, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
   shippingAddress:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Determines the shipping rate and Tax Rate of the Line Items.
   shippingRateInput?:
diff --git a/api-specs/api/types/cart/updates/CartSetBillingAddressAction.raml b/api-specs/api/types/cart/updates/CartSetBillingAddressAction.raml
@@ -6,7 +6,7 @@ discriminatorValue: setBillingAddress
 example: !include ../../../examples/Cart/CartSetBillingAddressAction.json
 properties:
   address?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Value to set.
       If empty, any existing value is removed.
diff --git a/api-specs/api/types/cart/updates/CartSetShippingAddressAction.raml b/api-specs/api/types/cart/updates/CartSetShippingAddressAction.raml
@@ -15,7 +15,7 @@ description: |
   the [Change CountryTaxRateFallbackEnabled](ctp:api:type:ProjectChangeCountryTaxRateFallbackEnabledAction) update action.
 properties:
   address?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Value to set.
       If not set, the shipping address is unset, and the `taxedPrice` and `taxRate` are unset in all Line Items of the Cart.
diff --git a/api-specs/api/types/cart/updates/CartUpdateItemShippingAddressAction.raml b/api-specs/api/types/cart/updates/CartUpdateItemShippingAddressAction.raml
@@ -8,6 +8,6 @@ description: |
   Updates an address in `itemShippingAddresses` by keeping the Address `key`.
 properties:
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       The new Address with the same `key` as the Address it will replace.
diff --git a/api-specs/api/types/channel/ChannelDraft.raml b/api-specs/api/types/channel/ChannelDraft.raml
@@ -22,7 +22,7 @@ properties:
     description: |
       Description of the Channel.
   address?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Address where the Channel is located.
   custom?:
diff --git a/api-specs/api/types/channel/updates/ChannelSetAddressAction.raml b/api-specs/api/types/channel/updates/ChannelSetAddressAction.raml
@@ -6,6 +6,6 @@ discriminatorValue: setAddress
 example: !include ../../../examples/Channel/ChannelSetAddressAction.json
 properties:
   address?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Value to set. If empty, any existing value will be removed.
diff --git a/api-specs/api/types/common/Address.raml b/api-specs/api/types/common/Address.raml
@@ -2,9 +2,6 @@
 (package): Common
 displayName: Address
 type: BaseAddress
-description: |
-  Address type returned by read methods.
-  Optionally, the `custom` field can be present in addition to the fields of a [BaseAddress](ctp:api:type:BaseAddress).
 properties:
   custom?:
     type: CustomFields
diff --git a/api-specs/api/types/common/AddressDraft.raml b/api-specs/api/types/common/AddressDraft.raml
@@ -3,9 +3,6 @@
 displayName: AddressDraft
 type: BaseAddress
 example: !include ../../examples/Common/AddressDraft.json
-description: |
-  Address type to be used on write methods.
-  Optionally, use the `custom` field in addition to the fields of a [BaseAddress](ctp:api:type:BaseAddress).
 properties:
   custom?:
     type: CustomFieldsDraft
diff --git a/api-specs/api/types/customer/CustomerDraft.raml b/api-specs/api/types/customer/CustomerDraft.raml
@@ -76,7 +76,7 @@ properties:
     description: |
       Individual VAT ID of the Customer.
   addresses?:
-    type: BaseAddress[]
+    type: AddressDraft[]
     description: |
       Addresses of the Customer.
   defaultShippingAddress?:
diff --git a/api-specs/api/types/customer/updates/CustomerAddAddressAction.raml b/api-specs/api/types/customer/updates/CustomerAddAddressAction.raml
@@ -8,6 +8,6 @@ description: |
   Adding an address to the Customer produces the [CustomerAddressAdded](ctp:api:type:CustomerAddressAddedMessage) Message.
 properties:
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Value to append to the `addresses` array.
diff --git a/api-specs/api/types/customer/updates/CustomerChangeAddressAction.raml b/api-specs/api/types/customer/updates/CustomerChangeAddressAction.raml
@@ -18,6 +18,6 @@ properties:
     description: |
       `key` of the [Address](ctp:api:type:Address) to change.
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Value to set.
diff --git a/api-specs/api/types/me/MyBusinessUnitDraft.raml b/api-specs/api/types/me/MyBusinessUnitDraft.raml
@@ -27,7 +27,7 @@ properties:
     description: |
       Custom Fields for the Business Unit.
   addresses?:
-    type: BaseAddress[]
+    type: AddressDraft[]
     description: |
       Addresses used by the Business Unit.
   shippingAddresses?:
diff --git a/api-specs/api/types/me/MyCartDraft.raml b/api-specs/api/types/me/MyCartDraft.raml
@@ -39,19 +39,19 @@ properties:
       Determines how stock quantities are tracked for Line Items in the Cart.
     default: None
   billingAddress?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Billing address associated with the Cart.
   shippingAddress?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Shipping address associated with the Cart. Determines eligible [ShippingMethod](ctp:api:type:ShippingMethod) rates and Tax Rates of Line Items.
   shippingMethod?:
     type: ShippingMethodResourceIdentifier
     description: |
       Shipping Method for the Cart. If the referenced [ShippingMethod](ctp:api:type:ShippingMethod) has a `predicate` that does not match the Cart, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned when [creating a Cart](ctp:api:endpoint:/{projectKey}/carts:POST).
   itemShippingAddresses?:
-    type: BaseAddress[]
+    type: AddressDraft[]
     description: |
       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`.
diff --git a/api-specs/api/types/me/MyCustomerDraft.raml b/api-specs/api/types/me/MyCustomerDraft.raml
@@ -45,7 +45,7 @@ properties:
     description: |
       Individual VAT ID of the Customer.
   addresses?:
-    type: BaseAddress[]
+    type: AddressDraft[]
     description: |
       Addresses of the Customer.
   defaultShippingAddress?:
diff --git a/api-specs/api/types/me/updates/MyBusinessUnitAddAddressAction.raml b/api-specs/api/types/me/updates/MyBusinessUnitAddAddressAction.raml
@@ -8,6 +8,6 @@ description: |
   Adding an address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAddressAdded](ctp:api:type:BusinessUnitAddressAddedMessage) Message.
 properties:
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       The address to add to `addresses`.
diff --git a/api-specs/api/types/me/updates/MyBusinessUnitChangeAddressAction.raml b/api-specs/api/types/me/updates/MyBusinessUnitChangeAddressAction.raml
@@ -16,6 +16,6 @@ properties:
     description: |
       Key of the address to change. Either `addressId` or `addressKey` is required.
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       New address to set.
diff --git a/api-specs/api/types/me/updates/MyCartAddItemShippingAddressAction.raml b/api-specs/api/types/me/updates/MyCartAddItemShippingAddressAction.raml
@@ -8,7 +8,7 @@ description: |
   Adds an address to a Cart when shipping to multiple addresses is desired.
 properties:
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Address to append to `itemShippingAddresses`.
 
diff --git a/api-specs/api/types/me/updates/MyCartSetBillingAddressAction.raml b/api-specs/api/types/me/updates/MyCartSetBillingAddressAction.raml
@@ -6,7 +6,7 @@ discriminatorValue: setBillingAddress
 example: !include ../../../examples/Cart/CartSetBillingAddressAction.json
 properties:
   address?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Value to set.
       If empty, any existing value is removed.
diff --git a/api-specs/api/types/me/updates/MyCartSetShippingAddressAction.raml b/api-specs/api/types/me/updates/MyCartSetShippingAddressAction.raml
@@ -15,7 +15,7 @@ description: |
   the [Change CountryTaxRateFallbackEnabled](ctp:api:type:ProjectChangeCountryTaxRateFallbackEnabledAction) update action.
 properties:
   address?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Value to set.
       If not set, the shipping address is unset, and the `taxedPrice` and `taxRate` are unset in all Line Items.
diff --git a/api-specs/api/types/me/updates/MyCartUpdateItemShippingAddressAction.raml b/api-specs/api/types/me/updates/MyCartUpdateItemShippingAddressAction.raml
@@ -8,6 +8,6 @@ description: |
   Updates an address in `itemShippingAddresses` by keeping the Address `key`.
 properties:
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       The new Address with the same `key` as the Address it will replace.
diff --git a/api-specs/api/types/me/updates/MyCustomerAddAddressAction.raml b/api-specs/api/types/me/updates/MyCustomerAddAddressAction.raml
@@ -8,6 +8,6 @@ description: |
   Adding an address to the Customer produces the [CustomerAddressAdded](ctp:api:type:CustomerAddressAddedMessage) Message.
 properties:
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Value to append to the `addresses` array.
diff --git a/api-specs/api/types/me/updates/MyCustomerChangeAddressAction.raml b/api-specs/api/types/me/updates/MyCustomerChangeAddressAction.raml
@@ -18,6 +18,6 @@ properties:
     description: |
       `key` of the [Address](ctp:api:type:Address) to change.
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Value to set.
diff --git a/api-specs/api/types/order-edit/updates/StagedOrderAddDeliveryAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderAddDeliveryAction.raml
@@ -23,7 +23,7 @@ properties:
     description: |
       Items to be included in the Delivery.
   address?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Address the `parcels` should be delivered to.
   parcels?:
diff --git a/api-specs/api/types/order-edit/updates/StagedOrderAddItemShippingAddressAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderAddItemShippingAddressAction.raml
@@ -8,7 +8,7 @@ description: |
   Adds an address to an Order when shipping to multiple addresses is desired.
 properties:
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Address to append to `itemShippingAddresses`.
       The new Address must have a `key` that is unique across this Order.
diff --git a/api-specs/api/types/order-edit/updates/StagedOrderSetBillingAddressAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderSetBillingAddressAction.raml
@@ -10,7 +10,7 @@ description: |
   Produces the [Order Billing Address Set](ctp:api:type:OrderBillingAddressSetMessage) Message.
 properties:
   address?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Value to set.
       If empty, any existing value is removed.
diff --git a/api-specs/api/types/order-edit/updates/StagedOrderSetDeliveryAddressAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderSetDeliveryAddressAction.raml
@@ -20,7 +20,7 @@ properties:
 
       Either `deliveryId` or `deliveryKey` must be provided.
   address?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Value to set.
       If empty, any existing value will be removed.
diff --git a/api-specs/api/types/order-edit/updates/StagedOrderSetShippingAddressAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderSetShippingAddressAction.raml
@@ -11,7 +11,7 @@ description: |
   Produces the [Order Shipping Address Set](ctp:api:type:OrderShippingAddressSetMessage) Message.
 properties:
   address?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Value to set.
       If empty, any existing value is removed.
diff --git a/api-specs/api/types/order-edit/updates/StagedOrderSetShippingAddressAndCustomShippingMethodAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderSetShippingAddressAndCustomShippingMethodAction.raml
@@ -8,7 +8,7 @@ description: |
   Sets the shipping address and a custom Shipping Method together to prevent an inconsistent state.
 properties:
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Value to set for `shippingAddress`.
   shippingMethodName:
diff --git a/api-specs/api/types/order-edit/updates/StagedOrderSetShippingAddressAndShippingMethodAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderSetShippingAddressAndShippingMethodAction.raml
@@ -8,7 +8,7 @@ description: |
   Sets the shipping address and Shipping Method together to prevent an inconsistent state.
 properties:
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Value to set for `shippingAddress`.
   shippingMethod?:
diff --git a/api-specs/api/types/order-edit/updates/StagedOrderUpdateItemShippingAddressAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderUpdateItemShippingAddressAction.raml
@@ -8,6 +8,6 @@ description: |
   Updates an address in `itemShippingAddresses` by keeping the Address `key`.
 properties:
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       The new Address with the same `key` as the Address it will replace.
diff --git a/api-specs/api/types/order/OrderImportDraft.raml b/api-specs/api/types/order/OrderImportDraft.raml
@@ -75,15 +75,15 @@ properties:
     description: |
       Determines how stock quantities are tracked for Line Items in the Cart.
   billingAddress?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Billing address associated with the Order.
   shippingAddress?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Shipping address associated with the Order.
   itemShippingAddresses?:
-    type: BaseAddress[]
+    type: AddressDraft[]
     description: |
       Addresses for Orders with multiple shipping addresses. Addresses must include a value for `key`.
   shippingInfo?:
diff --git a/api-specs/api/types/order/updates/OrderAddDeliveryAction.raml b/api-specs/api/types/order/updates/OrderAddDeliveryAction.raml
@@ -23,7 +23,7 @@ properties:
     description: |
       Line Items or Custom Line Items to be included in the Delivery.
   address?:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Address the `parcels` should be delivered to.
   parcels?:
diff --git a/api-specs/api/types/order/updates/OrderAddItemShippingAddressAction.raml b/api-specs/api/types/order/updates/OrderAddItemShippingAddressAction.raml
@@ -8,7 +8,7 @@ description: |
   Adds an address to an Order when shipping to multiple addresses is desired.
 properties:
   address:
-    type: BaseAddress
+    type: AddressDraft
     description: |
       Address to append to `itemShippingAddresses`.
       The new Address must have a `key` that is unique across this Order.
diff --git a/api-specs/api/types/order/updates/OrderSetBillingAddressAction.raml b/api-specs/api/types/order/updates/OrderSetBillingAddressAction.raml
diff --git a/api-specs/api/types/order/updates/OrderSetDeliveryAddressAction.raml b/api-specs/api/types/order/updates/OrderSetDeliveryAddressAction.raml
diff --git a/api-specs/api/types/order/updates/OrderSetShippingAddressAction.raml b/api-specs/api/types/order/updates/OrderSetShippingAddressAction.raml
diff --git a/api-specs/api/types/order/updates/OrderUpdateItemShippingAddressAction.raml b/api-specs/api/types/order/updates/OrderUpdateItemShippingAddressAction.raml
