Package com.commercetools.api.models.business_unit

Interface BusinessUnitAddShippingAddressIdAction

All Superinterfaces:
BusinessUnitUpdateAction, ResourceUpdateAction<BusinessUnitUpdateAction>
public interface BusinessUnitAddShippingAddressIdAction extends BusinessUnitUpdateAction

Adding a shipping address to a Business Unit generates a BusinessUnitShippingAddressAdded Message.

Example to create an instance using the builder pattern 

     BusinessUnitAddShippingAddressIdAction businessUnitAddShippingAddressIdAction = BusinessUnitAddShippingAddressIdAction.builder()
             .build()

  • Field Details

    • ADD_SHIPPING_ADDRESS_ID

      static final String ADD_SHIPPING_ADDRESS_ID
      discriminator value for BusinessUnitAddShippingAddressIdAction
      See Also:

  • Method Details

    • getAddressId

      String getAddressId()

      ID of the address to add as a shipping address. Either addressId or addressKey is required.

      Returns:
      addressId

    • getAddressKey

      String getAddressKey()

      Key of the address to add as a shipping address. Either addressId or addressKey is required.

      Returns:
      addressKey

    • setAddressId

      void setAddressId(String addressId)

      ID of the address to add as a shipping address. Either addressId or addressKey is required.

      Parameters:
      addressId - value to be set

    • setAddressKey

      void setAddressKey(String addressKey)

      Key of the address to add as a shipping address. Either addressId or addressKey is required.

      Parameters:
      addressKey - value to be set

    • of

      static BusinessUnitAddShippingAddressIdAction of()
      factory method
      Returns:
      instance of BusinessUnitAddShippingAddressIdAction

    • of

      static BusinessUnitAddShippingAddressIdAction of(BusinessUnitAddShippingAddressIdAction template)
      factory method to create a shallow copy BusinessUnitAddShippingAddressIdAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static BusinessUnitAddShippingAddressIdAction deepCopy(@Nullable BusinessUnitAddShippingAddressIdAction template)
      factory method to create a deep copy of BusinessUnitAddShippingAddressIdAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static BusinessUnitAddShippingAddressIdActionBuilder builder()
      builder factory method for BusinessUnitAddShippingAddressIdAction
      Returns:
      builder

    • builder

      static BusinessUnitAddShippingAddressIdActionBuilder builder(BusinessUnitAddShippingAddressIdAction template)
      create builder for BusinessUnitAddShippingAddressIdAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withBusinessUnitAddShippingAddressIdAction

      default <T> T withBusinessUnitAddShippingAddressIdAction(Function<BusinessUnitAddShippingAddressIdAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<BusinessUnitAddShippingAddressIdAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference