io.sphere.sdk.orders

Interface Order

All Superinterfaces:

CartLike<Order>, CreationTimestamped, Custom, Identifiable<Order>, Referenceable<Order>, Resource<Order>, ResourceIdentifiable<Order>, ResourceView<Order,Order>, Timestamped, Versioned<Order>

public interface Order
extends CartLike<Order>

An order can be created from a cart, usually after a checkout process has been completed. Orders can also be imported.

An order can have custom fields.

See Also:

Cart, OrderFromCartCreateCommand, OrderDeleteCommand, OrderImportCommand, OrderUpdateCommand, OrderByIdGet, OrderQuery

Method Summary

Modifier and Type	Method and Description
Address	getBillingAddress() The billing address.
Reference<Cart>	getCart() Set when this order was created from a cart.
ZonedDateTime	getCompletedAt()
com.neovisionaries.i18n.CountryCode	getCountry()
CustomFields	getCustom()
String	getCustomerEmail() The email of the customer which should be used for this cart/order.
Reference<CustomerGroup>	getCustomerGroup() In the order context the customer group can only be expanded if the customer was in a group before creating the order.
String	getCustomerId() The ID of the customer to which this cart/order belongs to.
List<CustomLineItem>	getCustomLineItems() Custom goods, fees or discounts added to the cart.
List<DiscountCodeInfo>	getDiscountCodes() Discount codes belonging to this cart.
InventoryMode	getInventoryMode()
List<Address>	getItemShippingAddresses()
Long	getLastMessageSequenceNumber()
List<LineItem>	getLineItems() Snapshots of the products added to the cart.
String	getOrderNumber() String that uniquely identifies an order.
OrderState	getOrderState() State of this order.
PaymentInfo	getPaymentInfo() Get associated payments.
PaymentState	getPaymentState() Payment state of this order.
List<Reference<CartDiscount>>	getRefusedGifts() The refused gifts of this cart.
List<ReturnInfo>	getReturnInfo()
ShipmentState	getShipmentState() Shipment state of this order.
Address	getShippingAddress() The shipping address.
OrderShippingInfo	getShippingInfo() Information about shipping set by the backend once the shipping method is set.
ShippingRateInput	getShippingRateInput() The shippingRateInput is used as an input to select a shipping rate price tier
Reference<State>	getState() Returns this state of this Order.
KeyReference<Store>	getStore()
Set<SyncInfo>	getSyncInfo() Sync info of this order.
TaxedPrice	getTaxedPrice() The taxed price.
javax.money.MonetaryAmount	getTotalPrice()
static Reference<Order>	referenceOfId(String id) Creates a reference for one item of this class by a known ID.
static String	referenceTypeId() A type hint for references which resource type is linked in a reference.
static String	resourceTypeId() An identifier for this resource which supports CustomFields.
default Reference<Order>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<Order>	typeReference() Creates a container which contains the full Java type information to deserialize this class from JSON.

Methods inherited from interface io.sphere.sdk.carts.CartLike

calculateSubTotalPrice, calculateTotalAppliedTaxes, findCustomLineItem, findLineItem, getAnonymousId, getCurrency, getLocale, getOrigin, getTaxCalculationMode, getTaxMode, getTaxRoundingMode

Methods inherited from interface io.sphere.sdk.models.Resource

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from interface io.sphere.sdk.models.Versioned

of, of

Methods inherited from interface io.sphere.sdk.models.Referenceable

hasSameIdAs, toResourceIdentifier

Method Detail

resourceTypeId

static String resourceTypeId()

An identifier for this resource which supports CustomFields.

Returns:

ID of this resource type

See Also:

TypeDraft.getResourceTypeIds(), Custom

referenceTypeId

static String referenceTypeId()

A type hint for references which resource type is linked in a reference.

Returns:

type hint

See Also:

Reference.getTypeId()

typeReference

static com.fasterxml.jackson.core.type.TypeReference<Order> typeReference()

Creates a container which contains the full Java type information to deserialize this class from JSON.

Returns:

type reference

See Also:

SphereJsonUtils.readObject(byte[], TypeReference), SphereJsonUtils.readObject(String, TypeReference), SphereJsonUtils.readObject(com.fasterxml.jackson.databind.JsonNode, TypeReference), SphereJsonUtils.readObjectFromResource(String, TypeReference)

toReference

default Reference<Order> toReference()

Description copied from interface: Referenceable

Creates a reference to this resource, the reference may not be filled.

Specified by:

toReference in interface Referenceable<Order>

Specified by:

toReference in interface Resource<Order>

Returns:

reference

getOrderNumber

@Nullable
String getOrderNumber()

String that uniquely identifies an order. It can be used to create more human-readable (in contrast to ID) identifier for the order. It should be unique across a project. Once it’s set it cannot be changed.

Returns:

order number or null

getInventoryMode

InventoryMode getInventoryMode()

getOrderState

OrderState getOrderState()

State of this order.

Returns:

state

See Also:

ChangeOrderState

getShipmentState

@Nullable
ShipmentState getShipmentState()

Shipment state of this order.

Returns:

shipment state or null

See Also:

ChangeShipmentState

getPaymentState

@Nullable
PaymentState getPaymentState()

Payment state of this order.

Returns:

payment state or null

See Also:

ChangePaymentState

getShippingInfo

@Nullable
OrderShippingInfo getShippingInfo()

Description copied from interface: CartLike

Information about shipping set by the backend once the shipping method is set.

Specified by:

getShippingInfo in interface CartLike<Order>

