Storefront.Order (buy3 18.0.0 API)

java.lang.Object
- com.shopify.graphql.support.AbstractResponse<Storefront.Order>
- - com.shopify.buy3.Storefront.Order

All Implemented Interfaces:

Storefront.HasMetafields, Storefront.MetafieldParentResource, Storefront.Node, Node, java.io.Serializable

Enclosing class:

Storefront
```
public static class Storefront.Order
extends AbstractResponse<Storefront.Order>
implements Storefront.HasMetafields, Storefront.MetafieldParentResource, Storefront.Node
```
An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.shopify.graphql.support.AbstractResponse
  optimisticData, responseData

Constructor Summary

Constructors
Constructor and Description

Order()

Order(JsonObject fields)

Constructors
Constructor and Description
`Order()`
`Order(JsonObject fields)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Storefront.MailingAddress`	`getBillingAddress()` The address associated with the payment method.
`DateTime`	`getCanceledAt()` The date and time when the order was canceled.
`Storefront.OrderCancelReason`	`getCancelReason()` The reason for the order's cancellation.
`Storefront.CurrencyCode`	`getCurrencyCode()` The code of the currency used for the payment.
`Storefront.MoneyV2`	`getCurrentSubtotalPrice()` The subtotal of line items and their discounts, excluding line items that have been removed.
`Storefront.MoneyV2`	`getCurrentTotalDuties()` The total cost of duties for the order, including refunds.
`Storefront.MoneyV2`	`getCurrentTotalPrice()` The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed.
`Storefront.MoneyV2`	`getCurrentTotalShippingPrice()` The total cost of shipping, excluding shipping lines that have been refunded or removed.
`Storefront.MoneyV2`	`getCurrentTotalTax()` The total of all taxes applied to the order, excluding taxes for returned line items.
`java.util.List<Storefront.Attribute>`	`getCustomAttributes()` A list of the custom attributes added to the order.
`java.lang.String`	`getCustomerLocale()` The locale code in which this specific order happened.
`java.lang.String`	`getCustomerUrl()` The unique URL that the customer can use to access the order.
`Storefront.DiscountApplicationConnection`	`getDiscountApplications()` Discounts that have been applied on the order.
`java.lang.Boolean`	`getEdited()` Whether the order has had any edits applied or not.
`java.lang.String`	`getEmail()` The customer's email address.
`Storefront.OrderFinancialStatus`	`getFinancialStatus()` The financial status of the order.
`Storefront.OrderFulfillmentStatus`	`getFulfillmentStatus()` The fulfillment status for the order.
`java.lang.String`	`getGraphQlTypeName()`
`ID`	`getId()` A globally-unique ID.
`Storefront.OrderLineItemConnection`	`getLineItems()` List of the order’s line items.
`Storefront.Metafield`	`getMetafield()` Returns a metafield found by namespace and key.
`java.util.List<Storefront.Metafield>`	`getMetafields()` The metafields associated with the resource matching the supplied list of namespaces and keys.
`java.lang.String`	`getName()` Unique identifier for the order that appears on the order.
`java.lang.Integer`	`getOrderNumber()` A unique numeric identifier for the order for use by shop owner and customer.
`Storefront.MoneyV2`	`getOriginalTotalDuties()` The total cost of duties charged at checkout.
`Storefront.MoneyV2`	`getOriginalTotalPrice()` The total price of the order before any applied edits.
`java.lang.String`	`getPhone()` The customer's phone number for receiving SMS notifications.
`DateTime`	`getProcessedAt()` The date and time when the order was imported.
`Storefront.MailingAddress`	`getShippingAddress()` The address to where the order will be shipped.
`java.util.List<Storefront.DiscountAllocation>`	`getShippingDiscountAllocations()` The discounts that have been allocated onto the shipping line by discount applications.
`java.lang.String`	`getStatusUrl()` The unique URL for the order's status page.
`Storefront.MoneyV2`	`getSubtotalPrice()` Price of the order before shipping and taxes.
`Storefront.MoneyV2`	`getSubtotalPriceV2()` Deprecated. Use `subtotalPrice` instead.
`java.util.List<Storefront.Fulfillment>`	`getSuccessfulFulfillments()` List of the order’s successful fulfillments.
`Storefront.MoneyV2`	`getTotalPrice()` The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).
`Storefront.MoneyV2`	`getTotalPriceV2()` Deprecated. Use `totalPrice` instead.
`Storefront.MoneyV2`	`getTotalRefunded()` The total amount that has been refunded.
`Storefront.MoneyV2`	`getTotalRefundedV2()` Deprecated. Use `totalRefunded` instead.
`Storefront.MoneyV2`	`getTotalShippingPrice()` The total cost of shipping.
`Storefront.MoneyV2`	`getTotalShippingPriceV2()` Deprecated. Use `totalShippingPrice` instead.
`Storefront.MoneyV2`	`getTotalTax()` The total cost of taxes.
`Storefront.MoneyV2`	`getTotalTaxV2()` Deprecated. Use `totalTax` instead.
`Storefront.Order`	`setBillingAddress(Storefront.MailingAddress arg)`
`Storefront.Order`	`setCanceledAt(DateTime arg)`
`Storefront.Order`	`setCancelReason(Storefront.OrderCancelReason arg)`
`Storefront.Order`	`setCurrencyCode(Storefront.CurrencyCode arg)`
`Storefront.Order`	`setCurrentSubtotalPrice(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setCurrentTotalDuties(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setCurrentTotalPrice(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setCurrentTotalShippingPrice(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setCurrentTotalTax(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setCustomAttributes(java.util.List<Storefront.Attribute> arg)`
`Storefront.Order`	`setCustomerLocale(java.lang.String arg)`
`Storefront.Order`	`setCustomerUrl(java.lang.String arg)`
`Storefront.Order`	`setDiscountApplications(Storefront.DiscountApplicationConnection arg)`
`Storefront.Order`	`setEdited(java.lang.Boolean arg)`
`Storefront.Order`	`setEmail(java.lang.String arg)`
`Storefront.Order`	`setFinancialStatus(Storefront.OrderFinancialStatus arg)`
`Storefront.Order`	`setFulfillmentStatus(Storefront.OrderFulfillmentStatus arg)`
`Storefront.Order`	`setLineItems(Storefront.OrderLineItemConnection arg)`
`Storefront.Order`	`setMetafield(Storefront.Metafield arg)`
`Storefront.Order`	`setMetafields(java.util.List<Storefront.Metafield> arg)`
`Storefront.Order`	`setName(java.lang.String arg)`
`Storefront.Order`	`setOrderNumber(java.lang.Integer arg)`
`Storefront.Order`	`setOriginalTotalDuties(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setOriginalTotalPrice(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setPhone(java.lang.String arg)`
`Storefront.Order`	`setProcessedAt(DateTime arg)`
`Storefront.Order`	`setShippingAddress(Storefront.MailingAddress arg)`
`Storefront.Order`	`setShippingDiscountAllocations(java.util.List<Storefront.DiscountAllocation> arg)`
`Storefront.Order`	`setStatusUrl(java.lang.String arg)`
`Storefront.Order`	`setSubtotalPrice(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setSubtotalPriceV2(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setSuccessfulFulfillments(java.util.List<Storefront.Fulfillment> arg)`
`Storefront.Order`	`setTotalPrice(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setTotalPriceV2(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setTotalRefunded(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setTotalRefundedV2(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setTotalShippingPrice(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setTotalShippingPriceV2(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setTotalTax(Storefront.MoneyV2 arg)`
`Storefront.Order`	`setTotalTaxV2(Storefront.MoneyV2 arg)`
`boolean`	`unwrapsToObject(java.lang.String key)`

