com.commercetools.importapi.models.orders

Interface OrderImport

All Known Implementing Classes:

OrderImportImpl

public interface OrderImport

The data representation for an Order to be imported that is persisted as an Order in the Project.

In commercetools, you can import an Order using the Create Order by Import endpoint method instead of creating it from a Cart.

An OrderImport is a snapshot of an order at the time it was imported.

Example to create an instance using the builder pattern

     OrderImport orderImport = OrderImport.builder()
             .orderNumber("{orderNumber}")
             .totalPrice(totalPriceBuilder -> totalPriceBuilder)
             .build()
 

Method Summary

Modifier and Type	Method and Description
static OrderImportBuilder	builder()
static OrderImportBuilder	builder(OrderImport template)
@Valid Address	getBillingAddress() Maps to Order.billingAddress.
ZonedDateTime	getCompletedAt() Maps to Order.completedAt.
String	getCountry() Maps to Order.country.
@Valid Custom	getCustom() Maps to Order.custom.
@Valid CustomerKeyReference	getCustomer()
String	getCustomerEmail() Maps to Order.customerEmail.
@Valid CustomerGroupKeyReference	getCustomerGroup() Maps to Order.customerGroup.
@Valid List<CustomLineItemDraft>	getCustomLineItems() Maps to Order.customLineItems
InventoryMode	getInventoryMode() Maps to Order.inventoryMode.
@Valid List<Address>	getItemShippingAddresses() Maps to Order.itemShippingAddresses.
@Valid List<LineItemImportDraft>	getLineItems() Maps to Order.lineItems.
@NotNull String	getOrderNumber() Maps to Order.orderNumber, String that uniquely identifies an order.
OrderState	getOrderState() Maps to Order.orderState.
CartOrigin	getOrigin() Maps to Order.origin.
PaymentState	getPaymentState() Maps to Order.paymentState.
ShipmentState	getShipmentState() Maps to Order.shipmentState.
@Valid Address	getShippingAddress() Maps to Order.shippingAddress.
@Valid ShippingInfoImportDraft	getShippingInfo() Maps to Order.shippingInfo.
TaxCalculationMode	getTaxCalculationMode() Maps to Order.taxCalculationMode.
@Valid TaxedPrice	getTaxedPrice() Maps to Order.taxedPrice.
RoundingMode	getTaxRoundingMode() Maps to Order.taxRoundingMode.
@NotNull @Valid TypedMoney	getTotalPrice() Maps to Order.totalPrice.
static OrderImport	of()
static OrderImport	of(OrderImport template)
void	setBillingAddress(Address billingAddress)
void	setCompletedAt(ZonedDateTime completedAt)
void	setCountry(String country)
void	setCustom(Custom custom)
void	setCustomer(CustomerKeyReference customer)
void	setCustomerEmail(String customerEmail)
void	setCustomerGroup(CustomerGroupKeyReference customerGroup)
void	setCustomLineItems(CustomLineItemDraft... customLineItems)
void	setCustomLineItems(List<CustomLineItemDraft> customLineItems)
void	setInventoryMode(InventoryMode inventoryMode)
void	setItemShippingAddresses(Address... itemShippingAddresses)
void	setItemShippingAddresses(List<Address> itemShippingAddresses)
void	setLineItems(LineItemImportDraft... lineItems)
void	setLineItems(List<LineItemImportDraft> lineItems)
void	setOrderNumber(String orderNumber)
void	setOrderState(OrderState orderState)
void	setOrigin(CartOrigin origin)
void	setPaymentState(PaymentState paymentState)
void	setShipmentState(ShipmentState shipmentState)
void	setShippingAddress(Address shippingAddress)
void	setShippingInfo(ShippingInfoImportDraft shippingInfo)
void	setTaxCalculationMode(TaxCalculationMode taxCalculationMode)
void	setTaxedPrice(TaxedPrice taxedPrice)
void	setTaxRoundingMode(RoundingMode taxRoundingMode)
void	setTotalPrice(TypedMoney totalPrice)
static com.fasterxml.jackson.core.type.TypeReference<OrderImport>	typeReference()
default <T> T	withOrderImport(Function<OrderImport,T> helper)

Method Detail

getOrderNumber

@NotNull
@NotNull String getOrderNumber()

Maps to Order.orderNumber, String that uniquely identifies an order. It should be unique across a project. Once it's set it cannot be changed.

