Order (Square 20.0.0.20220512 API)

java.lang.Object
- com.squareup.square.models.Order

```
public class Order
extends Object
```
This is a model class for Order type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Order.Builder
Class to build instances of Order.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Order.Builder` Class to build instances of `Order`.

Constructor Summary

Constructors
Constructor and Description
Order(String locationId, String id, String referenceId, OrderSource source, String customerId, List<OrderLineItem> lineItems, List<OrderLineItemTax> taxes, List<OrderLineItemDiscount> discounts, List<OrderServiceCharge> serviceCharges, List<OrderFulfillment> fulfillments, List<OrderReturn> returns, OrderMoneyAmounts returnAmounts, OrderMoneyAmounts netAmounts, OrderRoundingAdjustment roundingAdjustment, List<Tender> tenders, List<Refund> refunds, Map<String,String> metadata, String createdAt, String updatedAt, String closedAt, String state, Integer version, Money totalMoney, Money totalTaxMoney, Money totalDiscountMoney, Money totalTipMoney, Money totalServiceChargeMoney, String ticketName, OrderPricingOptions pricingOptions, List<OrderReward> rewards) Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getClosedAt()` Getter for ClosedAt.
`String`	`getCreatedAt()` Getter for CreatedAt.
`String`	`getCustomerId()` Getter for CustomerId.
`List<OrderLineItemDiscount>`	`getDiscounts()` Getter for Discounts.
`List<OrderFulfillment>`	`getFulfillments()` Getter for Fulfillments.
`String`	`getId()` Getter for Id.
`List<OrderLineItem>`	`getLineItems()` Getter for LineItems.
`String`	`getLocationId()` Getter for LocationId.
`Map<String,String>`	`getMetadata()` Getter for Metadata.
`OrderMoneyAmounts`	`getNetAmounts()` Getter for NetAmounts.
`OrderPricingOptions`	`getPricingOptions()` Getter for PricingOptions.
`String`	`getReferenceId()` Getter for ReferenceId.
`List<Refund>`	`getRefunds()` Getter for Refunds.
`OrderMoneyAmounts`	`getReturnAmounts()` Getter for ReturnAmounts.
`List<OrderReturn>`	`getReturns()` Getter for Returns.
`List<OrderReward>`	`getRewards()` Getter for Rewards.
`OrderRoundingAdjustment`	`getRoundingAdjustment()` Getter for RoundingAdjustment.
`List<OrderServiceCharge>`	`getServiceCharges()` Getter for ServiceCharges.
`OrderSource`	`getSource()` Getter for Source.
`String`	`getState()` Getter for State.
`List<OrderLineItemTax>`	`getTaxes()` Getter for Taxes.
`List<Tender>`	`getTenders()` Getter for Tenders.
`String`	`getTicketName()` Getter for TicketName.
`Money`	`getTotalDiscountMoney()` Getter for TotalDiscountMoney.
`Money`	`getTotalMoney()` Getter for TotalMoney.
`Money`	`getTotalServiceChargeMoney()` Getter for TotalServiceChargeMoney.
`Money`	`getTotalTaxMoney()` Getter for TotalTaxMoney.
`Money`	`getTotalTipMoney()` Getter for TotalTipMoney.
`String`	`getUpdatedAt()` Getter for UpdatedAt.
`Integer`	`getVersion()` Getter for Version.
`int`	`hashCode()`
`Order.Builder`	`toBuilder()` Builds a new `Order.Builder` object.
`String`	`toString()` Converts this Order into string format.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Order
```
public Order(String locationId,
             String id,
             String referenceId,
             OrderSource source,
             String customerId,
             List<OrderLineItem> lineItems,
             List<OrderLineItemTax> taxes,
             List<OrderLineItemDiscount> discounts,
             List<OrderServiceCharge> serviceCharges,
             List<OrderFulfillment> fulfillments,
             List<OrderReturn> returns,
             OrderMoneyAmounts returnAmounts,
             OrderMoneyAmounts netAmounts,
             OrderRoundingAdjustment roundingAdjustment,
             List<Tender> tenders,
             List<Refund> refunds,
             Map<String,String> metadata,
             String createdAt,
             String updatedAt,
             String closedAt,
             String state,
             Integer version,
             Money totalMoney,
             Money totalTaxMoney,
             Money totalDiscountMoney,
             Money totalTipMoney,
             Money totalServiceChargeMoney,
             String ticketName,
             OrderPricingOptions pricingOptions,
             List<OrderReward> rewards)
```
    Initialization constructor.
    
    Parameters:
    
    locationId - String value for locationId.
    
    id - String value for id.
    
    referenceId - String value for referenceId.
    
    source - OrderSource value for source.
    
    customerId - String value for customerId.
    
    lineItems - List of OrderLineItem value for lineItems.
    
    taxes - List of OrderLineItemTax value for taxes.
    
    discounts - List of OrderLineItemDiscount value for discounts.
    
    serviceCharges - List of OrderServiceCharge value for serviceCharges.
    
    fulfillments - List of OrderFulfillment value for fulfillments.
    
    returns - List of OrderReturn value for returns.
    
    returnAmounts - OrderMoneyAmounts value for returnAmounts.
    
    netAmounts - OrderMoneyAmounts value for netAmounts.
    
    roundingAdjustment - OrderRoundingAdjustment value for roundingAdjustment.
    
    tenders - List of Tender value for tenders.
    
    refunds - List of Refund value for refunds.
    
    metadata - Map of String, value for metadata.
    
    createdAt - String value for createdAt.
    
    updatedAt - String value for updatedAt.
    
    closedAt - String value for closedAt.
    
    state - String value for state.
    
    version - Integer value for version.
    
    totalMoney - Money value for totalMoney.
    
    totalTaxMoney - Money value for totalTaxMoney.
    
    totalDiscountMoney - Money value for totalDiscountMoney.
    
    totalTipMoney - Money value for totalTipMoney.
    
    totalServiceChargeMoney - Money value for totalServiceChargeMoney.
    
    ticketName - String value for ticketName.
    
    pricingOptions - OrderPricingOptions value for pricingOptions.
    
    rewards - List of OrderReward value for rewards.
