Package software.xdev.brevo.model

Class Order

java.lang.Object
software.xdev.brevo.model.Order
public class Order extends Object
Order

  • Field Details

  • Constructor Details

    • Order

      public Order()

  • Method Details

    • id

      public Order id(@Nonnull String id)

    • getId

      @Nonnull public String getId()
      Unique ID of the order.
      Returns:
      id

    • setId

      public void setId(@Nonnull String id)

    • createdAt

      public Order createdAt(@Nonnull String createdAt)

    • getCreatedAt

      @Nonnull public String getCreatedAt()
      Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nonnull String createdAt)

    • updatedAt

      public Order updatedAt(@Nonnull String updatedAt)

    • getUpdatedAt

      @Nonnull public String getUpdatedAt()
      Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated.
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nonnull String updatedAt)

    • status

      public Order status(@Nonnull String status)

    • getStatus

      @Nonnull public String getStatus()
      State of the order.
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull String status)

    • amount

      public Order amount(@Nonnull BigDecimal amount)

    • getAmount

      @Nonnull public BigDecimal getAmount()
      Total amount of the order, including all shipping expenses, tax and the price of items.
      Returns:
      amount

    • setAmount

      public void setAmount(@Nonnull BigDecimal amount)

    • storeId

      public Order storeId(@Nullable String storeId)

    • getStoreId

      @Nullable public String getStoreId()
      ID of store where the order is placed
      Returns:
      storeId

    • setStoreId

      public void setStoreId(@Nullable String storeId)

    • identifiers

      public Order identifiers(@Nullable OrderIdentifiers identifiers)

    • getIdentifiers

      @Nullable public OrderIdentifiers getIdentifiers()
      Get identifiers
      Returns:
      identifiers

    • setIdentifiers

      public void setIdentifiers(@Nullable OrderIdentifiers identifiers)

    • products

      public Order products(@Nonnull List<OrderProductsInner> products)

    • addProductsItem

      public Order addProductsItem(OrderProductsInner productsItem)

    • getProducts

      @Nonnull public List<OrderProductsInner> getProducts()
      Get products
      Returns:
      products

    • setProducts

      public void setProducts(@Nonnull List<OrderProductsInner> products)

    • billing

      public Order billing(@Nullable OrderBilling billing)

    • getBilling

      @Nullable public OrderBilling getBilling()
      Get billing
      Returns:
      billing

    • setBilling

      public void setBilling(@Nullable OrderBilling billing)

    • coupons

      public Order coupons(@Nullable List<String> coupons)

    • addCouponsItem

      public Order addCouponsItem(String couponsItem)

    • getCoupons

      @Nullable public List<String> getCoupons()
      Coupons applied to the order. Stored case insensitive.
      Returns:
      coupons

    • setCoupons

      public void setCoupons(@Nullable List<String> coupons)

    • metaInfo

      public Order metaInfo(@Nullable Map<String,OrderMetaInfoValue> metaInfo)

    • putMetaInfoItem

      public Order putMetaInfoItem(String key, OrderMetaInfoValue metaInfoItem)

    • getMetaInfo

      @Nullable public Map<String,OrderMetaInfoValue> getMetaInfo()
      Meta data of order to store additional detal such as custom message, customer type, source.
      Returns:
      metaInfo

    • setMetaInfo

      public void setMetaInfo(@Nullable Map<String,OrderMetaInfoValue> metaInfo)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string