getCustomer

@Valid
@Valid CustomerKeyReference getCustomer()

getCustomerEmail

String getCustomerEmail()

Maps to Order.customerEmail.

getLineItems

@Valid
@Valid List<LineItemImportDraft> getLineItems()

Maps to Order.lineItems.

getCustomLineItems

@Valid
@Valid List<CustomLineItemDraft> getCustomLineItems()

Maps to Order.customLineItems

getTotalPrice

@NotNull
 @Valid
@NotNull @Valid TypedMoney getTotalPrice()

Maps to Order.totalPrice.

getTaxedPrice

@Valid
@Valid TaxedPrice getTaxedPrice()

Maps to Order.taxedPrice.

getShippingAddress

@Valid
@Valid Address getShippingAddress()

Maps to Order.shippingAddress.

getBillingAddress

@Valid
@Valid Address getBillingAddress()

Maps to Order.billingAddress.

getCustomerGroup

@Valid
@Valid CustomerGroupKeyReference getCustomerGroup()

Maps to Order.customerGroup.

getCountry

String getCountry()

Maps to Order.country.

getOrderState

OrderState getOrderState()

Maps to Order.orderState.

getShipmentState

ShipmentState getShipmentState()

Maps to Order.shipmentState.

getPaymentState

PaymentState getPaymentState()

Maps to Order.paymentState.

getShippingInfo

@Valid
@Valid ShippingInfoImportDraft getShippingInfo()

Maps to Order.shippingInfo.

getCompletedAt

ZonedDateTime getCompletedAt()

Maps to Order.completedAt.

getCustom

@Valid
@Valid Custom getCustom()

Maps to Order.custom.

getInventoryMode

InventoryMode getInventoryMode()

Maps to Order.inventoryMode.

getTaxRoundingMode

RoundingMode getTaxRoundingMode()

Maps to Order.taxRoundingMode.

getTaxCalculationMode

TaxCalculationMode getTaxCalculationMode()

Maps to Order.taxCalculationMode.

getOrigin

CartOrigin getOrigin()

Maps to Order.origin.

getItemShippingAddresses

@Valid
@Valid List<Address> getItemShippingAddresses()

Maps to Order.itemShippingAddresses.

setOrderNumber

void setOrderNumber(String orderNumber)

setCustomer

void setCustomer(CustomerKeyReference customer)

setCustomerEmail

void setCustomerEmail(String customerEmail)

setLineItems

void setLineItems(LineItemImportDraft... lineItems)

setLineItems

void setLineItems(List<LineItemImportDraft> lineItems)

setCustomLineItems

void setCustomLineItems(CustomLineItemDraft... customLineItems)

setCustomLineItems

void setCustomLineItems(List<CustomLineItemDraft> customLineItems)

setTotalPrice

void setTotalPrice(TypedMoney totalPrice)

setTaxedPrice

void setTaxedPrice(TaxedPrice taxedPrice)

setShippingAddress

void setShippingAddress(Address shippingAddress)

setBillingAddress

void setBillingAddress(Address billingAddress)

setCustomerGroup

void setCustomerGroup(CustomerGroupKeyReference customerGroup)

setCountry

void setCountry(String country)

setOrderState

void setOrderState(OrderState orderState)

setShipmentState

void setShipmentState(ShipmentState shipmentState)

setPaymentState

void setPaymentState(PaymentState paymentState)

setShippingInfo

void setShippingInfo(ShippingInfoImportDraft shippingInfo)

setCompletedAt

void setCompletedAt(ZonedDateTime completedAt)

setCustom

void setCustom(Custom custom)

setInventoryMode

void setInventoryMode(InventoryMode inventoryMode)

setTaxRoundingMode

void setTaxRoundingMode(RoundingMode taxRoundingMode)

setTaxCalculationMode

void setTaxCalculationMode(TaxCalculationMode taxCalculationMode)

setOrigin

void setOrigin(CartOrigin origin)

setItemShippingAddresses

void setItemShippingAddresses(Address... itemShippingAddresses)

setItemShippingAddresses

void setItemShippingAddresses(List<Address> itemShippingAddresses)

of

static OrderImport of()

of

static OrderImport of(OrderImport template)

builder

static OrderImportBuilder builder()

builder

static OrderImportBuilder builder(OrderImport template)

withOrderImport

default <T> T withOrderImport(Function<OrderImport,T> helper)

typeReference

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