- Method Detail
  - getId
```
public String getId()
```
    Getter for Id. The order's unique ID.
    
    Returns:
    
    Returns the String
  - getLocationId
```
public String getLocationId()
```
    Getter for LocationId. The ID of the seller location that this order is associated with.
    
    Returns:
    
    Returns the String
  - getReferenceId
```
public String getReferenceId()
```
    Getter for ReferenceId. A client-specified ID to associate an entity in another system with this order.
    
    Returns:
    
    Returns the String
  - getSource
```
public OrderSource getSource()
```
    Getter for Source. Represents the origination details of an order.
    
    Returns:
    
    Returns the OrderSource
  - getCustomerId
```
public String getCustomerId()
```
    Getter for CustomerId. The ID of the [customer]($m/Customer) associated with the order. __IMPORTANT:__ You should specify a `customer_id` if you want the corresponding payment transactions to be explicitly linked to the customer in the Seller Dashboard. If this field is omitted, the `customer_id` assigned to any underlying `Payment` objects is ignored and might result in the creation of new [instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).
    
    Returns:
    
    Returns the String
  - getLineItems
```
public List<OrderLineItem> getLineItems()
```
    Getter for LineItems. The line items included in the order.
    
    Returns:
    
    Returns the List of OrderLineItem
  - getTaxes
```
public List<OrderLineItemTax> getTaxes()
```
    Getter for Taxes. The list of all taxes associated with the order. Taxes can be scoped to either `ORDER` or `LINE_ITEM`. For taxes with `LINE_ITEM` scope, an `OrderLineItemAppliedTax` must be added to each line item that the tax applies to. For taxes with `ORDER` scope, the server generates an `OrderLineItemAppliedTax` for every line item. On reads, each tax in the list includes the total amount of that tax applied to the order. __IMPORTANT__: If `LINE_ITEM` scope is set on any taxes in this field, using the deprecated `line_items.taxes` field results in an error. Use `line_items.applied_taxes` instead.
    
    Returns:
    
    Returns the List of OrderLineItemTax
  - getDiscounts
```
public List<OrderLineItemDiscount> getDiscounts()
```
    Getter for Discounts. The list of all discounts associated with the order. Discounts can be scoped to either `ORDER` or `LINE_ITEM`. For discounts scoped to `LINE_ITEM`, an `OrderLineItemAppliedDiscount` must be added to each line item that the discount applies to. For discounts with `ORDER` scope, the server generates an `OrderLineItemAppliedDiscount` for every line item. __IMPORTANT__: If `LINE_ITEM` scope is set on any discounts in this field, using the deprecated `line_items.discounts` field results in an error. Use `line_items.applied_discounts` instead.
    
    Returns:
    
    Returns the List of OrderLineItemDiscount
  - getServiceCharges
```
public List<OrderServiceCharge> getServiceCharges()
```
    Getter for ServiceCharges. A list of service charges applied to the order.
    
    Returns:
    
    Returns the List of OrderServiceCharge
  - getFulfillments
```
public List<OrderFulfillment> getFulfillments()
```
    Getter for Fulfillments. Details about order fulfillment. Orders can only be created with at most one fulfillment. However, orders returned by the API might contain multiple fulfillments.
    
    Returns:
    
    Returns the List of OrderFulfillment
  - getReturns
```
public List<OrderReturn> getReturns()
```
    Getter for Returns. A collection of items from sale orders being returned in this one. Normally part of an itemized return or exchange. There is exactly one `Return` object per sale `Order` being referenced.
    
    Returns:
    
    Returns the List of OrderReturn
  - getReturnAmounts
```
public OrderMoneyAmounts getReturnAmounts()
```
    Getter for ReturnAmounts. A collection of various money amounts.
    
    Returns:
    
    Returns the OrderMoneyAmounts
  - getNetAmounts
```
public OrderMoneyAmounts getNetAmounts()
```
    Getter for NetAmounts. A collection of various money amounts.
    
    Returns:
    
    Returns the OrderMoneyAmounts
  - getRoundingAdjustment
```
public OrderRoundingAdjustment getRoundingAdjustment()
```
    Getter for RoundingAdjustment. A rounding adjustment of the money being returned. Commonly used to apply cash rounding when the minimum unit of the account is smaller than the lowest physical denomination of the currency.
    
    Returns:
    
    Returns the OrderRoundingAdjustment
  - getTenders
```
public List<Tender> getTenders()
```
    Getter for Tenders. The tenders that were used to pay for the order.
    
    Returns:
    
    Returns the List of Tender
  - getRefunds
```
public List<Refund> getRefunds()
```
    Getter for Refunds. The refunds that are part of this order.
    
    Returns:
    
    Returns the List of Refund
  - getMetadata
```
public Map<String,String> getMetadata()
```
    Getter for Metadata. Application-defined data attached to this order. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a maximum length of 255 characters. An application can have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
    
    Returns:
    
    Returns the Map of String, String
  - getCreatedAt
```
public String getCreatedAt()
```
    Getter for CreatedAt. The timestamp for when the order was created, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
    
    Returns:
    
    Returns the String
  - getUpdatedAt
```
public String getUpdatedAt()
```
    Getter for UpdatedAt. The timestamp for when the order was last updated, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
    
    Returns:
    
    Returns the String
  - getClosedAt
```
public String getClosedAt()
```
    Getter for ClosedAt. The timestamp for when the order reached a terminal [state]($m/OrderState), in RFC 3339 format (for example "2016-09-04T23:59:33.123Z").
    
    Returns:
    
    Returns the String
  - getState
```
public String getState()
```
    Getter for State. The state of the order.
    
    Returns:
    
    Returns the String
  - getVersion
```
public Integer getVersion()
```
    Getter for Version. The version number, which is incremented each time an update is committed to the order. Orders not created through the API do not include a version number and therefore cannot be updated. [Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders#update-orders).
    
    Returns:
    
    Returns the Integer
  - getTotalMoney
```
public Money getTotalMoney()
```
    Getter for TotalMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getTotalTaxMoney
```
public Money getTotalTaxMoney()
```
    Getter for TotalTaxMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getTotalDiscountMoney
```
public Money getTotalDiscountMoney()
```
    Getter for TotalDiscountMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getTotalTipMoney
```
public Money getTotalTipMoney()
```
    Getter for TotalTipMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getTotalServiceChargeMoney
```
public Money getTotalServiceChargeMoney()
```
    Getter for TotalServiceChargeMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getTicketName
```
public String getTicketName()
```
    Getter for TicketName. A short-term identifier for the order (such as a customer first name, table number, or auto-generated order number that resets daily). For orders created in Square Point of Sale, the `ticket_name` is printed on in-person tickets and stubs. It converts to the `kitchen_printing.name` field in the bill cart feature details.
    
    Returns:
    
    Returns the String
  - getPricingOptions
```
public OrderPricingOptions getPricingOptions()
```
    Getter for PricingOptions. Pricing options for an order. The options affect how the order's price is calculated. They can be used, for example, to apply automatic price adjustments that are based on preconfigured [pricing rules]($m/CatalogPricingRule).
    
    Returns:
    
    Returns the OrderPricingOptions
  - getRewards
```
public List<OrderReward> getRewards()
```
    Getter for Rewards. A set-like list of Rewards that have been added to the Order.
    
    Returns:
    
    Returns the List of OrderReward
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Converts this Order into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public Order.Builder toBuilder()
```
    Builds a new Order.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new Order.Builder object

Class Order

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Order

Method Detail

getId

getLocationId

getReferenceId

getSource

getCustomerId

getLineItems

getTaxes

getDiscounts

getServiceCharges

getFulfillments

getReturns

getReturnAmounts

getNetAmounts

getRoundingAdjustment

getTenders

getRefunds

getMetadata

getCreatedAt

getUpdatedAt

getClosedAt

getState

getVersion

getTotalMoney

getTotalTaxMoney

getTotalDiscountMoney

getTotalTipMoney

getTotalServiceChargeMoney

getTicketName

getPricingOptions

getRewards

hashCode

equals

toString

toBuilder