Returns:

shipping info

See Also:

SetShippingMethod, SetCustomShippingMethod, AddDelivery

getSyncInfo

Set<SyncInfo> getSyncInfo()

Sync info of this order.

Returns:

sync infos

See Also:

UpdateSyncInfo

getReturnInfo

List<ReturnInfo> getReturnInfo()

getLastMessageSequenceNumber

Long getLastMessageSequenceNumber()

getBillingAddress

@Nullable
Address getBillingAddress()

The billing address.

Specified by:

getBillingAddress in interface CartLike<Order>

Returns:

address or null

See Also:

SetBillingAddress, OrderBillingAddressSetMessage

getCountry

@Nullable
com.neovisionaries.i18n.CountryCode getCountry()

Specified by:

getCountry in interface CartLike<Order>

getCustomerEmail

@Nullable
String getCustomerEmail()

Description copied from interface: CartLike

The email of the customer which should be used for this cart/order. It can differ from Customer.getEmail().

Specified by:

getCustomerEmail in interface CartLike<Order>

Returns:

email

See Also:

SetCustomerEmail

getCustomerGroup

@Nullable
Reference<CustomerGroup> getCustomerGroup()

Description copied from interface: CartLike

In the order context the customer group can only be expanded if the customer was in a group before creating the order.

Specified by:

getCustomerGroup in interface CartLike<Order>

Returns:

reference of a customer group or null

getCustomerId

@Nullable
String getCustomerId()

Description copied from interface: CartLike

The ID of the customer to which this cart/order belongs to.

Specified by:

getCustomerId in interface CartLike<Order>

Returns:

id of the customer or null

See Also:

CustomerSignInCommand, SetCustomerId

getCustomLineItems

List<CustomLineItem> getCustomLineItems()

Description copied from interface: CartLike

Custom goods, fees or discounts added to the cart.

Specified by:

getCustomLineItems in interface CartLike<Order>

Returns:

custom line items

See Also:

AddCustomLineItem, RemoveCustomLineItem

getLineItems

List<LineItem> getLineItems()

Description copied from interface: CartLike

Snapshots of the products added to the cart.

Specified by:

getLineItems in interface CartLike<Order>

Returns:

line items

See Also:

AddLineItem, ChangeLineItemQuantity, RemoveLineItem

getShippingAddress

@Nullable
Address getShippingAddress()

The shipping address.

Specified by:

getShippingAddress in interface CartLike<Order>

Returns:

address or null

See Also:

SetShippingAddress, OrderShippingAddressSetMessage

getTaxedPrice

@Nullable
TaxedPrice getTaxedPrice()

Description copied from interface: CartLike

The taxed price. The shipping address (CartLike.getShippingAddress()) is used to determine tax rate of the line items.

Specified by:

getTaxedPrice in interface CartLike<Order>

Returns:

taxed price or null

getTotalPrice

javax.money.MonetaryAmount getTotalPrice()

Specified by:

getTotalPrice in interface CartLike<Order>

getCompletedAt

ZonedDateTime getCompletedAt()

getCart

@Nullable
Reference<Cart> getCart()

Set when this order was created from a cart. The cart will have the state Ordered.

Returns:

cart reference or null

getDiscountCodes

List<DiscountCodeInfo> getDiscountCodes()

Description copied from interface: CartLike

Discount codes belonging to this cart.

Specified by:

getDiscountCodes in interface CartLike<Order>

Returns:

discount codes

See Also:

AddDiscountCode

getRefusedGifts

@Nullable
List<Reference<CartDiscount>> getRefusedGifts()

The refused gifts of this cart. Automatically filled when a line item with LineItemMode.GIFT_LINE_ITEM is removed from this order.

Returns:

the refused gifts of this cart

getCustom

@Nullable
CustomFields getCustom()

Specified by:

getCustom in interface CartLike<Order>

Specified by:

getCustom in interface Custom

getState

@Nullable
Reference<State> getState()

Returns this state of this Order.

Returns:

state of this order or null

See Also:

TransitionState

getPaymentInfo

@Nullable
PaymentInfo getPaymentInfo()

Get associated payments.

Specified by:

getPaymentInfo in interface CartLike<Order>

Returns:

payments

See Also:

AddPayment, RemovePayment

getShippingRateInput

@Nullable
ShippingRateInput getShippingRateInput()

The shippingRateInput is used as an input to select a shipping rate price tier

Specified by:

getShippingRateInput in interface CartLike<Order>

Returns:

shippingRateInput

getItemShippingAddresses

List<Address> getItemShippingAddresses()

Specified by:

getItemShippingAddresses in interface CartLike<Order>

Returns:

addresses for orders with multiple shipping addresses.

getStore

@Nullable
KeyReference<Store> getStore()

referenceOfId

static Reference<Order> referenceOfId(String id)

Creates a reference for one item of this class by a known ID.

An example for categories but this applies for other resources, too:

final String categoryIdFromFormOrSession = "84ac4271-0fec-49d0-9fee-55586c565c58";
final Reference<Category> categoryReference = Category.referenceOfId(categoryIdFromFormOrSession);
assertThat(categoryReference.getId()).isEqualTo(categoryIdFromFormOrSession);
See the test code.

If you already have a resource object, then use toReference() instead:

final Category category = getCategory1();
final Reference<Category> categoryReference = category.toReference();
assertThat(category.getId()).isEqualTo(categoryReference.getId());
See the test code.

Parameters:

id - the ID of the resource which should be referenced.

Returns:

reference