Methods inherited from class com.shopify.graphql.support.AbstractResponse
collectNodes, get, getFieldName, getKey, jsonAsArray, jsonAsBoolean, jsonAsDouble, jsonAsInteger, jsonAsObject, jsonAsString, withAlias

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

Constructor Detail

Order
```
public Order()
```

Order

public Order(JsonObject fields)
      throws SchemaViolationError

Throws:: SchemaViolationError

Method Detail

getGraphQlTypeName
```
public java.lang.String getGraphQlTypeName()
```
Specified by:

getGraphQlTypeName in interface Storefront.HasMetafields

Specified by:

getGraphQlTypeName in interface Storefront.MetafieldParentResource

Specified by:

getGraphQlTypeName in interface Storefront.Node

Specified by:

getGraphQlTypeName in interface Node

getBillingAddress
```
public Storefront.MailingAddress getBillingAddress()
```
The address associated with the payment method.

setBillingAddress

public Storefront.Order setBillingAddress(Storefront.MailingAddress arg)

getCancelReason
```
public Storefront.OrderCancelReason getCancelReason()
```
The reason for the order's cancellation. Returns `null` if the order wasn't canceled.

setCancelReason

public Storefront.Order setCancelReason(Storefront.OrderCancelReason arg)

getCanceledAt
```
public DateTime getCanceledAt()
```
The date and time when the order was canceled. Returns null if the order wasn't canceled.

setCanceledAt

public Storefront.Order setCanceledAt(DateTime arg)

getCurrencyCode
```
public Storefront.CurrencyCode getCurrencyCode()
```
The code of the currency used for the payment.

setCurrencyCode

public Storefront.Order setCurrencyCode(Storefront.CurrencyCode arg)

getCurrentSubtotalPrice
```
public Storefront.MoneyV2 getCurrentSubtotalPrice()
```
The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes aren't included unless the order is a taxes-included order.

setCurrentSubtotalPrice

public Storefront.Order setCurrentSubtotalPrice(Storefront.MoneyV2 arg)

getCurrentTotalDuties
```
public Storefront.MoneyV2 getCurrentTotalDuties()
```
The total cost of duties for the order, including refunds.

setCurrentTotalDuties

public Storefront.Order setCurrentTotalDuties(Storefront.MoneyV2 arg)

getCurrentTotalPrice
```
public Storefront.MoneyV2 getCurrentTotalPrice()
```
The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed.

setCurrentTotalPrice

public Storefront.Order setCurrentTotalPrice(Storefront.MoneyV2 arg)

getCurrentTotalShippingPrice
```
public Storefront.MoneyV2 getCurrentTotalShippingPrice()
```
The total cost of shipping, excluding shipping lines that have been refunded or removed. Taxes aren't included unless the order is a taxes-included order.

setCurrentTotalShippingPrice

public Storefront.Order setCurrentTotalShippingPrice(Storefront.MoneyV2 arg)

getCurrentTotalTax
```
public Storefront.MoneyV2 getCurrentTotalTax()
```
The total of all taxes applied to the order, excluding taxes for returned line items.

setCurrentTotalTax

public Storefront.Order setCurrentTotalTax(Storefront.MoneyV2 arg)

getCustomAttributes
```
public java.util.List<Storefront.Attribute> getCustomAttributes()
```
A list of the custom attributes added to the order.

setCustomAttributes

public Storefront.Order setCustomAttributes(java.util.List<Storefront.Attribute> arg)

getCustomerLocale
```
public java.lang.String getCustomerLocale()
```
The locale code in which this specific order happened.

setCustomerLocale

public Storefront.Order setCustomerLocale(java.lang.String arg)

getCustomerUrl
```
public java.lang.String getCustomerUrl()
```
The unique URL that the customer can use to access the order.

setCustomerUrl

public Storefront.Order setCustomerUrl(java.lang.String arg)

getDiscountApplications

public Storefront.DiscountApplicationConnection getDiscountApplications()

Discounts that have been applied on the order.

setDiscountApplications

public Storefront.Order setDiscountApplications(Storefront.DiscountApplicationConnection arg)

getEdited
```
public java.lang.Boolean getEdited()
```
Whether the order has had any edits applied or not.

setEdited

public Storefront.Order setEdited(java.lang.Boolean arg)

getEmail
```
public java.lang.String getEmail()
```
The customer's email address.

setEmail

public Storefront.Order setEmail(java.lang.String arg)

getFinancialStatus

public Storefront.OrderFinancialStatus getFinancialStatus()

The financial status of the order.

setFinancialStatus

public Storefront.Order setFinancialStatus(Storefront.OrderFinancialStatus arg)

getFulfillmentStatus

public Storefront.OrderFulfillmentStatus getFulfillmentStatus()

The fulfillment status for the order.

setFulfillmentStatus

public Storefront.Order setFulfillmentStatus(Storefront.OrderFulfillmentStatus arg)

getId
```
public ID getId()
```
A globally-unique ID.

Specified by:

getId in interface Storefront.Node

Specified by:

getId in interface Node

getLineItems

public Storefront.OrderLineItemConnection getLineItems()

List of the order’s line items.

setLineItems

public Storefront.Order setLineItems(Storefront.OrderLineItemConnection arg)

getMetafield
```
public Storefront.Metafield getMetafield()
```
Returns a metafield found by namespace and key.

Specified by:

getMetafield in interface Storefront.HasMetafields

setMetafield

public Storefront.Order setMetafield(Storefront.Metafield arg)

getMetafields
```
public java.util.List<Storefront.Metafield> getMetafields()
```
The metafields associated with the resource matching the supplied list of namespaces and keys.

Specified by:

getMetafields in interface Storefront.HasMetafields

setMetafields

public Storefront.Order setMetafields(java.util.List<Storefront.Metafield> arg)

getName
```
public java.lang.String getName()
```
Unique identifier for the order that appears on the order. For example, _#1000_ or _Store1001.

setName

public Storefront.Order setName(java.lang.String arg)

getOrderNumber
```
public java.lang.Integer getOrderNumber()
```
A unique numeric identifier for the order for use by shop owner and customer.

setOrderNumber

public Storefront.Order setOrderNumber(java.lang.Integer arg)

getOriginalTotalDuties
```
public Storefront.MoneyV2 getOriginalTotalDuties()
```
The total cost of duties charged at checkout.

setOriginalTotalDuties

public Storefront.Order setOriginalTotalDuties(Storefront.MoneyV2 arg)

getOriginalTotalPrice
```
public Storefront.MoneyV2 getOriginalTotalPrice()
```
The total price of the order before any applied edits.

setOriginalTotalPrice

public Storefront.Order setOriginalTotalPrice(Storefront.MoneyV2 arg)

getPhone
```
public java.lang.String getPhone()
```
The customer's phone number for receiving SMS notifications.

setPhone

public Storefront.Order setPhone(java.lang.String arg)

getProcessedAt
```
public DateTime getProcessedAt()
```
The date and time when the order was imported. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time.

setProcessedAt

public Storefront.Order setProcessedAt(DateTime arg)

getShippingAddress
```
public Storefront.MailingAddress getShippingAddress()
```
The address to where the order will be shipped.

setShippingAddress

public Storefront.Order setShippingAddress(Storefront.MailingAddress arg)

getShippingDiscountAllocations
```
public java.util.List<Storefront.DiscountAllocation> getShippingDiscountAllocations()
```
The discounts that have been allocated onto the shipping line by discount applications.

setShippingDiscountAllocations

public Storefront.Order setShippingDiscountAllocations(java.util.List<Storefront.DiscountAllocation> arg)

getStatusUrl
```
public java.lang.String getStatusUrl()
```
The unique URL for the order's status page.

setStatusUrl

public Storefront.Order setStatusUrl(java.lang.String arg)

getSubtotalPrice
```
public Storefront.MoneyV2 getSubtotalPrice()
```
Price of the order before shipping and taxes.

setSubtotalPrice

public Storefront.Order setSubtotalPrice(Storefront.MoneyV2 arg)

getSubtotalPriceV2
```
public Storefront.MoneyV2 getSubtotalPriceV2()
```
Deprecated. Use `subtotalPrice` instead.

Price of the order before duties, shipping and taxes.

setSubtotalPriceV2

public Storefront.Order setSubtotalPriceV2(Storefront.MoneyV2 arg)

getSuccessfulFulfillments

public java.util.List<Storefront.Fulfillment> getSuccessfulFulfillments()

List of the order’s successful fulfillments.

setSuccessfulFulfillments

public Storefront.Order setSuccessfulFulfillments(java.util.List<Storefront.Fulfillment> arg)

getTotalPrice
```
public Storefront.MoneyV2 getTotalPrice()
```
The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).

setTotalPrice

public Storefront.Order setTotalPrice(Storefront.MoneyV2 arg)

getTotalPriceV2
```
public Storefront.MoneyV2 getTotalPriceV2()
```
Deprecated. Use `totalPrice` instead.

The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).

setTotalPriceV2

public Storefront.Order setTotalPriceV2(Storefront.MoneyV2 arg)

getTotalRefunded
```
public Storefront.MoneyV2 getTotalRefunded()
```
The total amount that has been refunded.

setTotalRefunded

public Storefront.Order setTotalRefunded(Storefront.MoneyV2 arg)

getTotalRefundedV2
```
public Storefront.MoneyV2 getTotalRefundedV2()
```
Deprecated. Use `totalRefunded` instead.

The total amount that has been refunded.

setTotalRefundedV2

public Storefront.Order setTotalRefundedV2(Storefront.MoneyV2 arg)

getTotalShippingPrice

public Storefront.MoneyV2 getTotalShippingPrice()

The total cost of shipping.

setTotalShippingPrice

public Storefront.Order setTotalShippingPrice(Storefront.MoneyV2 arg)

getTotalShippingPriceV2
```
public Storefront.MoneyV2 getTotalShippingPriceV2()
```
Deprecated. Use `totalShippingPrice` instead.

The total cost of shipping.

setTotalShippingPriceV2

public Storefront.Order setTotalShippingPriceV2(Storefront.MoneyV2 arg)

getTotalTax

public Storefront.MoneyV2 getTotalTax()

The total cost of taxes.

setTotalTax

public Storefront.Order setTotalTax(Storefront.MoneyV2 arg)

getTotalTaxV2
```
public Storefront.MoneyV2 getTotalTaxV2()
```
Deprecated. Use `totalTax` instead.

The total cost of taxes.

setTotalTaxV2

public Storefront.Order setTotalTaxV2(Storefront.MoneyV2 arg)

unwrapsToObject
```
public boolean unwrapsToObject(java.lang.String key)
```
Specified by:

unwrapsToObject in class AbstractResponse<Storefront.Order>

Class Storefront.Order

Field Summary

Fields inherited from class com.shopify.graphql.support.AbstractResponse

Constructor Summary

Method Summary

Methods inherited from class com.shopify.graphql.support.AbstractResponse

Methods inherited from class java.lang.Object

Constructor Detail

Order

Order

Method Detail

getGraphQlTypeName

getBillingAddress

setBillingAddress

getCancelReason

setCancelReason

getCanceledAt

setCanceledAt

getCurrencyCode

setCurrencyCode

getCurrentSubtotalPrice

setCurrentSubtotalPrice

getCurrentTotalDuties

setCurrentTotalDuties

getCurrentTotalPrice

setCurrentTotalPrice

getCurrentTotalShippingPrice

setCurrentTotalShippingPrice

getCurrentTotalTax

setCurrentTotalTax

getCustomAttributes

setCustomAttributes

getCustomerLocale

setCustomerLocale

getCustomerUrl

setCustomerUrl

getDiscountApplications

setDiscountApplications

getEdited

setEdited

getEmail

setEmail

getFinancialStatus

setFinancialStatus

getFulfillmentStatus

setFulfillmentStatus

getId

getLineItems

setLineItems

getMetafield

setMetafield

getMetafields

setMetafields

getName

setName

getOrderNumber

setOrderNumber

getOriginalTotalDuties

setOriginalTotalDuties

getOriginalTotalPrice

setOriginalTotalPrice

getPhone

setPhone

getProcessedAt

setProcessedAt

getShippingAddress

setShippingAddress

getShippingDiscountAllocations

setShippingDiscountAllocations

getStatusUrl

setStatusUrl

getSubtotalPrice

setSubtotalPrice

getSubtotalPriceV2

setSubtotalPriceV2

getSuccessfulFulfillments

setSuccessfulFulfillments

getTotalPrice

setTotalPrice

getTotalPriceV2