Package com.commercetools.api.models.me
package com.commercetools.api.models.me
-
ClassDescriptionAdding an address to a Business Unit generates a BusinessUnitAddressAdded Message.MyBusinessUnitAddAddressActionBuilder Example to create an instance using the builder patternAdding a billing address to a Business Unit generates a BusinessUnitBillingAddressAdded Message.MyBusinessUnitAddBillingAddressIdActionBuilder Example to create an instance using the builder patternAdding a shipping address to a Business Unit generates a BusinessUnitShippingAddressAdded Message.MyBusinessUnitAddShippingAddressIdActionBuilder Example to create an instance using the builder patternMyBusinessUnitAssociateDraft Example to create an instance using the builder patternMyBusinessUnitAssociateDraftBuilder Example to create an instance using the builder patternChanging the address on a Business Unit generates the BusinessUnitAddressChanged Message.MyBusinessUnitChangeAddressActionBuilder Example to create an instance using the builder patternUpdating the Associate on a Business Unit generates the BusinessUnitAssociateChanged Message.MyBusinessUnitChangeAssociateActionBuilder Example to create an instance using the builder patternUpdating the name on a Business Unit generates a BusinessUnitNameChanged Message.MyBusinessUnitChangeNameActionBuilder Example to create an instance using the builder patternChanging the parent of a Business Unit generates a BusinessUnitParentChanged Message.MyBusinessUnitChangeParentUnitActionBuilder Example to create an instance using the builder patternMyBusinessUnitDraft Example to create a subtype instance using the builder patternMyBusinessUnitDraftBuilderRemoving the address from a Business Unit generates the BusinessUnitAddressRemoved Message.MyBusinessUnitRemoveAddressActionBuilder Example to create an instance using the builder patternRemoving an Associate from a Business Unit generates a BusinessUnitAssociateRemoved Message.MyBusinessUnitRemoveAssociateActionBuilder Example to create an instance using the builder patternRemoving a billing address from a Business Unit generates a BusinessUnitBillingAddressRemoved Message.MyBusinessUnitRemoveBillingAddressIdActionBuilder Example to create an instance using the builder patternRemoving a shipping address from a Business Unit generates a BusinessUnitShippingAddressRemoved Message.MyBusinessUnitRemoveShippingAddressIdActionBuilder Example to create an instance using the builder patternAdding a Custom Field to an Address of a Business Unit generates the BusinessUnitAddressCustomFieldAdded Message, removing one generates the BusinessUnitAddressCustomFieldRemoved Message, and updating an existing one generates the BusinessUnitAddressCustomFieldChanged Message.MyBusinessUnitSetAddressCustomFieldActionBuilder Example to create an instance using the builder patternAdding or updating a Custom Type to an Address of a Business Unit generates the BusinessUnitAddressCustomTypeSet Message, and removing one generates the BusinessUnitAddressCustomTypeRemoved Message.MyBusinessUnitSetAddressCustomTypeActionBuilder Example to create an instance using the builder patternSetting the contact email on a Business Unit generates a BusinessUnitContactEmailSet Message.MyBusinessUnitSetContactEmailActionBuilder Example to create an instance using the builder patternAdding a Custom Field to a Business Unit generates the BusinessUnitCustomFieldAdded Message, removing one generates the BusinessUnitCustomFieldRemoved Message, and updating an existing one generates the BusinessUnitCustomFieldChanged Message.MyBusinessUnitSetCustomFieldActionBuilder Example to create an instance using the builder patternAdding or updating a Custom Type on a Business Unit generates the BusinessUnitCustomTypeSet Message, removing one generates the BusinessUnitCustomTypeRemoved Message.MyBusinessUnitSetCustomTypeActionBuilder Example to create an instance using the builder patternSetting the default billing address on a Business Unit generates the BusinessUnitDefaultBillingAddressSet Message.MyBusinessUnitSetDefaultBillingAddressActionBuilder Example to create an instance using the builder patternSetting the default shipping address on a Business Unit generates a BusinessUnitDefaultShippingAddressSet Message.MyBusinessUnitSetDefaultShippingAddressActionBuilder Example to create an instance using the builder patternMyBusinessUnitUpdate Example to create an instance using the builder patternMyBusinessUnitUpdateAction Example to create a subtype instance using the builder patternMyBusinessUnitUpdateActionBuilderMyBusinessUnitUpdateBuilder Example to create an instance using the builder patternAdds a DiscountCode to the Cart to activate the related CartDiscounts.MyCartAddDiscountCodeActionBuilder Example to create an instance using the builder patternAdds an address to a Cart when shipping to multiple addresses is desired.MyCartAddItemShippingAddressActionBuilder Example to create an instance using the builder patternIf the Cart contains a LineItem for a Product Variant with the same LineItemMode, Custom Fields, supply and distribution channel, then only the quantity of the existing Line Item is increased.MyCartAddLineItemActionBuilder Example to create an instance using the builder patternMyCartAddPaymentAction Example to create an instance using the builder patternMyCartAddPaymentActionBuilder Example to create an instance using the builder patternTo override the shipping details, see Set LineItem ShippingDetails.MyCartApplyDeltaToLineItemShippingDetailsTargetsActionBuilder Example to create an instance using the builder patternWhen multiple shipping addresses are set for a Line Item, use the Remove LineItem and Add LineItem update action to change the shipping details.MyCartChangeLineItemQuantityActionBuilder Example to create an instance using the builder patternMyCartChangeLineItemsOrderAction Example to create an instance using the builder patternMyCartChangeLineItemsOrderActionBuilder Example to create an instance using the builder patternWhen
External
TaxMode is changed toPlatform
orDisabled
, all previously set external Tax Rates are removed. When set toPlatform
, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart'sshippingAddress
. Example to create an instance using the builder patternMyCartChangeTaxModeActionBuilder Example to create an instance using the builder patternThecustomerId
is determined by a password flow token and automatically set on the resulting Cart.MyCartDraftBuilder Example to create an instance using the builder patternThis update action does not set any Cart field in particular, but it triggers several Cart updates to bring prices and discounts to the latest state.MyCartRecalculateActionBuilder Example to create an instance using the builder patternMyCartRemoveDiscountCodeAction Example to create an instance using the builder patternMyCartRemoveDiscountCodeActionBuilder Example to create an instance using the builder patternAn address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.MyCartRemoveItemShippingAddressActionBuilder Example to create an instance using the builder patternThe LineItem price is updated as described in Line Item price selection.MyCartRemoveLineItemActionBuilder Example to create an instance using the builder patternMyCartRemovePaymentAction Example to create an instance using the builder patternMyCartRemovePaymentActionBuilder Example to create an instance using the builder patternMyCartSetBillingAddressAction Example to create an instance using the builder patternMyCartSetBillingAddressActionBuilder Example to create an instance using the builder patternUpdates the Business Unit on the Cart.MyCartSetBusinessUnitActionBuilder Example to create an instance using the builder patternSetting the country can lead to changes in the LineItem prices.MyCartSetCountryActionBuilder Example to create an instance using the builder patternMyCartSetCustomerEmailAction Example to create an instance using the builder patternMyCartSetCustomerEmailActionBuilder Example to create an instance using the builder patternMyCartSetCustomFieldAction Example to create an instance using the builder patternMyCartSetCustomFieldActionBuilder Example to create an instance using the builder patternMyCartSetCustomTypeAction Example to create an instance using the builder patternMyCartSetCustomTypeActionBuilder Example to create an instance using the builder patternNumber of days after which a Cart withActive
CartState is deleted since its last modification.MyCartSetDeleteDaysAfterLastModificationActionBuilder Example to create an instance using the builder patternMyCartSetLineItemCustomFieldAction Example to create an instance using the builder patternMyCartSetLineItemCustomFieldActionBuilder Example to create an instance using the builder patternMyCartSetLineItemCustomTypeAction Example to create an instance using the builder patternMyCartSetLineItemCustomTypeActionBuilder Example to create an instance using the builder patternSetting a distribution channel for a LineItem can lead to an updatedprice
as described in Line Item price selection.MyCartSetLineItemDistributionChannelActionBuilder Example to create an instance using the builder patternMyCartSetLineItemShippingDetailsAction Example to create an instance using the builder patternMyCartSetLineItemShippingDetailsActionBuilder Example to create an instance using the builder patternPerforming this action has no impact on inventory that should be reserved.MyCartSetLineItemSupplyChannelActionBuilder Example to create an instance using the builder patternMyCartSetLocaleAction Example to create an instance using the builder patternMyCartSetLocaleActionBuilder Example to create an instance using the builder patternSetting the shipping address also sets the TaxRate of Line Items and calculates the TaxedPrice.MyCartSetShippingAddressActionBuilder Example to create an instance using the builder patternTo set the Cart's Shipping Method the Cart must have theSingle
ShippingMode and ashippingAddress
.MyCartSetShippingMethodActionBuilder Example to create an instance using the builder patternMyCartUpdate Example to create an instance using the builder patternMyCartUpdateAction Example to create a subtype instance using the builder patternMyCartUpdateActionBuilderMyCartUpdateBuilder Example to create an instance using the builder patternUpdates an address initemShippingAddresses
by keeping the Addresskey
.MyCartUpdateItemShippingAddressActionBuilder Example to create an instance using the builder patternDraft type to represent the top level of a business.MyCompanyDraftBuilder Example to create an instance using the builder patternAdding an address to the Customer produces the CustomerAddressAdded Message.MyCustomerAddAddressActionBuilder Example to create an instance using the builder patternAdds an address from theaddresses
array tobillingAddressIds
.MyCustomerAddBillingAddressIdActionBuilder Example to create an instance using the builder patternAdds an address from theaddresses
array toshippingAddressIds
.MyCustomerAddShippingAddressIdActionBuilder Example to create an instance using the builder patternChanging an address of the Customer produces the CustomerAddressChanged Message.MyCustomerChangeAddressActionBuilder Example to create an instance using the builder patternChanging the email of the Customer produces the CustomerEmailChanged Message.MyCustomerChangeEmailActionBuilder Example to create an instance using the builder patternMyCustomerDraft Example to create an instance using the builder patternMyCustomerDraftBuilder Example to create an instance using the builder patternRemoving an address of the Customer produces the CustomerAddressRemoved Message.MyCustomerRemoveAddressActionBuilder Example to create an instance using the builder patternRemoves an existing billing address frombillingAddressesIds
.MyCustomerRemoveBillingAddressIdActionBuilder Example to create an instance using the builder patternRemoves an existing shipping address fromshippingAddressesIds
.MyCustomerRemoveShippingAddressIdActionBuilder Example to create an instance using the builder patternSetting thecompanyName
field on the Customer produces the CustomerCompanyNameSet Message.MyCustomerSetCompanyNameActionBuilder Example to create an instance using the builder patternAdding a Custom Field to a Customer generates the CustomerCustomFieldAdded Message, removing one generates the CustomerCustomFieldRemoved Message, and updating an existing one generates the CustomerCustomFieldChanged Message.MyCustomerSetCustomFieldActionBuilder Example to create an instance using the builder patternAdding or updating a Custom Type on a Customer generates the CustomerCustomTypeSet Message, removing one generates the CustomerCustomTypeRemoved Message.MyCustomerSetCustomTypeActionBuilder Example to create an instance using the builder patternSetting the date of birth of the Customer produces the CustomerDateOfBirthSet Message.MyCustomerSetDateOfBirthActionBuilder Example to create an instance using the builder patternSets the default billing address fromaddresses
.MyCustomerSetDefaultBillingAddressActionBuilder Example to create an instance using the builder patternSets the default shipping address fromaddresses
.MyCustomerSetDefaultShippingAddressActionBuilder Example to create an instance using the builder patternSetting the first name of the Customer produces the CustomerFirstNameSet Message.MyCustomerSetFirstNameActionBuilder Example to create an instance using the builder patternSetting the last name of the Customer produces the CustomerLastNameSet Message.MyCustomerSetLastNameActionBuilder Example to create an instance using the builder patternMyCustomerSetLocaleAction Example to create an instance using the builder patternMyCustomerSetLocaleActionBuilder Example to create an instance using the builder patternMyCustomerSetMiddleNameAction Example to create an instance using the builder patternMyCustomerSetMiddleNameActionBuilder Example to create an instance using the builder patternMyCustomerSetSalutationAction Example to create an instance using the builder patternMyCustomerSetSalutationActionBuilder Example to create an instance using the builder patternSetting the title of the Customer produces the CustomerTitleSetMessage.MyCustomerSetTitleActionBuilder Example to create an instance using the builder patternMyCustomerSetVatIdAction Example to create an instance using the builder patternMyCustomerSetVatIdActionBuilder Example to create an instance using the builder patternMyCustomerUpdate Example to create an instance using the builder patternMyCustomerUpdateAction Example to create a subtype instance using the builder patternMyCustomerUpdateActionBuilderMyCustomerUpdateBuilder Example to create an instance using the builder patternDraft type to model divisions that are part of the Company or a higher-order Division.MyDivisionDraftBuilder Example to create an instance using the builder patternFor Product Variant identification, either theproductId
andvariantId
, orsku
must be provided.MyLineItemDraftBuilder Example to create an instance using the builder patternMyOrderFromCartDraft Example to create an instance using the builder patternMyOrderFromCartDraftBuilder Example to create an instance using the builder patternMyOrderFromQuoteDraft Example to create an instance using the builder patternMyOrderFromQuoteDraftBuilder Example to create an instance using the builder patternMyPayment Example to create an instance using the builder patternAdding a Transaction to a Payment generates the PaymentTransactionAdded Message.MyPaymentAddTransactionActionBuilder Example to create an instance using the builder patternMyPaymentBuilder Example to create an instance using the builder patternCan be used to update the Payment if a customer changes the Cart, or adds or removes a CartDiscount during checkout.MyPaymentChangeAmountPlannedActionBuilder Example to create an instance using the builder patternMyPaymentDraft Example to create an instance using the builder patternMyPaymentDraftBuilder Example to create an instance using the builder patternPagedQueryResult withresults
containing an array of MyPayment.MyPaymentPagedQueryResponseBuilder Example to create an instance using the builder patternMyPaymentSetCustomFieldAction Example to create an instance using the builder patternMyPaymentSetCustomFieldActionBuilder Example to create an instance using the builder patternMyPaymentSetMethodInfoInterfaceAction Example to create an instance using the builder patternMyPaymentSetMethodInfoInterfaceActionBuilder Example to create an instance using the builder patternMyPaymentSetMethodInfoMethodAction Example to create an instance using the builder patternMyPaymentSetMethodInfoMethodActionBuilder Example to create an instance using the builder patternMyPaymentSetMethodInfoNameAction Example to create an instance using the builder patternMyPaymentSetMethodInfoNameActionBuilder Example to create an instance using the builder patternMyPaymentSetTransactionCustomFieldAction Example to create an instance using the builder patternMyPaymentSetTransactionCustomFieldActionBuilder Example to create an instance using the builder patternMyPaymentUpdate Example to create an instance using the builder patternMyPaymentUpdateAction Example to create a subtype instance using the builder patternMyPaymentUpdateActionBuilderMyPaymentUpdateBuilder Example to create an instance using the builder patternWhen accepting, declining, or renegotiating B2B Quotes, the Customer must have theAcceptMyQuotes
,DeclineMyQuotes
, orRenegotiateMyQuotes
Permission, respectively.MyQuoteChangeMyQuoteStateActionBuilder Example to create an instance using the builder patternTransitions thequoteRequestState
of the Quote Request toCancelled
.MyQuoteRequestCancelActionBuilder Example to create an instance using the builder patternMyQuoteRequestDraft Example to create an instance using the builder patternMyQuoteRequestDraftBuilder Example to create an instance using the builder patternMyQuoteRequestUpdate Example to create an instance using the builder patternMyQuoteRequestUpdateAction Example to create a subtype instance using the builder patternMyQuoteRequestUpdateActionBuilderMyQuoteRequestUpdateBuilder Example to create an instance using the builder patternQuoteStates that can be set using the Change My Quote State update action.possible values of MyQuoteStateMyQuoteUpdate Example to create an instance using the builder patternMyQuoteUpdateAction Example to create a subtype instance using the builder patternMyQuoteUpdateActionBuilderMyQuoteUpdateBuilder Example to create an instance using the builder patternMyShoppingListAddLineItemAction Example to create an instance using the builder patternMyShoppingListAddLineItemActionBuilder Example to create an instance using the builder patternMyShoppingListAddTextLineItemAction Example to create an instance using the builder patternMyShoppingListAddTextLineItemActionBuilder Example to create an instance using the builder patternMyShoppingListChangeLineItemQuantityAction Example to create an instance using the builder patternMyShoppingListChangeLineItemQuantityActionBuilder Example to create an instance using the builder patternMyShoppingListChangeLineItemsOrderAction Example to create an instance using the builder patternMyShoppingListChangeLineItemsOrderActionBuilder Example to create an instance using the builder patternMyShoppingListChangeNameAction Example to create an instance using the builder patternMyShoppingListChangeNameActionBuilder Example to create an instance using the builder patternMyShoppingListChangeTextLineItemNameAction Example to create an instance using the builder patternMyShoppingListChangeTextLineItemNameActionBuilder Example to create an instance using the builder patternMyShoppingListChangeTextLineItemQuantityAction Example to create an instance using the builder patternMyShoppingListChangeTextLineItemQuantityActionBuilder Example to create an instance using the builder patternMyShoppingListChangeTextLineItemsOrderAction Example to create an instance using the builder patternMyShoppingListChangeTextLineItemsOrderActionBuilder Example to create an instance using the builder patternA MyShoppingListDraft is the object submitted as payload to the Create MyShoppingList request.MyShoppingListDraftBuilder Example to create an instance using the builder patternMyShoppingListRemoveLineItemAction Example to create an instance using the builder patternMyShoppingListRemoveLineItemActionBuilder Example to create an instance using the builder patternMyShoppingListRemoveTextLineItemAction Example to create an instance using the builder patternMyShoppingListRemoveTextLineItemActionBuilder Example to create an instance using the builder patternMyShoppingListSetCustomFieldAction Example to create an instance using the builder patternMyShoppingListSetCustomFieldActionBuilder Example to create an instance using the builder patternMyShoppingListSetCustomTypeAction Example to create an instance using the builder patternMyShoppingListSetCustomTypeActionBuilder Example to create an instance using the builder patternMyShoppingListSetDeleteDaysAfterLastModificationAction Example to create an instance using the builder patternMyShoppingListSetDeleteDaysAfterLastModificationActionBuilder Example to create an instance using the builder patternMyShoppingListSetDescriptionAction Example to create an instance using the builder patternMyShoppingListSetDescriptionActionBuilder Example to create an instance using the builder patternMyShoppingListSetLineItemCustomFieldAction Example to create an instance using the builder patternMyShoppingListSetLineItemCustomFieldActionBuilder Example to create an instance using the builder patternMyShoppingListSetLineItemCustomTypeAction Example to create an instance using the builder patternMyShoppingListSetLineItemCustomTypeActionBuilder Example to create an instance using the builder patternMyShoppingListSetTextLineItemCustomFieldAction Example to create an instance using the builder patternMyShoppingListSetTextLineItemCustomFieldActionBuilder Example to create an instance using the builder patternMyShoppingListSetTextLineItemCustomTypeAction Example to create an instance using the builder patternMyShoppingListSetTextLineItemCustomTypeActionBuilder Example to create an instance using the builder patternMyShoppingListSetTextLineItemDescriptionAction Example to create an instance using the builder patternMyShoppingListSetTextLineItemDescriptionActionBuilder Example to create an instance using the builder patternMyShoppingListUpdate Example to create an instance using the builder patternMyShoppingListUpdateAction Example to create a subtype instance using the builder patternMyShoppingListUpdateActionBuilderMyShoppingListUpdateBuilder Example to create an instance using the builder patternMyTransactionDraft Example to create an instance using the builder patternMyTransactionDraftBuilder Example to create an instance using the builder patternReplicaMyCartDraft Example to create an instance using the builder patternReplicaMyCartDraftBuilder Example to create an instance using the builder pattern