Package com.commercetools.api.models.order

Interface OrderSetStoreAction

All Superinterfaces:
OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>
public interface OrderSetStoreAction extends OrderUpdateAction

Sets the Store the Order is assigned to. It should be used to migrate Orders to a new Store. No validations are performed (such as that the Customer is allowed to create Orders in the Store).

Produces the Order Store Set Message. Returns a 400 error if store references the same Store the Order is currently assigned to, including if you try to remove the value when no Store is currently assigned.

Example to create an instance using the builder pattern 

     OrderSetStoreAction orderSetStoreAction = OrderSetStoreAction.builder()
             .build()

  • Field Details

  • Method Details

    • getStore

      @Valid @Valid StoreResourceIdentifier getStore()

      Value to set. If empty, any existing value is removed.

      If store references the same Store the Order is currently assigned to or if you try to remove the value when no Store is currently assigned, a 400 error is returned.

      Returns:
      store

    • setStore

      void setStore(StoreResourceIdentifier store)

      Value to set. If empty, any existing value is removed.

      If store references the same Store the Order is currently assigned to or if you try to remove the value when no Store is currently assigned, a 400 error is returned.

      Parameters:
      store - value to be set

    • of

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

    • of

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

    • copyDeep

      OrderSetStoreAction copyDeep()
      Specified by:
      copyDeep in interface OrderUpdateAction

    • deepCopy

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

    • builder

      static OrderSetStoreActionBuilder builder()
      builder factory method for OrderSetStoreAction
      Returns:
      builder

    • builder

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

    • withOrderSetStoreAction

      default <T> T withOrderSetStoreAction(Function<OrderSetStoreAction,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<OrderSetStoreAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference