com.shopify.buy3

Class Storefront.Order

java.lang.Object

<any>

com.shopify.buy3.Storefront.Order

All Implemented Interfaces:

Storefront.Node

Enclosing class:

Storefront

public static class Storefront.Order
extends <any>
implements 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.

Constructor Summary

Constructors

Constructor and Description
Order()
Order(ID id)
Order(JsonObject fields)

Method Summary

Modifier and Type	Method and Description
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	getCurrentTotalTax() The total of all taxes applied to the order, excluding taxes for returned line items.
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() Globally unique identifier.
Storefront.OrderLineItemConnection	getLineItems() List of the order’s line items.
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.
java.math.BigDecimal	getSubtotalPrice() Deprecated. Use `subtotalPriceV2` instead
Storefront.MoneyV2	getSubtotalPriceV2() Price of the order before duties, shipping and taxes.
java.util.List<Storefront.Fulfillment>	getSuccessfulFulfillments() List of the order’s successful fulfillments.
java.math.BigDecimal	getTotalPrice() Deprecated. Use `totalPriceV2` instead
Storefront.MoneyV2	getTotalPriceV2() The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).
java.math.BigDecimal	getTotalRefunded() Deprecated. Use `totalRefundedV2` instead
Storefront.MoneyV2	getTotalRefundedV2() The total amount that has been refunded.
java.math.BigDecimal	getTotalShippingPrice() Deprecated. Use `totalShippingPriceV2` instead
Storefront.MoneyV2	getTotalShippingPriceV2() The total cost of shipping.
java.math.BigDecimal	getTotalTax() Deprecated. Use `totalTaxV2` instead
Storefront.MoneyV2	getTotalTaxV2() The total cost of taxes.
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	setCurrentTotalTax(Storefront.MoneyV2 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	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(java.math.BigDecimal arg)
Storefront.Order	setSubtotalPriceV2(Storefront.MoneyV2 arg)
Storefront.Order	setSuccessfulFulfillments(java.util.List<Storefront.Fulfillment> arg)
Storefront.Order	setTotalPrice(java.math.BigDecimal arg)
Storefront.Order	setTotalPriceV2(Storefront.MoneyV2 arg)
Storefront.Order	setTotalRefunded(java.math.BigDecimal arg)
Storefront.Order	setTotalRefundedV2(Storefront.MoneyV2 arg)
Storefront.Order	setTotalShippingPrice(java.math.BigDecimal arg)
Storefront.Order	setTotalShippingPriceV2(Storefront.MoneyV2 arg)
Storefront.Order	setTotalTax(java.math.BigDecimal arg)
Storefront.Order	setTotalTaxV2(Storefront.MoneyV2 arg)
boolean	unwrapsToObject(java.lang.String key)

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

Order

public Order(ID id)

Method Detail

getGraphQlTypeName

public java.lang.String getGraphQlTypeName()

Specified by:

getGraphQlTypeName in interface Storefront.Node

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 are not 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)

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)

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()

Globally unique identifier.

Specified by:

getId in interface Storefront.Node

getLineItems

public Storefront.OrderLineItemConnection getLineItems()

List of the order’s line items.

setLineItems

public Storefront.Order setLineItems(Storefront.OrderLineItemConnection 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 java.math.BigDecimal getSubtotalPrice()

Deprecated. Use `subtotalPriceV2` instead

Price of the order before shipping and taxes.

setSubtotalPrice

public Storefront.Order setSubtotalPrice(java.math.BigDecimal arg)

getSubtotalPriceV2

public Storefront.MoneyV2 getSubtotalPriceV2()

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 java.math.BigDecimal getTotalPrice()

Deprecated. Use `totalPriceV2` instead

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

setTotalPrice

public Storefront.Order setTotalPrice(java.math.BigDecimal arg)

getTotalPriceV2

public Storefront.MoneyV2 getTotalPriceV2()

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 java.math.BigDecimal getTotalRefunded()

Deprecated. Use `totalRefundedV2` instead

The total amount that has been refunded.

setTotalRefunded

public Storefront.Order setTotalRefunded(java.math.BigDecimal arg)

getTotalRefundedV2

public Storefront.MoneyV2 getTotalRefundedV2()

The total amount that has been refunded.

setTotalRefundedV2

public Storefront.Order setTotalRefundedV2(Storefront.MoneyV2 arg)

getTotalShippingPrice

public java.math.BigDecimal getTotalShippingPrice()

Deprecated. Use `totalShippingPriceV2` instead

The total cost of shipping.

setTotalShippingPrice

public Storefront.Order setTotalShippingPrice(java.math.BigDecimal arg)

getTotalShippingPriceV2

public Storefront.MoneyV2 getTotalShippingPriceV2()

The total cost of shipping.

setTotalShippingPriceV2

public Storefront.Order setTotalShippingPriceV2(Storefront.MoneyV2 arg)

getTotalTax

public java.math.BigDecimal getTotalTax()

Deprecated. Use `totalTaxV2` instead

The total cost of taxes.

setTotalTax

public Storefront.Order setTotalTax(java.math.BigDecimal arg)

getTotalTaxV2

public Storefront.MoneyV2 getTotalTaxV2()

The total cost of taxes.

setTotalTaxV2

public Storefront.Order setTotalTaxV2(Storefront.MoneyV2 arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)