Package com.commercetools.api.models.order

Interface Order

All Superinterfaces:
BaseResource, Customizable<Order>, DomainResource<Order>, Identifiable<Order>, OrderLike<Order>, OrderMixin, Referencable<Order>, ResourceIdentifiable<Order>, Versioned<Order>
All Known Subinterfaces:
StagedOrder
public interface Order extends BaseResource, OrderMixin, DomainResource<Order>, Referencable<Order>, ResourceIdentifiable<Order>, Customizable<Order>, OrderLike<Order>
Order
Example to create an instance using the builder pattern 

     Order order = Order.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .plusLineItems(lineItemsBuilder -> lineItemsBuilder)
             .plusCustomLineItems(customLineItemsBuilder -> customLineItemsBuilder)
             .totalPrice(totalPriceBuilder -> totalPriceBuilder)
             .shippingMode(ShippingMode.SINGLE)
             .plusShipping(shippingBuilder -> shippingBuilder)
             .plusRefusedGifts(refusedGiftsBuilder -> refusedGiftsBuilder)
             .origin(CartOrigin.CUSTOMER)
             .orderState(OrderState.OPEN)
             .plusSyncInfo(syncInfoBuilder -> syncInfoBuilder)
             .build()

  • Method Details

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the Order.

      Specified by:
      getId in interface BaseResource
      Specified by:
      getId in interface DomainResource<Order>
      Specified by:
      getId in interface Identifiable<Order>
      Specified by:
      getId in interface OrderLike<Order>
      Specified by:
      getId in interface Versioned<Order>
      Returns:
      id

    • getVersion

      @NotNull @NotNull Long getVersion()

      Current version of the Order.

      Specified by:
      getVersion in interface BaseResource
      Specified by:
      getVersion in interface DomainResource<Order>
      Specified by:
      getVersion in interface OrderLike<Order>
      Specified by:
      getVersion in interface Versioned<Order>
      Returns:
      version

    • getOrderNumber

      String getOrderNumber()

      User-defined identifier of the Order that is unique across a Project.

      Returns:
      orderNumber

    • getPurchaseOrderNumber

      String getPurchaseOrderNumber()

      User-defined identifier of a purchase Order.

      It is typically set by the Buyer and can be used with Quotes to track the purchase Order during the quote and order flow.

      Returns:
      purchaseOrderNumber

    • getCustomerId

      String getCustomerId()

      id of the Customer that the Order belongs to.

      Specified by:
      getCustomerId in interface OrderLike<Order>
      Returns:
      customerId

    • getCustomerEmail

      String getCustomerEmail()

      Email address of the Customer that the Order belongs to.

      Specified by:
      getCustomerEmail in interface OrderLike<Order>
      Returns:
      customerEmail

    • getCustomerGroup

      @Valid @Valid CustomerGroupReference getCustomerGroup()

      Reference to the Customer Group of the Customer that the Order belongs to. Used for Line Item price selection.

      Specified by:
      getCustomerGroup in interface OrderLike<Order>
      Returns:
      customerGroup

    • getAnonymousId

      String getAnonymousId()

      Anonymous session associated with the Order.

      Specified by:
      getAnonymousId in interface OrderLike<Order>
      Returns:
      anonymousId

    • getBusinessUnit

      @Valid @Valid BusinessUnitKeyReference getBusinessUnit()

      Reference to a Business Unit the Order belongs to. Only available for B2B-enabled Projects.

      Returns:
      businessUnit

    • getStore

      @Valid @Valid StoreKeyReference getStore()

      Reference to a Store the Order belongs to.

      Specified by:
      getStore in interface OrderLike<Order>
      Returns:
      store

    • getLineItems

      @NotNull @Valid @NotNull @Valid List<LineItem> getLineItems()

      Line Items that are part of the Order.

      Specified by:
      getLineItems in interface OrderLike<Order>
      Returns:
      lineItems

    • getCustomLineItems

      @NotNull @Valid @NotNull @Valid List<CustomLineItem> getCustomLineItems()

      Custom Line Items that are part of the Order.

      Specified by:
      getCustomLineItems in interface OrderLike<Order>
      Returns:
      customLineItems

    • getTotalPrice

      @NotNull @Valid @NotNull @Valid CentPrecisionMoney getTotalPrice()

      Sum of the totalPrice field of all LineItems and CustomLineItems, and if available, the price field of ShippingInfo. If a discount applies on totalPrice, this field holds the discounted value.

      Taxes are included if TaxRate includedInPrice is true for each price.

      Specified by:
      getTotalPrice in interface OrderLike<Order>
      Returns:
      totalPrice

    • getTaxedPrice

      @Valid @Valid TaxedPrice getTaxedPrice()
      • For Platform TaxMode, it is automatically set when a shipping address is set.
      • For External TaxMode, it is automatically set when shippingAddress and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.

      If a discount applies on totalPrice, this field holds the proportionally discounted value.

      Specified by:
      getTaxedPrice in interface OrderLike<Order>
      Returns:
      taxedPrice

    • getTaxedShippingPrice

      @Valid @Valid TaxedPrice getTaxedShippingPrice()

      Sum of the taxedPrice field of ShippingInfo across all Shipping Methods.

      If a discount applies on totalPrice, this field holds the proportionally discounted value.

      Returns:
      taxedShippingPrice

    • getDiscountOnTotalPrice

      @Valid @Valid DiscountOnTotalPrice getDiscountOnTotalPrice()

      Discounts that apply on the total price of the Order.

      Returns:
      discountOnTotalPrice

    • getPriceRoundingMode

      RoundingMode getPriceRoundingMode()

      Indicates how the total prices on LineItems and CustomLineItems are rounded when calculated.

      Returns:
      priceRoundingMode

    • getTaxMode

      TaxMode getTaxMode()

      Indicates how Tax Rates are set.

      Specified by:
      getTaxMode in interface OrderLike<Order>
      Returns:
      taxMode

    • getTaxRoundingMode

      RoundingMode getTaxRoundingMode()

      Indicates how monetary values are rounded when calculating taxes for taxedPrice.

      Specified by:
      getTaxRoundingMode in interface OrderLike<Order>
      Returns:
      taxRoundingMode

    • getTaxCalculationMode

      TaxCalculationMode getTaxCalculationMode()

      Indicates how taxes are calculated when calculating taxes for taxedPrice.

      Specified by:
      getTaxCalculationMode in interface OrderLike<Order>
      Returns:
      taxCalculationMode

    • getInventoryMode

      InventoryMode getInventoryMode()

      Indicates how stock quantities are tracked for Line Items in the Order.

      Specified by:
      getInventoryMode in interface OrderLike<Order>
      Returns:
      inventoryMode

    • getBillingAddress

      @Valid @Valid Address getBillingAddress()

      Billing address associated with the Order.

      Specified by:
      getBillingAddress in interface OrderLike<Order>
      Returns:
      billingAddress

    • getShippingAddress

      @Valid @Valid Address getShippingAddress()

      Shipping address associated with the Order. Determines eligible ShippingMethod rates and Tax Rates of Line Items.

      Specified by:
      getShippingAddress in interface OrderLike<Order>
      Returns:
      shippingAddress

    • getShippingMode

      @NotNull @NotNull ShippingMode getShippingMode()

      Indicates whether there can be one or multiple Shipping Methods.

      Returns:
      shippingMode

    • getShippingKey

      String getShippingKey()

      key of the ShippingMethod for Single ShippingMode.

      Returns:
      shippingKey

    • getShippingInfo

      @Valid @Valid ShippingInfo getShippingInfo()

      Shipping-related information for Single ShippingMode. Automatically set when a Shipping Method is set.

      Specified by:
      getShippingInfo in interface OrderLike<Order>
      Returns:
      shippingInfo

    • getShippingRateInput

      @Valid @Valid ShippingRateInput getShippingRateInput()

      Input used to select a ShippingRatePriceTier. The data type of this field depends on the shippingRateInputType.type configured in the Project:

      Specified by:
      getShippingRateInput in interface OrderLike<Order>
      Returns:
      shippingRateInput

    • getShippingCustomFields

      @Valid @Valid CustomFields getShippingCustomFields()

      Custom Fields of the Shipping Method for Single ShippingMode.

      Specified by:
      getShippingCustomFields in interface OrderLike<Order>
      Returns:
      shippingCustomFields

    • getShipping

      @NotNull @Valid @NotNull @Valid List<Shipping> getShipping()

      Shipping-related information for Multiple ShippingMode. Updated automatically each time a new Shipping Method is added.

      Returns:
      shipping

    • getItemShippingAddresses

      @Valid @Valid List<Address> getItemShippingAddresses()

      Additional shipping addresses of the Order as specified by LineItems using the shippingDetails field. Eligible Shipping Methods or applicable Tax Rates are determined by the address in shippingAddress, and not itemShippingAddresses.

      Specified by:
      getItemShippingAddresses in interface OrderLike<Order>
      Returns:
      itemShippingAddresses

    • getDiscountCodes

      @Valid @Valid List<DiscountCodeInfo> getDiscountCodes()

      Discount Codes added to the Order. An Order that has directDiscounts cannot have discountCodes.

      Specified by:
      getDiscountCodes in interface OrderLike<Order>
      Returns:
      discountCodes

    • getDirectDiscounts

      @Valid @Valid List<DirectDiscount> getDirectDiscounts()

      Direct Discounts added to the Order. An Order that has discountCodes cannot have directDiscounts.

      Returns:
      directDiscounts

    • getRefusedGifts

      @NotNull @Valid @NotNull @Valid List<CartDiscountReference> getRefusedGifts()

      Automatically set when a Line Item with GiftLineItem LineItemMode is removed from the Order.

      Specified by:
      getRefusedGifts in interface OrderLike<Order>
      Returns:
      refusedGifts

    • getPaymentInfo

      @Valid @Valid PaymentInfo getPaymentInfo()

      Payment information related to the Order.

      Specified by:
      getPaymentInfo in interface OrderLike<Order>
      Returns:
      paymentInfo

    • getCountry

      String getCountry()

      Used for Line Item price selection.

      Specified by:
      getCountry in interface OrderLike<Order>
      Returns:
      country

    • getLocale

      String getLocale()

      Languages of the Order. Can only contain languages supported by the Project.

      Specified by:
      getLocale in interface OrderLike<Order>
      Returns:
      locale

    • getOrigin

      @NotNull @NotNull CartOrigin getOrigin()

      Indicates the origin of the Cart from which the Order was created.

      Specified by:
      getOrigin in interface OrderLike<Order>
      Returns:
      origin

    • getCart

      @Valid @Valid CartReference getCart()

      Reference to the Cart for an Order created from Cart. The referenced Cart will have the Ordered CartState.

      Returns:
      cart

    • getQuote

      @Valid @Valid QuoteReference getQuote()

      Reference to the Quote for an Order created from Quote.

      Returns:
      quote

    • getRecurringOrder

      @Valid @Valid RecurringOrderReference getRecurringOrder()

      Reference to the RecurringOrder that generated this Order.

      Returns:
      recurringOrder

    • getOrderState

      @NotNull @NotNull OrderState getOrderState()

      Current status of the Order.

      Returns:
      orderState

    • getShipmentState

      ShipmentState getShipmentState()

      Shipment status of the Order.

      Returns:
      shipmentState

    • getPaymentState

      PaymentState getPaymentState()

      Payment status of the Order.

      Returns:
      paymentState

    • getState

      @Valid @Valid StateReference getState()

      State of the Order. This reference can point to a State in a custom workflow.

      Returns:
      state

    • getSyncInfo

      @NotNull @Valid @NotNull @Valid List<SyncInfo> getSyncInfo()

      Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.

      Returns:
      syncInfo

    • getReturnInfo

      @Valid @Valid List<ReturnInfo> getReturnInfo()

      Contains information regarding the returns associated with the Order.

      Returns:
      returnInfo

    • getDiscountTypeCombination

      @Valid @Valid DiscountTypeCombination getDiscountTypeCombination()

      Indicates if a combination of discount types can apply on an Order.

      Returns:
      discountTypeCombination

    • getLastMessageSequenceNumber

      @Deprecated Long getLastMessageSequenceNumber()
      Deprecated.

      Internal-only field.

      Returns:
      lastMessageSequenceNumber

    • getCustom

      @Valid @Valid CustomFields getCustom()

      Custom Fields of the Order.

      Specified by:
      getCustom in interface Customizable<Order>
      Specified by:
      getCustom in interface OrderLike<Order>
      Returns:
      custom

    • getCompletedAt

      ZonedDateTime getCompletedAt()

      User-defined date and time (UTC) of the Order. Present only on an Order created using Order Import.

      Returns:
      completedAt

    • getCreatedAt

      @NotNull @NotNull ZonedDateTime getCreatedAt()

      Date and time (UTC) the Order was initially created.

      Specified by:
      getCreatedAt in interface BaseResource
      Specified by:
      getCreatedAt in interface OrderLike<Order>
      Returns:
      createdAt

    • getLastModifiedAt

      @NotNull @NotNull ZonedDateTime getLastModifiedAt()

      Date and time (UTC) the Order was last updated.

      Specified by:
      getLastModifiedAt in interface BaseResource
      Specified by:
      getLastModifiedAt in interface OrderLike<Order>
      Returns:
      lastModifiedAt

    • getLastModifiedBy

      @Valid @Valid LastModifiedBy getLastModifiedBy()

      IDs and references that last modified the Order.

      Specified by:
      getLastModifiedBy in interface OrderLike<Order>
      Returns:
      lastModifiedBy

    • getCreatedBy

      @Valid @Valid CreatedBy getCreatedBy()

      IDs and references that created the Order.

      Specified by:
      getCreatedBy in interface OrderLike<Order>
      Returns:
      createdBy

    • setId

      void setId(String id)

      Unique identifier of the Order.

      Specified by:
      setId in interface BaseResource
      Parameters:
      id - value to be set

    • setVersion

      void setVersion(Long version)

      Current version of the Order.

      Specified by:
      setVersion in interface BaseResource
      Parameters:
      version - value to be set

    • setOrderNumber

      void setOrderNumber(String orderNumber)

      User-defined identifier of the Order that is unique across a Project.

      Parameters:
      orderNumber - value to be set

    • setPurchaseOrderNumber

      void setPurchaseOrderNumber(String purchaseOrderNumber)

      User-defined identifier of a purchase Order.

      It is typically set by the Buyer and can be used with Quotes to track the purchase Order during the quote and order flow.

      Parameters:
      purchaseOrderNumber - value to be set

    • setCustomerId

      void setCustomerId(String customerId)

      id of the Customer that the Order belongs to.

      Parameters:
      customerId - value to be set

    • setCustomerEmail

      void setCustomerEmail(String customerEmail)

      Email address of the Customer that the Order belongs to.

      Parameters:
      customerEmail - value to be set

    • setCustomerGroup

      void setCustomerGroup(CustomerGroupReference customerGroup)

      Reference to the Customer Group of the Customer that the Order belongs to. Used for Line Item price selection.

      Parameters:
      customerGroup - value to be set

    • setAnonymousId

      void setAnonymousId(String anonymousId)

      Anonymous session associated with the Order.

      Parameters:
      anonymousId - value to be set

    • setBusinessUnit

      void setBusinessUnit(BusinessUnitKeyReference businessUnit)

      Reference to a Business Unit the Order belongs to. Only available for B2B-enabled Projects.

      Parameters:
      businessUnit - value to be set

    • setStore

      void setStore(StoreKeyReference store)

      Reference to a Store the Order belongs to.

      Parameters:
      store - value to be set

    • setLineItems

      void setLineItems(LineItem... lineItems)

      Line Items that are part of the Order.

      Parameters:
      lineItems - values to be set

    • setLineItems

      void setLineItems(List<LineItem> lineItems)

      Line Items that are part of the Order.

      Parameters:
      lineItems - values to be set

    • setCustomLineItems

      void setCustomLineItems(CustomLineItem... customLineItems)

      Custom Line Items that are part of the Order.

      Parameters:
      customLineItems - values to be set

    • setCustomLineItems

      void setCustomLineItems(List<CustomLineItem> customLineItems)

      Custom Line Items that are part of the Order.

      Parameters:
      customLineItems - values to be set

    • setTotalPrice

      void setTotalPrice(CentPrecisionMoney totalPrice)

      Sum of the totalPrice field of all LineItems and CustomLineItems, and if available, the price field of ShippingInfo. If a discount applies on totalPrice, this field holds the discounted value.

      Taxes are included if TaxRate includedInPrice is true for each price.

      Parameters:
      totalPrice - value to be set

    • setTaxedPrice

      void setTaxedPrice(TaxedPrice taxedPrice)
      • For Platform TaxMode, it is automatically set when a shipping address is set.
      • For External TaxMode, it is automatically set when shippingAddress and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.

      If a discount applies on totalPrice, this field holds the proportionally discounted value.

      Parameters:
      taxedPrice - value to be set

    • setTaxedShippingPrice

      void setTaxedShippingPrice(TaxedPrice taxedShippingPrice)

      Sum of the taxedPrice field of ShippingInfo across all Shipping Methods.

      If a discount applies on totalPrice, this field holds the proportionally discounted value.

      Parameters:
      taxedShippingPrice - value to be set

    • setDiscountOnTotalPrice

      void setDiscountOnTotalPrice(DiscountOnTotalPrice discountOnTotalPrice)

      Discounts that apply on the total price of the Order.

      Parameters:
      discountOnTotalPrice - value to be set

    • setPriceRoundingMode

      void setPriceRoundingMode(RoundingMode priceRoundingMode)

      Indicates how the total prices on LineItems and CustomLineItems are rounded when calculated.

      Parameters:
      priceRoundingMode - value to be set

    • setTaxMode

      void setTaxMode(TaxMode taxMode)

      Indicates how Tax Rates are set.

      Parameters:
      taxMode - value to be set

    • setTaxRoundingMode

      void setTaxRoundingMode(RoundingMode taxRoundingMode)

      Indicates how monetary values are rounded when calculating taxes for taxedPrice.

      Parameters:
      taxRoundingMode - value to be set

    • setTaxCalculationMode

      void setTaxCalculationMode(TaxCalculationMode taxCalculationMode)

      Indicates how taxes are calculated when calculating taxes for taxedPrice.

      Parameters:
      taxCalculationMode - value to be set

    • setInventoryMode

      void setInventoryMode(InventoryMode inventoryMode)

      Indicates how stock quantities are tracked for Line Items in the Order.

      Parameters:
      inventoryMode - value to be set

    • setBillingAddress

      void setBillingAddress(Address billingAddress)

      Billing address associated with the Order.

      Parameters:
      billingAddress - value to be set

    • setShippingAddress

      void setShippingAddress(Address shippingAddress)

      Shipping address associated with the Order. Determines eligible ShippingMethod rates and Tax Rates of Line Items.

      Parameters:
      shippingAddress - value to be set

    • setShippingMode

      void setShippingMode(ShippingMode shippingMode)

      Indicates whether there can be one or multiple Shipping Methods.

      Parameters:
      shippingMode - value to be set

    • setShippingKey

      void setShippingKey(String shippingKey)

      key of the ShippingMethod for Single ShippingMode.

      Parameters:
      shippingKey - value to be set

    • setShippingInfo

      void setShippingInfo(ShippingInfo shippingInfo)

      Shipping-related information for Single ShippingMode. Automatically set when a Shipping Method is set.

      Parameters:
      shippingInfo - value to be set

    • setShippingRateInput

      void setShippingRateInput(ShippingRateInput shippingRateInput)

      Input used to select a ShippingRatePriceTier. The data type of this field depends on the shippingRateInputType.type configured in the Project:

      Parameters:
      shippingRateInput - value to be set

    • setShippingCustomFields

      void setShippingCustomFields(CustomFields shippingCustomFields)

      Custom Fields of the Shipping Method for Single ShippingMode.

      Parameters:
      shippingCustomFields - value to be set

    • setShipping

      void setShipping(Shipping... shipping)

      Shipping-related information for Multiple ShippingMode. Updated automatically each time a new Shipping Method is added.

      Parameters:
      shipping - values to be set

    • setShipping

      void setShipping(List<Shipping> shipping)

      Shipping-related information for Multiple ShippingMode. Updated automatically each time a new Shipping Method is added.

      Parameters:
      shipping - values to be set

    • setItemShippingAddresses

      void setItemShippingAddresses(Address... itemShippingAddresses)

      Additional shipping addresses of the Order as specified by LineItems using the shippingDetails field. Eligible Shipping Methods or applicable Tax Rates are determined by the address in shippingAddress, and not itemShippingAddresses.

      Parameters:
      itemShippingAddresses - values to be set

    • setItemShippingAddresses

      void setItemShippingAddresses(List<Address> itemShippingAddresses)

      Additional shipping addresses of the Order as specified by LineItems using the shippingDetails field. Eligible Shipping Methods or applicable Tax Rates are determined by the address in shippingAddress, and not itemShippingAddresses.

      Parameters:
      itemShippingAddresses - values to be set

    • setDiscountCodes

      void setDiscountCodes(DiscountCodeInfo... discountCodes)

      Discount Codes added to the Order. An Order that has directDiscounts cannot have discountCodes.

      Parameters:
      discountCodes - values to be set

    • setDiscountCodes

      void setDiscountCodes(List<DiscountCodeInfo> discountCodes)

      Discount Codes added to the Order. An Order that has directDiscounts cannot have discountCodes.

      Parameters:
      discountCodes - values to be set

    • setDirectDiscounts

      void setDirectDiscounts(DirectDiscount... directDiscounts)

      Direct Discounts added to the Order. An Order that has discountCodes cannot have directDiscounts.

      Parameters:
      directDiscounts - values to be set

    • setDirectDiscounts

      void setDirectDiscounts(List<DirectDiscount> directDiscounts)

      Direct Discounts added to the Order. An Order that has discountCodes cannot have directDiscounts.

      Parameters:
      directDiscounts - values to be set

    • setRefusedGifts

      void setRefusedGifts(CartDiscountReference... refusedGifts)

      Automatically set when a Line Item with GiftLineItem LineItemMode is removed from the Order.

      Parameters:
      refusedGifts - values to be set

    • setRefusedGifts

      void setRefusedGifts(List<CartDiscountReference> refusedGifts)

      Automatically set when a Line Item with GiftLineItem LineItemMode is removed from the Order.

      Parameters:
      refusedGifts - values to be set

    • setPaymentInfo

      void setPaymentInfo(PaymentInfo paymentInfo)

      Payment information related to the Order.

      Parameters:
      paymentInfo - value to be set

    • setCountry

      void setCountry(String country)

      Used for Line Item price selection.

      Parameters:
      country - value to be set

    • setLocale

      void setLocale(String locale)

      Languages of the Order. Can only contain languages supported by the Project.

      Parameters:
      locale - value to be set

    • setOrigin

      void setOrigin(CartOrigin origin)

      Indicates the origin of the Cart from which the Order was created.

      Parameters:
      origin - value to be set

    • setCart

      void setCart(CartReference cart)

      Reference to the Cart for an Order created from Cart. The referenced Cart will have the Ordered CartState.

      Parameters:
      cart - value to be set

    • setQuote

      void setQuote(QuoteReference quote)

      Reference to the Quote for an Order created from Quote.

      Parameters:
      quote - value to be set

    • setRecurringOrder

      void setRecurringOrder(RecurringOrderReference recurringOrder)

      Reference to the RecurringOrder that generated this Order.

      Parameters:
      recurringOrder - value to be set

    • setOrderState

      void setOrderState(OrderState orderState)

      Current status of the Order.

      Parameters:
      orderState - value to be set

    • setShipmentState

      void setShipmentState(ShipmentState shipmentState)

      Shipment status of the Order.

      Parameters:
      shipmentState - value to be set

    • setPaymentState

      void setPaymentState(PaymentState paymentState)

      Payment status of the Order.

      Parameters:
      paymentState - value to be set

    • setState

      void setState(StateReference state)

      State of the Order. This reference can point to a State in a custom workflow.

      Parameters:
      state - value to be set

    • setSyncInfo

      void setSyncInfo(SyncInfo... syncInfo)

      Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.

      Parameters:
      syncInfo - values to be set

    • setSyncInfo

      void setSyncInfo(List<SyncInfo> syncInfo)

      Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.

      Parameters:
      syncInfo - values to be set

    • setReturnInfo

      void setReturnInfo(ReturnInfo... returnInfo)

      Contains information regarding the returns associated with the Order.

      Parameters:
      returnInfo - values to be set

    • setReturnInfo

      void setReturnInfo(List<ReturnInfo> returnInfo)

      Contains information regarding the returns associated with the Order.

      Parameters:
      returnInfo - values to be set

    • setDiscountTypeCombination

      void setDiscountTypeCombination(DiscountTypeCombination discountTypeCombination)

      Indicates if a combination of discount types can apply on an Order.

      Parameters:
      discountTypeCombination - value to be set

    • setLastMessageSequenceNumber

      @Deprecated void setLastMessageSequenceNumber(Long lastMessageSequenceNumber)
      Deprecated.

      Internal-only field.

      Parameters:
      lastMessageSequenceNumber - value to be set

    • setCustom

      void setCustom(CustomFields custom)

      Custom Fields of the Order.

      Specified by:
      setCustom in interface Customizable<Order>
      Parameters:
      custom - value to be set

    • setCompletedAt

      void setCompletedAt(ZonedDateTime completedAt)

      User-defined date and time (UTC) of the Order. Present only on an Order created using Order Import.

      Parameters:
      completedAt - value to be set

    • setCreatedAt

      void setCreatedAt(ZonedDateTime createdAt)

      Date and time (UTC) the Order was initially created.

      Specified by:
      setCreatedAt in interface BaseResource
      Parameters:
      createdAt - value to be set

    • setLastModifiedAt

      void setLastModifiedAt(ZonedDateTime lastModifiedAt)

      Date and time (UTC) the Order was last updated.

      Specified by:
      setLastModifiedAt in interface BaseResource
      Parameters:
      lastModifiedAt - value to be set

    • setLastModifiedBy

      void setLastModifiedBy(LastModifiedBy lastModifiedBy)

      IDs and references that last modified the Order.

      Parameters:
      lastModifiedBy - value to be set

    • setCreatedBy

      void setCreatedBy(CreatedBy createdBy)

      IDs and references that created the Order.

      Parameters:
      createdBy - value to be set

    • of

      static Order of()
      factory method
      Returns:
      instance of Order

    • of

      static Order of(Order template)
      factory method to create a shallow copy Order
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      Order copyDeep()
      Specified by:
      copyDeep in interface BaseResource

    • deepCopy

      @Nullable static Order deepCopy(@Nullable Order template)
      factory method to create a deep copy of Order
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static OrderBuilder builder()
      builder factory method for Order
      Returns:
      builder

    • builder

      static OrderBuilder builder(Order template)
      create builder for Order instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withOrder

      default <T> T withOrder(Function<Order,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • referenceTypeId

      static ReferenceTypeId referenceTypeId()

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<Order> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference