Package io.voucherify.client.model

Class OrdersCreateRequestBody

java.lang.Object
io.voucherify.client.model.OrdersCreateRequestBody
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class OrdersCreateRequestBody extends Object
Request body schema for **POST** `v1/orders`.

  • Field Details

  • Constructor Details

    • OrdersCreateRequestBody

      public OrdersCreateRequestBody()

  • Method Details

    • id

      public OrdersCreateRequestBody id(String id)

    • getId

      @Nullable public String getId()
      Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.
      Returns:
      id

    • setId

      public void setId(String id)

    • sourceId

      public OrdersCreateRequestBody sourceId(String sourceId)

    • getSourceId

      @Nullable public String getSourceId()
      Unique source ID of an existing order that will be linked to the redemption of this request.
      Returns:
      sourceId

    • setSourceId

      public void setSourceId(String sourceId)

    • status

      public OrdersCreateRequestBody status(OrdersCreateRequestBody.StatusEnum status)

    • getStatus

      @Nullable public OrdersCreateRequestBody.StatusEnum getStatus()
      The order status.
      Returns:
      status

    • setStatus

      public void setStatus(OrdersCreateRequestBody.StatusEnum status)

    • amount

      public OrdersCreateRequestBody amount(Integer amount)

    • getAmount

      @Nullable public Integer getAmount()
      A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.
      Returns:
      amount

    • setAmount

      public void setAmount(Integer amount)

    • initialAmount

      public OrdersCreateRequestBody initialAmount(Integer initialAmount)

    • getInitialAmount

      @Nullable public Integer getInitialAmount()
      A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.
      Returns:
      initialAmount

    • setInitialAmount

      public void setInitialAmount(Integer initialAmount)

    • discountAmount

      public OrdersCreateRequestBody discountAmount(Integer discountAmount)

    • getDiscountAmount

      @Nullable public Integer getDiscountAmount()
      Sum of all order-level discounts applied to the order.
      Returns:
      discountAmount

    • setDiscountAmount

      public void setDiscountAmount(Integer discountAmount)

    • items

      public OrdersCreateRequestBody items(List<OrderItem> items)

    • addItemsItem

      public OrdersCreateRequestBody addItemsItem(OrderItem itemsItem)

    • getItems

      @Nullable public List<OrderItem> getItems()
      Array of items applied to the order. It can include up 500 items.
      Returns:
      items

    • setItems

      public void setItems(List<OrderItem> items)

    • metadata

      public OrdersCreateRequestBody metadata(Object metadata)

    • getMetadata

      @Nullable public Object getMetadata()
      A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
      Returns:
      metadata

    • setMetadata

      public void setMetadata(Object metadata)

    • createdAt

      public OrdersCreateRequestBody createdAt(OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(OffsetDateTime createdAt)

    • referrerId

      public OrdersCreateRequestBody referrerId(String referrerId)

    • getReferrerId

      @Nullable public String getReferrerId()
      Unique referrer ID.
      Returns:
      referrerId

    • setReferrerId

      public void setReferrerId(String referrerId)

    • customer

      public OrdersCreateRequestBody customer(Customer customer)

    • getCustomer

      @Nullable public Customer getCustomer()
      Get customer
      Returns:
      customer

    • setCustomer

      public void setCustomer(Customer customer)

    • referrer

      public OrdersCreateRequestBody referrer(Referrer referrer)

    • getReferrer

      @Nullable public Referrer getReferrer()
      Get referrer
      Returns:
      referrer

    • setReferrer

      public void setReferrer(Referrer referrer)

    • 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

    • fromJson

      public static OrdersCreateRequestBody fromJson(String jsonString) throws IOException
      Create an instance of OrdersCreateRequestBody given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of OrdersCreateRequestBody
      Throws:
      IOException - if the JSON string is invalid with respect to OrdersCreateRequestBody

    • toJson

      public String toJson()
      Convert an instance of OrdersCreateRequestBody to an JSON string
      Returns:
      JSON string