Inheritance diagram for OrderInterface:

Public Member Functions
	getAdjustmentNegative ()

	getAdjustmentPositive ()

	getAppliedRuleIds ()

	getBaseAdjustmentNegative ()

	getBaseAdjustmentPositive ()

	getBaseCurrencyCode ()

	getBaseDiscountAmount ()

	getBaseDiscountCanceled ()

	getBaseDiscountInvoiced ()

	getBaseDiscountRefunded ()

	getBaseGrandTotal ()

	getBaseDiscountTaxCompensationAmount ()

	getBaseDiscountTaxCompensationInvoiced ()

	getBaseDiscountTaxCompensationRefunded ()

	getBaseShippingAmount ()

	getBaseShippingCanceled ()

	getBaseShippingDiscountAmount ()

	getBaseShippingDiscountTaxCompensationAmnt ()

	getBaseShippingInclTax ()

	getBaseShippingInvoiced ()

	getBaseShippingRefunded ()

	getBaseShippingTaxAmount ()

	getBaseShippingTaxRefunded ()

	getBaseSubtotal ()

	getBaseSubtotalCanceled ()

	getBaseSubtotalInclTax ()

	getBaseSubtotalInvoiced ()

	getBaseSubtotalRefunded ()

	getBaseTaxAmount ()

	getBaseTaxCanceled ()

	getBaseTaxInvoiced ()

	getBaseTaxRefunded ()

	getBaseTotalCanceled ()

	getBaseTotalDue ()

	getBaseTotalInvoiced ()

	getBaseTotalInvoicedCost ()

	getBaseTotalOfflineRefunded ()

	getBaseTotalOnlineRefunded ()

	getBaseTotalPaid ()

	getBaseTotalQtyOrdered ()

	getBaseTotalRefunded ()

	getBaseToGlobalRate ()

	getBaseToOrderRate ()

	getBillingAddressId ()

	getCanShipPartially ()

	getCanShipPartiallyItem ()

	getCouponCode ()

	getCreatedAt ()

	setCreatedAt ($createdAt)

	getCustomerDob ()

	getCustomerEmail ()

	getCustomerFirstname ()

	getCustomerGender ()

	getCustomerGroupId ()

	getCustomerId ()

	getCustomerIsGuest ()

	getCustomerLastname ()

	getCustomerMiddlename ()

	getCustomerNote ()

	getCustomerNoteNotify ()

	getCustomerPrefix ()

	getCustomerSuffix ()

	getCustomerTaxvat ()

	getDiscountAmount ()

	getDiscountCanceled ()

	getDiscountDescription ()

	getDiscountInvoiced ()

	getDiscountRefunded ()

	getEditIncrement ()

	getEmailSent ()

	getEntityId ()

	setEntityId ($entityId)

	getExtCustomerId ()

	getExtOrderId ()

	getForcedShipmentWithInvoice ()

	getGlobalCurrencyCode ()

	getGrandTotal ()

	getDiscountTaxCompensationAmount ()

	getDiscountTaxCompensationInvoiced ()

	getDiscountTaxCompensationRefunded ()

	getHoldBeforeState ()

	getHoldBeforeStatus ()

	getIncrementId ()

	getIsVirtual ()

	getOrderCurrencyCode ()

	getOriginalIncrementId ()

	getPaymentAuthorizationAmount ()

	getPaymentAuthExpiration ()

	getProtectCode ()

	getQuoteAddressId ()

	getQuoteId ()

	getRelationChildId ()

	getRelationChildRealId ()

	getRelationParentId ()

	getRelationParentRealId ()

	getRemoteIp ()

	getShippingAmount ()

	getShippingCanceled ()

	getShippingDescription ()

	getShippingDiscountAmount ()

	getShippingDiscountTaxCompensationAmount ()

	getShippingInclTax ()

	getShippingInvoiced ()

	getShippingRefunded ()

	getShippingTaxAmount ()

	getShippingTaxRefunded ()

	getState ()

	getStatus ()

	getStoreCurrencyCode ()

	getStoreId ()

	getStoreName ()

	getStoreToBaseRate ()

	getStoreToOrderRate ()

	getSubtotal ()

	getSubtotalCanceled ()

	getSubtotalInclTax ()

	getSubtotalInvoiced ()

	getSubtotalRefunded ()

	getTaxAmount ()

	getTaxCanceled ()

	getTaxInvoiced ()

	getTaxRefunded ()

	getTotalCanceled ()

	getTotalDue ()

	getTotalInvoiced ()

	getTotalItemCount ()

	getTotalOfflineRefunded ()

	getTotalOnlineRefunded ()

	getTotalPaid ()

	getTotalQtyOrdered ()

	getTotalRefunded ()

	getUpdatedAt ()

	getWeight ()

	getXForwardedFor ()

	getItems ()

	setItems ($items)

	getBillingAddress ()

	setBillingAddress (\Magento\Sales\Api\Data\OrderAddressInterface $billingAddress=null)

	getPayment ()

	setPayment (\Magento\Sales\Api\Data\OrderPaymentInterface $payment=null)

	getStatusHistories ()

	setStatusHistories (array $statusHistories=null)

	setState ($state)

	setStatus ($status)

	setCouponCode ($code)

	setProtectCode ($code)

	setShippingDescription ($description)

	setIsVirtual ($isVirtual)

	setStoreId ($id)

	setCustomerId ($id)

	setBaseDiscountAmount ($amount)

	setBaseDiscountCanceled ($baseDiscountCanceled)

	setBaseDiscountInvoiced ($baseDiscountInvoiced)

	setBaseDiscountRefunded ($baseDiscountRefunded)

	setBaseGrandTotal ($amount)

	setBaseShippingAmount ($amount)

	setBaseShippingCanceled ($baseShippingCanceled)

	setBaseShippingInvoiced ($baseShippingInvoiced)

	setBaseShippingRefunded ($baseShippingRefunded)

	setBaseShippingTaxAmount ($amount)

	setBaseShippingTaxRefunded ($baseShippingTaxRefunded)

	setBaseSubtotal ($amount)

	setBaseSubtotalCanceled ($baseSubtotalCanceled)

	setBaseSubtotalInvoiced ($baseSubtotalInvoiced)

	setBaseSubtotalRefunded ($baseSubtotalRefunded)

	setBaseTaxAmount ($amount)

	setBaseTaxCanceled ($baseTaxCanceled)

	setBaseTaxInvoiced ($baseTaxInvoiced)

	setBaseTaxRefunded ($baseTaxRefunded)

	setBaseToGlobalRate ($rate)

	setBaseToOrderRate ($rate)

	setBaseTotalCanceled ($baseTotalCanceled)

	setBaseTotalInvoiced ($baseTotalInvoiced)

	setBaseTotalInvoicedCost ($baseTotalInvoicedCost)

	setBaseTotalOfflineRefunded ($baseTotalOfflineRefunded)

	setBaseTotalOnlineRefunded ($baseTotalOnlineRefunded)

	setBaseTotalPaid ($baseTotalPaid)

	setBaseTotalQtyOrdered ($baseTotalQtyOrdered)

	setBaseTotalRefunded ($baseTotalRefunded)

	setDiscountAmount ($amount)

	setDiscountCanceled ($discountCanceled)

	setDiscountInvoiced ($discountInvoiced)

	setDiscountRefunded ($discountRefunded)

	setGrandTotal ($amount)

	setShippingAmount ($amount)

	setShippingCanceled ($shippingCanceled)

	setShippingInvoiced ($shippingInvoiced)

	setShippingRefunded ($shippingRefunded)

	setShippingTaxAmount ($amount)

	setShippingTaxRefunded ($shippingTaxRefunded)

	setStoreToBaseRate ($rate)

	setStoreToOrderRate ($rate)

	setSubtotal ($amount)

	setSubtotalCanceled ($subtotalCanceled)

	setSubtotalInvoiced ($subtotalInvoiced)

	setSubtotalRefunded ($subtotalRefunded)

	setTaxAmount ($amount)

	setTaxCanceled ($taxCanceled)

	setTaxInvoiced ($taxInvoiced)

	setTaxRefunded ($taxRefunded)

	setTotalCanceled ($totalCanceled)

	setTotalInvoiced ($totalInvoiced)

	setTotalOfflineRefunded ($totalOfflineRefunded)

	setTotalOnlineRefunded ($totalOnlineRefunded)

	setTotalPaid ($totalPaid)

	setTotalQtyOrdered ($totalQtyOrdered)

	setTotalRefunded ($totalRefunded)

	setCanShipPartially ($flag)

	setCanShipPartiallyItem ($flag)

	setCustomerIsGuest ($customerIsGuest)

	setCustomerNoteNotify ($customerNoteNotify)

	setBillingAddressId ($id)

	setCustomerGroupId ($id)

	setEditIncrement ($editIncrement)

	setEmailSent ($emailSent)

	setForcedShipmentWithInvoice ($forcedShipmentWithInvoice)

	setPaymentAuthExpiration ($paymentAuthExpiration)

	setQuoteAddressId ($id)

	setQuoteId ($id)

	setAdjustmentNegative ($adjustmentNegative)

	setAdjustmentPositive ($adjustmentPositive)

	setBaseAdjustmentNegative ($baseAdjustmentNegative)

	setBaseAdjustmentPositive ($baseAdjustmentPositive)

	setBaseShippingDiscountAmount ($amount)

	setBaseSubtotalInclTax ($amount)

	setBaseTotalDue ($baseTotalDue)

	setPaymentAuthorizationAmount ($amount)

	setShippingDiscountAmount ($amount)

	setSubtotalInclTax ($amount)

	setTotalDue ($totalDue)

	setWeight ($weight)

	setCustomerDob ($customerDob)

	setIncrementId ($id)

	setAppliedRuleIds ($appliedRuleIds)

	setBaseCurrencyCode ($code)

	setCustomerEmail ($customerEmail)

	setCustomerFirstname ($customerFirstname)

	setCustomerLastname ($customerLastname)

	setCustomerMiddlename ($customerMiddlename)

	setCustomerPrefix ($customerPrefix)

	setCustomerSuffix ($customerSuffix)

	setCustomerTaxvat ($customerTaxvat)

	setDiscountDescription ($description)

	setExtCustomerId ($id)

	setExtOrderId ($id)

	setGlobalCurrencyCode ($code)

	setHoldBeforeState ($holdBeforeState)

	setHoldBeforeStatus ($holdBeforeStatus)

	setOrderCurrencyCode ($code)

	setOriginalIncrementId ($id)

	setRelationChildId ($id)

	setRelationChildRealId ($realId)

	setRelationParentId ($id)

	setRelationParentRealId ($realId)

	setRemoteIp ($remoteIp)

	setStoreCurrencyCode ($code)

	setStoreName ($storeName)

	setXForwardedFor ($xForwardedFor)

	setCustomerNote ($customerNote)

	setUpdatedAt ($timestamp)

	setTotalItemCount ($totalItemCount)

	setCustomerGender ($customerGender)

	setDiscountTaxCompensationAmount ($amount)

	setBaseDiscountTaxCompensationAmount ($amount)

	setShippingDiscountTaxCompensationAmount ($amount)

	setBaseShippingDiscountTaxCompensationAmnt ($amnt)

	setDiscountTaxCompensationInvoiced ($discountTaxCompensationInvoiced)

	setBaseDiscountTaxCompensationInvoiced ($baseDiscountTaxCompensationInvoiced)

	setDiscountTaxCompensationRefunded ($discountTaxCompensationRefunded)

	setBaseDiscountTaxCompensationRefunded ($baseDiscountTaxCompensationRefunded)

	setShippingInclTax ($amount)

	setBaseShippingInclTax ($amount)

	getExtensionAttributes ()

	setExtensionAttributes (\Magento\Sales\Api\Data\OrderExtensionInterface $extensionAttributes)

Data Fields
const	ENTITY_ID = 'entity_id'

const	STATE = 'state'

const	STATUS = 'status'

const	COUPON_CODE = 'coupon_code'

const	PROTECT_CODE = 'protect_code'

const	SHIPPING_DESCRIPTION = 'shipping_description'

const	IS_VIRTUAL = 'is_virtual'

const	STORE_ID = 'store_id'

const	CUSTOMER_ID = 'customer_id'

const	BASE_DISCOUNT_AMOUNT = 'base_discount_amount'

const	BASE_DISCOUNT_CANCELED = 'base_discount_canceled'

const	BASE_DISCOUNT_INVOICED = 'base_discount_invoiced'

const	BASE_DISCOUNT_REFUNDED = 'base_discount_refunded'

const	BASE_GRAND_TOTAL = 'base_grand_total'

const	BASE_SHIPPING_AMOUNT = 'base_shipping_amount'

const	BASE_SHIPPING_CANCELED = 'base_shipping_canceled'

const	BASE_SHIPPING_INVOICED = 'base_shipping_invoiced'

const	BASE_SHIPPING_REFUNDED = 'base_shipping_refunded'

const	BASE_SHIPPING_TAX_AMOUNT = 'base_shipping_tax_amount'

const	BASE_SHIPPING_TAX_REFUNDED = 'base_shipping_tax_refunded'

const	BASE_SUBTOTAL = 'base_subtotal'

const	BASE_SUBTOTAL_CANCELED = 'base_subtotal_canceled'

const	BASE_SUBTOTAL_INVOICED = 'base_subtotal_invoiced'

const	BASE_SUBTOTAL_REFUNDED = 'base_subtotal_refunded'

const	BASE_TAX_AMOUNT = 'base_tax_amount'

const	BASE_TAX_CANCELED = 'base_tax_canceled'

const	BASE_TAX_INVOICED = 'base_tax_invoiced'

const	BASE_TAX_REFUNDED = 'base_tax_refunded'

const	BASE_TO_GLOBAL_RATE = 'base_to_global_rate'

const	BASE_TO_ORDER_RATE = 'base_to_order_rate'

const	BASE_TOTAL_CANCELED = 'base_total_canceled'

const	BASE_TOTAL_INVOICED = 'base_total_invoiced'

const	BASE_TOTAL_INVOICED_COST = 'base_total_invoiced_cost'

const	BASE_TOTAL_OFFLINE_REFUNDED = 'base_total_offline_refunded'

const	BASE_TOTAL_ONLINE_REFUNDED = 'base_total_online_refunded'

const	BASE_TOTAL_PAID = 'base_total_paid'

const	BASE_TOTAL_QTY_ORDERED = 'base_total_qty_ordered'

const	BASE_TOTAL_REFUNDED = 'base_total_refunded'

const	DISCOUNT_AMOUNT = 'discount_amount'

const	DISCOUNT_CANCELED = 'discount_canceled'

const	DISCOUNT_INVOICED = 'discount_invoiced'

const	DISCOUNT_REFUNDED = 'discount_refunded'

const	GRAND_TOTAL = 'grand_total'

const	SHIPPING_AMOUNT = 'shipping_amount'

const	SHIPPING_CANCELED = 'shipping_canceled'

const	SHIPPING_INVOICED = 'shipping_invoiced'

const	SHIPPING_REFUNDED = 'shipping_refunded'

const	SHIPPING_TAX_AMOUNT = 'shipping_tax_amount'

const	SHIPPING_TAX_REFUNDED = 'shipping_tax_refunded'

const	STORE_TO_BASE_RATE = 'store_to_base_rate'

const	STORE_TO_ORDER_RATE = 'store_to_order_rate'

const	SUBTOTAL = 'subtotal'

const	SUBTOTAL_CANCELED = 'subtotal_canceled'

const	SUBTOTAL_INVOICED = 'subtotal_invoiced'

const	SUBTOTAL_REFUNDED = 'subtotal_refunded'

const	TAX_AMOUNT = 'tax_amount'

const	TAX_CANCELED = 'tax_canceled'

const	TAX_INVOICED = 'tax_invoiced'

const	TAX_REFUNDED = 'tax_refunded'

const	TOTAL_CANCELED = 'total_canceled'

const	TOTAL_INVOICED = 'total_invoiced'

const	TOTAL_OFFLINE_REFUNDED = 'total_offline_refunded'

const	TOTAL_ONLINE_REFUNDED = 'total_online_refunded'

const	TOTAL_PAID = 'total_paid'

const	TOTAL_QTY_ORDERED = 'total_qty_ordered'

const	TOTAL_REFUNDED = 'total_refunded'

const	CAN_SHIP_PARTIALLY = 'can_ship_partially'

const	CAN_SHIP_PARTIALLY_ITEM = 'can_ship_partially_item'

const	CUSTOMER_IS_GUEST = 'customer_is_guest'

const	CUSTOMER_NOTE_NOTIFY = 'customer_note_notify'

const	BILLING_ADDRESS_ID = 'billing_address_id'

const	CUSTOMER_GROUP_ID = 'customer_group_id'

const	EDIT_INCREMENT = 'edit_increment'

const	EMAIL_SENT = 'email_sent'

const	FORCED_SHIPMENT_WITH_INVOICE = 'forced_shipment_with_invoice'

const	PAYMENT_AUTH_EXPIRATION = 'payment_auth_expiration'

const	QUOTE_ADDRESS_ID = 'quote_address_id'

const	QUOTE_ID = 'quote_id'

const	ADJUSTMENT_NEGATIVE = 'adjustment_negative'

const	ADJUSTMENT_POSITIVE = 'adjustment_positive'

const	BASE_ADJUSTMENT_NEGATIVE = 'base_adjustment_negative'

const	BASE_ADJUSTMENT_POSITIVE = 'base_adjustment_positive'

const	BASE_SHIPPING_DISCOUNT_AMOUNT = 'base_shipping_discount_amount'

const	BASE_SUBTOTAL_INCL_TAX = 'base_subtotal_incl_tax'

const	BASE_TOTAL_DUE = 'base_total_due'

const	PAYMENT_AUTHORIZATION_AMOUNT = 'payment_authorization_amount'

const	SHIPPING_DISCOUNT_AMOUNT = 'shipping_discount_amount'

const	SUBTOTAL_INCL_TAX = 'subtotal_incl_tax'

const	TOTAL_DUE = 'total_due'

const	WEIGHT = 'weight'

const	CUSTOMER_DOB = 'customer_dob'

const	INCREMENT_ID = 'increment_id'

const	APPLIED_RULE_IDS = 'applied_rule_ids'

const	BASE_CURRENCY_CODE = 'base_currency_code'

const	CUSTOMER_EMAIL = 'customer_email'

const	CUSTOMER_FIRSTNAME = 'customer_firstname'

const	CUSTOMER_LASTNAME = 'customer_lastname'

const	CUSTOMER_MIDDLENAME = 'customer_middlename'

const	CUSTOMER_PREFIX = 'customer_prefix'

const	CUSTOMER_SUFFIX = 'customer_suffix'

const	CUSTOMER_TAXVAT = 'customer_taxvat'

const	DISCOUNT_DESCRIPTION = 'discount_description'

const	EXT_CUSTOMER_ID = 'ext_customer_id'

const	EXT_ORDER_ID = 'ext_order_id'

const	GLOBAL_CURRENCY_CODE = 'global_currency_code'

const	HOLD_BEFORE_STATE = 'hold_before_state'

const	HOLD_BEFORE_STATUS = 'hold_before_status'

const	ORDER_CURRENCY_CODE = 'order_currency_code'

const	ORIGINAL_INCREMENT_ID = 'original_increment_id'

const	RELATION_CHILD_ID = 'relation_child_id'

const	RELATION_CHILD_REAL_ID = 'relation_child_real_id'

const	RELATION_PARENT_ID = 'relation_parent_id'

const	RELATION_PARENT_REAL_ID = 'relation_parent_real_id'

const	REMOTE_IP = 'remote_ip'

const	STORE_CURRENCY_CODE = 'store_currency_code'

const	STORE_NAME = 'store_name'

const	X_FORWARDED_FOR = 'x_forwarded_for'

const	CUSTOMER_NOTE = 'customer_note'

const	CREATED_AT = 'created_at'

const	UPDATED_AT = 'updated_at'

const	TOTAL_ITEM_COUNT = 'total_item_count'

const	CUSTOMER_GENDER = 'customer_gender'

const	DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount'

const	BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount'

const	SHIPPING_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'shipping_discount_tax_compensation_amount'

const	BASE_SHIPPING_DISCOUNT_TAX_COMPENSATION_AMNT = 'base_shipping_discount_tax_compensation_amnt'

const	DISCOUNT_TAX_COMPENSATION_INVOICED = 'discount_tax_compensation_invoiced'

const	BASE_DISCOUNT_TAX_COMPENSATION_INVOICED = 'base_discount_tax_compensation_invoiced'

const	DISCOUNT_TAX_COMPENSATION_REFUNDED = 'discount_tax_compensation_refunded'

const	BASE_DISCOUNT_TAX_COMPENSATION_REFUNDED = 'base_discount_tax_compensation_refunded'

const	SHIPPING_INCL_TAX = 'shipping_incl_tax'

const	BASE_SHIPPING_INCL_TAX = 'base_shipping_incl_tax'

const	ITEMS = 'items'

const	BILLING_ADDRESS = 'billing_address'

const	PAYMENT = 'payment'

const	STATUS_HISTORIES = 'status_histories'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Detailed Description

Order interface.

An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer. @api

Since: 100.0.2

Definition at line 17 of file OrderInterface.php.

Member Function Documentation

◆ getAdjustmentNegative()

getAdjustmentNegative ( )

Gets the negative adjustment value for the order.

Returns: float|null Negative adjustment value.

Implemented in Order.

◆ getAdjustmentPositive()

getAdjustmentPositive ( )

Gets the positive adjustment value for the order.

Returns: float|null Positive adjustment value.

Implemented in Order.

◆ getAppliedRuleIds()

getAppliedRuleIds ( )

Gets the applied rule IDs for the order.

Returns: string|null Applied rule IDs.

Implemented in Order.

◆ getBaseAdjustmentNegative()

getBaseAdjustmentNegative ( )

Gets the base negative adjustment value for the order.

Returns: float|null Base negative adjustment value.

Implemented in Order.

◆ getBaseAdjustmentPositive()

getBaseAdjustmentPositive ( )

Gets the base positive adjustment value for the order.

Returns: float|null Base positive adjustment value.

Implemented in Order.

◆ getBaseCurrencyCode()

getBaseCurrencyCode ( )

Gets the base currency code for the order.

Returns: string|null Base currency code.

Implemented in Order.

◆ getBaseDiscountAmount()

getBaseDiscountAmount ( )

Gets the base discount amount for the order.

Returns: float|null Base discount amount.

Implemented in Order.

◆ getBaseDiscountCanceled()

getBaseDiscountCanceled ( )

Gets the base discount canceled for the order.

Returns: float|null Base discount canceled.

Implemented in Order.

◆ getBaseDiscountInvoiced()

getBaseDiscountInvoiced ( )

Gets the base discount invoiced amount for the order.

Returns: float|null Base discount invoiced.

Implemented in Order.

◆ getBaseDiscountRefunded()

getBaseDiscountRefunded ( )

Gets the base discount refunded amount for the order.

Returns: float|null Base discount refunded.

Implemented in Order.

◆ getBaseDiscountTaxCompensationAmount()

getBaseDiscountTaxCompensationAmount ( )

Gets the base discount tax compensation amount for the order.

Returns: float|null Base discount tax compensation amount.

Implemented in Order.

◆ getBaseDiscountTaxCompensationInvoiced()

getBaseDiscountTaxCompensationInvoiced ( )

Gets the base discount tax compensation invoiced amount for the order.

Returns: float|null Base discount tax compensation invoiced.

Implemented in Order.

◆ getBaseDiscountTaxCompensationRefunded()

getBaseDiscountTaxCompensationRefunded ( )

Gets the base discount tax compensation refunded amount for the order.

Returns: float|null Base discount tax compensation refunded.

Implemented in Order.

◆ getBaseGrandTotal()

getBaseGrandTotal ( )

Gets the base grand total for the order.

Returns: float Base grand total.

Implemented in Order.

◆ getBaseShippingAmount()

getBaseShippingAmount ( )

Gets the base shipping amount for the order.

Returns: float|null Base shipping amount.

Implemented in Order.

◆ getBaseShippingCanceled()

getBaseShippingCanceled ( )

Gets the base shipping canceled for the order.

Returns: float|null Base shipping canceled.

Implemented in Order.

◆ getBaseShippingDiscountAmount()

getBaseShippingDiscountAmount ( )

Gets the base shipping discount amount for the order.

Returns: float|null Base shipping discount amount.

Implemented in Order.

◆ getBaseShippingDiscountTaxCompensationAmnt()

getBaseShippingDiscountTaxCompensationAmnt ( )

Gets the base shipping discount tax compensation amount for the order.

Returns: float|null Base shipping discount tax compensation amount.

Implemented in Order.

◆ getBaseShippingInclTax()

getBaseShippingInclTax ( )

Gets the base shipping including tax for the order.

Returns: float|null Base shipping including tax.

Implemented in Order.

◆ getBaseShippingInvoiced()

getBaseShippingInvoiced ( )

Gets the base shipping invoiced amount for the order.

Returns: float|null Base shipping invoiced.

Implemented in Order.

◆ getBaseShippingRefunded()

getBaseShippingRefunded ( )

Gets the base shipping refunded amount for the order.

Returns: float|null Base shipping refunded.

Implemented in Order.

◆ getBaseShippingTaxAmount()

getBaseShippingTaxAmount ( )

Gets the base shipping tax amount for the order.

Returns: float|null Base shipping tax amount.

Implemented in Order.

◆ getBaseShippingTaxRefunded()

getBaseShippingTaxRefunded ( )

Gets the base shipping tax refunded amount for the order.

Returns: float|null Base shipping tax refunded.

Implemented in Order.

◆ getBaseSubtotal()

getBaseSubtotal ( )

Gets the base subtotal for the order.

Returns: float|null Base subtotal.

Implemented in Order.

◆ getBaseSubtotalCanceled()

getBaseSubtotalCanceled ( )

Gets the base subtotal canceled for the order.

Returns: float|null Base subtotal canceled.

Implemented in Order.

◆ getBaseSubtotalInclTax()

getBaseSubtotalInclTax ( )

Gets the base subtotal including tax for the order.

Returns: float|null Base subtotal including tax.

Implemented in Order.

◆ getBaseSubtotalInvoiced()

getBaseSubtotalInvoiced ( )

Gets the base subtotal invoiced amount for the order.

Returns: float|null Base subtotal invoiced.

Implemented in Order.

◆ getBaseSubtotalRefunded()

getBaseSubtotalRefunded ( )

Gets the base subtotal refunded amount for the order.

Returns: float|null Base subtotal refunded.

Implemented in Order.

◆ getBaseTaxAmount()

getBaseTaxAmount ( )

Gets the base tax amount for the order.

Returns: float|null Base tax amount.

Implemented in Order.

◆ getBaseTaxCanceled()

getBaseTaxCanceled ( )

Gets the base tax canceled for the order.

Returns: float|null Base tax canceled.

Implemented in Order.

◆ getBaseTaxInvoiced()

getBaseTaxInvoiced ( )

Gets the base tax invoiced amount for the order.

Returns: float|null Base tax invoiced.

Implemented in Order.

◆ getBaseTaxRefunded()

getBaseTaxRefunded ( )

Gets the base tax refunded amount for the order.

Returns: float|null Base tax refunded.

Implemented in Order.

◆ getBaseToGlobalRate()

getBaseToGlobalRate ( )

Gets the base-to-global rate for the order.

Returns: float|null Base-to-global rate.

Implemented in Order.

◆ getBaseToOrderRate()

getBaseToOrderRate ( )

Gets the base-to-order rate for the order.

Returns: float|null Base-to-order rate.

Implemented in Order.

◆ getBaseTotalCanceled()

getBaseTotalCanceled ( )

Gets the base total canceled for the order.

Returns: float|null Base total canceled.

Implemented in Order.

◆ getBaseTotalDue()

getBaseTotalDue ( )

Gets the base total due for the order.

Returns: float|null Base total due.

Implemented in Order.

◆ getBaseTotalInvoiced()

getBaseTotalInvoiced ( )

Gets the base total invoiced amount for the order.

Returns: float|null Base total invoiced.

Implemented in Order.

◆ getBaseTotalInvoicedCost()

getBaseTotalInvoicedCost ( )

Gets the base total invoiced cost for the order.

Returns: float|null Base total invoiced cost.

Implemented in Order.

◆ getBaseTotalOfflineRefunded()

getBaseTotalOfflineRefunded ( )

Gets the base total offline refunded amount for the order.

Returns: float|null Base total offline refunded.

Implemented in Order.

◆ getBaseTotalOnlineRefunded()

getBaseTotalOnlineRefunded ( )

Gets the base total online refunded amount for the order.

Returns: float|null Base total online refunded.

Implemented in Order.

◆ getBaseTotalPaid()

getBaseTotalPaid ( )

Gets the base total paid for the order.

Returns: float|null Base total paid.

Implemented in Order.

◆ getBaseTotalQtyOrdered()

getBaseTotalQtyOrdered ( )

Gets the base total quantity ordered for the order.

Returns: float|null Base total quantity ordered.

Implemented in Order.

◆ getBaseTotalRefunded()

getBaseTotalRefunded ( )

Gets the base total refunded amount for the order.

Returns: float|null Base total refunded.

Implemented in Order.

◆ getBillingAddress()

getBillingAddress ( )

Gets the billing address, if any, for the order.

Returns: \Magento\Sales\Api\Data\OrderAddressInterface|null Billing address. Otherwise, null.

Implemented in Order.

◆ getBillingAddressId()

getBillingAddressId ( )

Gets the billing address ID for the order.

Returns: int|null Billing address ID.

Implemented in Order.

◆ getCanShipPartially()

getCanShipPartially ( )

Gets the can-ship-partially flag value for the order.

Returns: int|null Can-ship-partially flag value.

Implemented in Order.

◆ getCanShipPartiallyItem()

getCanShipPartiallyItem ( )

Gets the can-ship-partially-item flag value for the order.

Returns: int|null Can-ship-partially-item flag value.

Implemented in Order.

◆ getCouponCode()

getCouponCode ( )

Gets the coupon code for the order.

Returns: string|null Coupon code.

Implemented in Order.

◆ getCreatedAt()

getCreatedAt ( )

Gets the created-at timestamp for the order.

Returns: string|null Created-at timestamp.

Implemented in Order.

◆ getCustomerDob()

getCustomerDob ( )

Gets the customer date-of-birth (DOB) for the order.

Returns: string|null Customer date-of-birth (DOB).

Implemented in Order.

◆ getCustomerEmail()

getCustomerEmail ( )

Gets the customer email address for the order.

Returns: string Customer email address.

Implemented in Order.

◆ getCustomerFirstname()

getCustomerFirstname ( )

Gets the customer first name for the order.

Returns: string|null Customer first name.

Implemented in Order.

◆ getCustomerGender()

getCustomerGender ( )

Gets the customer gender for the order.

Returns: int|null Customer gender.

Implemented in Order.

◆ getCustomerGroupId()

getCustomerGroupId ( )

Gets the customer group ID for the order.

Returns: int|null Customer group ID.

Implemented in Order.

◆ getCustomerId()

getCustomerId ( )

Gets the customer ID for the order.

Returns: int|null Customer ID.

Implemented in Order.

◆ getCustomerIsGuest()

getCustomerIsGuest ( )

Gets the customer-is-guest flag value for the order.

Returns: int|null Customer-is-guest flag value.

Implemented in Order.

◆ getCustomerLastname()

getCustomerLastname ( )

Gets the customer last name for the order.

Returns: string|null Customer last name.

Implemented in Order.

◆ getCustomerMiddlename()

getCustomerMiddlename ( )

Gets the customer middle name for the order.

Returns: string|null Customer middle name.

Implemented in Order.

◆ getCustomerNote()

getCustomerNote ( )

Gets the customer note for the order.

Returns: string|null Customer note.

Implemented in Order.

◆ getCustomerNoteNotify()

getCustomerNoteNotify ( )

Gets the customer-note-notify flag value for the order.

Returns: int|null Customer-note-notify flag value.

Implemented in Order.

◆ getCustomerPrefix()

getCustomerPrefix ( )

Gets the customer prefix for the order.

Returns: string|null Customer prefix.

Implemented in Order.

◆ getCustomerSuffix()

getCustomerSuffix ( )

Gets the customer suffix for the order.

Returns: string|null Customer suffix.

Implemented in Order.

◆ getCustomerTaxvat()

getCustomerTaxvat ( )

Gets the customer value-added tax (VAT) for the order.

Returns: string|null Customer value-added tax (VAT).

Implemented in Order.

◆ getDiscountAmount()

getDiscountAmount ( )

Gets the discount amount for the order.

Returns: float|null Discount amount.

Implemented in Order.

◆ getDiscountCanceled()

getDiscountCanceled ( )

Gets the discount canceled for the order.

Returns: float|null Discount canceled.

Implemented in Order.

◆ getDiscountDescription()

getDiscountDescription ( )

Gets the discount description for the order.

Returns: string|null Discount description.

Implemented in Order.

◆ getDiscountInvoiced()

getDiscountInvoiced ( )

Gets the discount invoiced amount for the order.

Returns: float|null Discount invoiced.

Implemented in Order.

◆ getDiscountRefunded()

getDiscountRefunded ( )

Gets the discount refunded amount for the order.

Returns: float|null Discount refunded amount.

Implemented in Order.

◆ getDiscountTaxCompensationAmount()

getDiscountTaxCompensationAmount ( )

Gets the discount tax compensation amount for the order.

Returns: float|null Discount tax compensation amount.

Implemented in Order.

◆ getDiscountTaxCompensationInvoiced()

getDiscountTaxCompensationInvoiced ( )

Gets the discount tax compensation invoiced amount for the order.

Returns: float|null Discount tax compensation invoiced amount.

Implemented in Order.

◆ getDiscountTaxCompensationRefunded()

getDiscountTaxCompensationRefunded ( )

Gets the discount tax compensation refunded amount for the order.

Returns: float|null Discount tax compensation refunded amount.

Implemented in Order.

◆ getEditIncrement()

getEditIncrement ( )

Gets the edit increment value for the order.

Returns: int|null Edit increment value.

Implemented in Order.

◆ getEmailSent()

getEmailSent ( )

Gets the email-sent flag value for the order.

Returns: int|null Email-sent flag value.

Implemented in Order.

◆ getEntityId()

getEntityId ( )

Gets the ID for the order.

Returns: int|null Order ID.

◆ getExtCustomerId()

getExtCustomerId ( )

Gets the external customer ID for the order.

Returns: string|null External customer ID.

Implemented in Order.

◆ getExtensionAttributes()

getExtensionAttributes ( )

Retrieve existing extension attributes object or create a new one.

Returns: \Magento\Sales\Api\Data\OrderExtensionInterface|null

Implemented in Order.

◆ getExtOrderId()

getExtOrderId ( )

Gets the external order ID for the order.

Returns: string|null External order ID.

Implemented in Order.

◆ getForcedShipmentWithInvoice()

getForcedShipmentWithInvoice ( )

Gets the forced-shipment-with-invoice flag value for the order.

Returns: int|null Forced-shipment-with-invoice flag value.

Implemented in Order.

◆ getGlobalCurrencyCode()

getGlobalCurrencyCode ( )

Gets the global currency code for the order.

Returns: string|null Global currency code.

Implemented in Order.

◆ getGrandTotal()

getGrandTotal ( )

Gets the grand total for the order.

Returns: float Grand total.

Implemented in Order.

◆ getHoldBeforeState()

getHoldBeforeState ( )

Gets the hold before state for the order.

Returns: string|null Hold before state.

Implemented in Order.

◆ getHoldBeforeStatus()

getHoldBeforeStatus ( )

Gets the hold before status for the order.

Returns: string|null Hold before status.

Implemented in Order.

◆ getIncrementId()

getIncrementId ( )

Gets the increment ID for the order.

Returns: string|null Increment ID.

Implemented in Order.

◆ getIsVirtual()

getIsVirtual ( )

Gets the is-virtual flag value for the order.

Returns: int|null Is-virtual flag value.

Implemented in Order.

◆ getItems()

getItems ( )

Gets items for the order.

Returns: \Magento\Sales\Api\Data\OrderItemInterface[] Array of items.

Implemented in Order.

◆ getOrderCurrencyCode()

getOrderCurrencyCode ( )

Gets the order currency code for the order.

Returns: string|null Order currency code.

Implemented in Order.

◆ getOriginalIncrementId()

getOriginalIncrementId ( )

Gets the original increment ID for the order.

Returns: string|null Original increment ID.

Implemented in Order.

◆ getPayment()

getPayment ( )

Gets order payment

Returns: \Magento\Sales\Api\Data\OrderPaymentInterface|null

Implemented in Order.

◆ getPaymentAuthExpiration()

getPaymentAuthExpiration ( )

Gets the payment authorization expiration date for the order.

Returns: int|null Payment authorization expiration date.

Implemented in Order.

◆ getPaymentAuthorizationAmount()

getPaymentAuthorizationAmount ( )

Gets the payment authorization amount for the order.

Returns: float|null Payment authorization amount.

Implemented in Order.

◆ getProtectCode()

getProtectCode ( )

Gets the protect code for the order.

Returns: string|null Protect code.

Implemented in Order.

◆ getQuoteAddressId()

getQuoteAddressId ( )

Gets the quote address ID for the order.

Returns: int|null Quote address ID.

Implemented in Order.

◆ getQuoteId()

getQuoteId ( )

Gets the quote ID for the order.

Returns: int|null Quote ID.

Implemented in Order.

◆ getRelationChildId()

getRelationChildId ( )

Gets the relation child ID for the order.

Returns: string|null Relation child ID.

Implemented in Order.

◆ getRelationChildRealId()

getRelationChildRealId ( )

Gets the relation child real ID for the order.

Returns: string|null Relation child real ID.

Implemented in Order.

◆ getRelationParentId()

getRelationParentId ( )

Gets the relation parent ID for the order.

Returns: string|null Relation parent ID.

Implemented in Order.

◆ getRelationParentRealId()

getRelationParentRealId ( )

Gets the relation parent real ID for the order.

Returns: string|null Relation parent real ID.

Implemented in Order.

◆ getRemoteIp()

getRemoteIp ( )

Gets the remote IP address for the order.

Returns: string|null Remote IP address.

Implemented in Order.

◆ getShippingAmount()

getShippingAmount ( )

Gets the shipping amount for the order.

Returns: float|null Shipping amount.

Implemented in Order.

◆ getShippingCanceled()

getShippingCanceled ( )

Gets the shipping canceled amount for the order.

Returns: float|null Shipping canceled amount.

Implemented in Order.

◆ getShippingDescription()

getShippingDescription ( )

Gets the shipping description for the order.

Returns: string|null Shipping description.

Implemented in Order.

◆ getShippingDiscountAmount()

getShippingDiscountAmount ( )

Gets the shipping discount amount for the order.

Returns: float|null Shipping discount amount.

Implemented in Order.

◆ getShippingDiscountTaxCompensationAmount()

getShippingDiscountTaxCompensationAmount ( )

Gets the shipping discount tax compensation amount for the order.

Returns: float|null Shipping discount tax compensation amount.

Implemented in Order.

◆ getShippingInclTax()

getShippingInclTax ( )

Gets the shipping including tax amount for the order.

Returns: float|null Shipping including tax amount.

Implemented in Order.

◆ getShippingInvoiced()

getShippingInvoiced ( )

Gets the shipping invoiced amount for the order.

Returns: float|null Shipping invoiced amount.

Implemented in Order.

◆ getShippingRefunded()

getShippingRefunded ( )

Gets the shipping refunded amount for the order.

Returns: float|null Shipping refunded amount.

Implemented in Order.

◆ getShippingTaxAmount()

getShippingTaxAmount ( )

Gets the shipping tax amount for the order.

Returns: float|null Shipping tax amount.

Implemented in Order.

◆ getShippingTaxRefunded()

getShippingTaxRefunded ( )

Gets the shipping tax refunded amount for the order.

Returns: float|null Shipping tax refunded amount.

Implemented in Order.

◆ getState()

getState ( )

Gets the state for the order.

Returns: string|null State.

Implemented in Order.

◆ getStatus()

getStatus ( )

Gets the status for the order.

Returns: string|null Status.

Implemented in Order.

◆ getStatusHistories()

getStatusHistories ( )

Gets status histories for the order.

Returns: \Magento\Sales\Api\Data\OrderStatusHistoryInterface[]|null Array of status histories.

Implemented in Order.

◆ getStoreCurrencyCode()

getStoreCurrencyCode ( )

Gets the store currency code for the order.

Returns: string|null Store currency code.

Implemented in Order.

◆ getStoreId()

getStoreId ( )

Gets the store ID for the order.

Returns: int|null Store ID.

Implemented in Order.

◆ getStoreName()

getStoreName ( )

Gets the store name for the order.

Returns: string|null Store name.

Implemented in Order.

◆ getStoreToBaseRate()

getStoreToBaseRate ( )

Gets the store-to-base rate for the order.

Returns: float|null Store-to-base rate.

Implemented in Order.

◆ getStoreToOrderRate()

getStoreToOrderRate ( )

Gets the store-to-order rate for the order.

Returns: float|null Store-to-order rate.

Implemented in Order.

◆ getSubtotal()

getSubtotal ( )

Gets the subtotal for the order.

Returns: float|null Subtotal.

Implemented in Order.

◆ getSubtotalCanceled()

getSubtotalCanceled ( )

Gets the subtotal canceled amount for the order.

Returns: float|null Subtotal canceled amount.

Implemented in Order.

◆ getSubtotalInclTax()

getSubtotalInclTax ( )

Gets the subtotal including tax amount for the order.

Returns: float|null Subtotal including tax amount.

Implemented in Order.

◆ getSubtotalInvoiced()

getSubtotalInvoiced ( )

Gets the subtotal invoiced amount for the order.

Returns: float|null Subtotal invoiced amount.

Implemented in Order.

◆ getSubtotalRefunded()

getSubtotalRefunded ( )

Gets the subtotal refunded amount for the order.

Returns: float|null Subtotal refunded amount.

Implemented in Order.

◆ getTaxAmount()

getTaxAmount ( )

Gets the tax amount for the order.

Returns: float|null Tax amount.

Implemented in Order.

◆ getTaxCanceled()

getTaxCanceled ( )

Gets the tax canceled amount for the order.

Returns: float|null Tax canceled amount.

Implemented in Order.

◆ getTaxInvoiced()

getTaxInvoiced ( )

Gets the tax invoiced amount for the order.

Returns: float|null Tax invoiced amount.

Implemented in Order.

◆ getTaxRefunded()

getTaxRefunded ( )

Gets the tax refunded amount for the order.

Returns: float|null Tax refunded amount.

Implemented in Order.

◆ getTotalCanceled()

getTotalCanceled ( )

Gets the total canceled for the order.

Returns: float|null Total canceled.

Implemented in Order.

◆ getTotalDue()

getTotalDue ( )

Gets the total due for the order.

Returns: float|null Total due.

Implemented in Order.

◆ getTotalInvoiced()

getTotalInvoiced ( )

Gets the total invoiced amount for the order.

Returns: float|null Total invoiced amount.

Implemented in Order.

◆ getTotalItemCount()

getTotalItemCount ( )

Gets the total item count for the order.

Returns: int|null Total item count.

Implemented in Order.

◆ getTotalOfflineRefunded()

getTotalOfflineRefunded ( )

Gets the total offline refunded amount for the order.

Returns: float|null Total offline refunded amount.

Implemented in Order.

◆ getTotalOnlineRefunded()

getTotalOnlineRefunded ( )

Gets the total online refunded amount for the order.

Returns: float|null Total online refunded amount.

Implemented in Order.

◆ getTotalPaid()

getTotalPaid ( )

Gets the total paid for the order.

Returns: float|null Total paid.

Implemented in Order.

◆ getTotalQtyOrdered()

getTotalQtyOrdered ( )

Gets the total quantity ordered for the order.

Returns: float|null Total quantity ordered.

Implemented in Order.

◆ getTotalRefunded()

getTotalRefunded ( )

Gets the total amount refunded amount for the order.

Returns: float|null Total amount refunded.

Implemented in Order.

◆ getUpdatedAt()

getUpdatedAt ( )

Gets the updated-at timestamp for the order.

Returns: string|null Updated-at timestamp.

Implemented in Order.

◆ getWeight()

getWeight ( )

Gets the weight for the order.

Returns: float|null Weight.

Implemented in Order.

◆ getXForwardedFor()

getXForwardedFor ( )

Gets the X-Forwarded-For HTTP header field for the order.

This field identifies the originating IP address of a client connecting to a web server through an HTTP proxy or load balancer.

Returns: string|null X-Forwarded-For field value.

Implemented in Order.

◆ setAdjustmentNegative()

setAdjustmentNegative ( $adjustmentNegative )

Sets the negative adjustment value for the order.

Parameters

float $adjustmentNegative

Returns: $this

Implemented in Order.

◆ setAdjustmentPositive()

setAdjustmentPositive ( $adjustmentPositive )

Sets the positive adjustment value for the order.

Parameters

float $adjustmentPositive

Returns: $this

Implemented in Order.

◆ setAppliedRuleIds()

setAppliedRuleIds ( $appliedRuleIds )

Sets the applied rule IDs for the order.

Parameters

string $appliedRuleIds

Returns: $this

Implemented in Order.

◆ setBaseAdjustmentNegative()

setBaseAdjustmentNegative ( $baseAdjustmentNegative )

Sets the base negative adjustment value for the order.

Parameters

float $baseAdjustmentNegative

Returns: $this

Implemented in Order.

◆ setBaseAdjustmentPositive()

setBaseAdjustmentPositive ( $baseAdjustmentPositive )

Sets the base positive adjustment value for the order.

Parameters

float $baseAdjustmentPositive

Returns: $this

Implemented in Order.

◆ setBaseCurrencyCode()

setBaseCurrencyCode ( $code )

Sets the base currency code for the order.

Parameters

string $code

Returns: $this

Implemented in Order.

◆ setBaseDiscountAmount()

setBaseDiscountAmount ( $amount )

Sets the base discount amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setBaseDiscountCanceled()

setBaseDiscountCanceled ( $baseDiscountCanceled )

Sets the base discount canceled for the order.

Parameters

float $baseDiscountCanceled

Returns: $this

Implemented in Order.

◆ setBaseDiscountInvoiced()

setBaseDiscountInvoiced ( $baseDiscountInvoiced )

Sets the base discount invoiced amount for the order.

Parameters

float $baseDiscountInvoiced

Returns: $this

Implemented in Order.

◆ setBaseDiscountRefunded()

setBaseDiscountRefunded ( $baseDiscountRefunded )

Sets the base discount refunded amount for the order.

Parameters

float $baseDiscountRefunded

Returns: $this

Implemented in Order.

◆ setBaseDiscountTaxCompensationAmount()

setBaseDiscountTaxCompensationAmount ( $amount )

Sets the base discount tax compensation amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setBaseDiscountTaxCompensationInvoiced()

setBaseDiscountTaxCompensationInvoiced ( $baseDiscountTaxCompensationInvoiced )

Sets the base discount tax compensation invoiced amount for the order.

Parameters

float $baseDiscountTaxCompensationInvoiced

Returns: $this

Implemented in Order.

◆ setBaseDiscountTaxCompensationRefunded()

setBaseDiscountTaxCompensationRefunded ( $baseDiscountTaxCompensationRefunded )

Sets the base discount tax compensation refunded amount for the order.

Parameters

float $baseDiscountTaxCompensationRefunded

Returns: $this

Implemented in Order.

◆ setBaseGrandTotal()

setBaseGrandTotal ( $amount )

Sets the base grand total for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setBaseShippingAmount()

setBaseShippingAmount ( $amount )

Sets the base shipping amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setBaseShippingCanceled()

setBaseShippingCanceled ( $baseShippingCanceled )

Sets the base shipping canceled for the order.

Parameters

float $baseShippingCanceled

Returns: $this

Implemented in Order.

◆ setBaseShippingDiscountAmount()

setBaseShippingDiscountAmount ( $amount )

Sets the base shipping discount amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setBaseShippingDiscountTaxCompensationAmnt()

setBaseShippingDiscountTaxCompensationAmnt ( $amnt )

Sets the base shipping discount tax compensation amount for the order.

Parameters

float $amnt

Returns: $this

Implemented in Order.

◆ setBaseShippingInclTax()

setBaseShippingInclTax ( $amount )

Sets the base shipping including tax for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setBaseShippingInvoiced()

setBaseShippingInvoiced ( $baseShippingInvoiced )

Sets the base shipping invoiced amount for the order.

Parameters

float $baseShippingInvoiced

Returns: $this

Implemented in Order.

◆ setBaseShippingRefunded()

setBaseShippingRefunded ( $baseShippingRefunded )

Sets the base shipping refunded amount for the order.

Parameters

float $baseShippingRefunded

Returns: $this

Implemented in Order.

◆ setBaseShippingTaxAmount()

setBaseShippingTaxAmount ( $amount )

Sets the base shipping tax amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setBaseShippingTaxRefunded()

setBaseShippingTaxRefunded ( $baseShippingTaxRefunded )

Sets the base shipping tax refunded amount for the order.

Parameters

float $baseShippingTaxRefunded

Returns: $this

Implemented in Order.

◆ setBaseSubtotal()

setBaseSubtotal ( $amount )

Sets the base subtotal for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setBaseSubtotalCanceled()

setBaseSubtotalCanceled ( $baseSubtotalCanceled )

Sets the base subtotal canceled for the order.

Parameters

float $baseSubtotalCanceled

Returns: $this

Implemented in Order.

◆ setBaseSubtotalInclTax()

setBaseSubtotalInclTax ( $amount )

Sets the base subtotal including tax for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setBaseSubtotalInvoiced()

setBaseSubtotalInvoiced ( $baseSubtotalInvoiced )

Sets the base subtotal invoiced amount for the order.

Parameters

float $baseSubtotalInvoiced

Returns: $this

Implemented in Order.

◆ setBaseSubtotalRefunded()

setBaseSubtotalRefunded ( $baseSubtotalRefunded )

Sets the base subtotal refunded amount for the order.

Parameters

float $baseSubtotalRefunded

Returns: $this

Implemented in Order.

◆ setBaseTaxAmount()

setBaseTaxAmount ( $amount )

Sets the base tax amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setBaseTaxCanceled()

setBaseTaxCanceled ( $baseTaxCanceled )

Sets the base tax canceled for the order.

Parameters

float $baseTaxCanceled

Returns: $this

Implemented in Order.

◆ setBaseTaxInvoiced()

setBaseTaxInvoiced ( $baseTaxInvoiced )

Sets the base tax invoiced amount for the order.

Parameters

float $baseTaxInvoiced

Returns: $this

Implemented in Order.

◆ setBaseTaxRefunded()

setBaseTaxRefunded ( $baseTaxRefunded )

Sets the base tax refunded amount for the order.

Parameters

float $baseTaxRefunded

Returns: $this

Implemented in Order.

◆ setBaseToGlobalRate()

setBaseToGlobalRate ( $rate )

Sets the base-to-global rate for the order.

Parameters

float $rate

Returns: $this

Implemented in Order.

◆ setBaseToOrderRate()

setBaseToOrderRate ( $rate )

Sets the base-to-order rate for the order.

Parameters

float $rate

Returns: $this

Implemented in Order.

◆ setBaseTotalCanceled()

setBaseTotalCanceled ( $baseTotalCanceled )

Sets the base total canceled for the order.

Parameters

float $baseTotalCanceled

Returns: $this

Implemented in Order.

◆ setBaseTotalDue()

setBaseTotalDue ( $baseTotalDue )

Sets the base total due for the order.

Parameters

float $baseTotalDue

Returns: $this

Implemented in Order.

◆ setBaseTotalInvoiced()

setBaseTotalInvoiced ( $baseTotalInvoiced )

Sets the base total invoiced amount for the order.

Parameters

float $baseTotalInvoiced

Returns: $this

Implemented in Order.

◆ setBaseTotalInvoicedCost()

setBaseTotalInvoicedCost ( $baseTotalInvoicedCost )

Sets the base total invoiced cost for the order.

Parameters

float $baseTotalInvoicedCost

Returns: $this

Implemented in Order.

◆ setBaseTotalOfflineRefunded()

setBaseTotalOfflineRefunded ( $baseTotalOfflineRefunded )

Sets the base total offline refunded amount for the order.

Parameters

float $baseTotalOfflineRefunded

Returns: $this

Implemented in Order.

◆ setBaseTotalOnlineRefunded()

setBaseTotalOnlineRefunded ( $baseTotalOnlineRefunded )

Sets the base total online refunded amount for the order.

Parameters

float $baseTotalOnlineRefunded

Returns: $this

Implemented in Order.

◆ setBaseTotalPaid()

setBaseTotalPaid ( $baseTotalPaid )

Sets the base total paid for the order.

Parameters

float $baseTotalPaid

Returns: $this

Implemented in Order.

◆ setBaseTotalQtyOrdered()

setBaseTotalQtyOrdered ( $baseTotalQtyOrdered )

Sets the base total quantity ordered for the order.

Parameters

float $baseTotalQtyOrdered

Returns: $this

Implemented in Order.

◆ setBaseTotalRefunded()

setBaseTotalRefunded ( $baseTotalRefunded )

Sets the base total refunded amount for the order.

Parameters

float $baseTotalRefunded

Returns: $this

Implemented in Order.

◆ setBillingAddress()

setBillingAddress ( \Magento\Sales\Api\Data\OrderAddressInterface $billingAddress = null )

Sets the billing address, if any, for the order.

Parameters

\Magento\Sales\Api\Data\OrderAddressInterface $billingAddress

Returns: $this

◆ setBillingAddressId()

setBillingAddressId ( $id )

Sets the billing address ID for the order.

Parameters

int $id

Returns: $this

Implemented in Order.

◆ setCanShipPartially()

setCanShipPartially ( $flag )

Sets the can-ship-partially flag value for the order.

Parameters

int $flag

Returns: $this

Implemented in Order.

◆ setCanShipPartiallyItem()

setCanShipPartiallyItem ( $flag )

Sets the can-ship-partially-item flag value for the order.

Parameters

int $flag

Returns: $this

Implemented in Order.

◆ setCouponCode()

setCouponCode ( $code )

Sets the coupon code for the order.

Parameters

string $code

Returns: $this

Implemented in Order.

◆ setCreatedAt()

setCreatedAt ( $createdAt )

Sets the created-at timestamp for the order.

Parameters

string $createdAt timestamp

Returns: $this

Implemented in Order.

◆ setCustomerDob()

setCustomerDob ( $customerDob )

Sets the customer date-of-birth (DOB) for the order.

Parameters

string $customerDob

Returns: $this

Implemented in Order.

◆ setCustomerEmail()

setCustomerEmail ( $customerEmail )

Sets the customer email address for the order.

Parameters

string $customerEmail

Returns: $this

Implemented in Order.

◆ setCustomerFirstname()

setCustomerFirstname ( $customerFirstname )

Sets the customer first name for the order.

Parameters

string $customerFirstname

Returns: $this

Implemented in Order.

◆ setCustomerGender()

setCustomerGender ( $customerGender )

Sets the customer gender for the order.

Parameters

int $customerGender

Returns: $this

Implemented in Order.

◆ setCustomerGroupId()

setCustomerGroupId ( $id )

Sets the customer group ID for the order.

Parameters

int $id

Returns: $this

Implemented in Order.

◆ setCustomerId()

setCustomerId ( $id )

Sets the customer ID for the order.

Parameters

int $id

Returns: $this

Implemented in Order.

◆ setCustomerIsGuest()

setCustomerIsGuest ( $customerIsGuest )

Sets the customer-is-guest flag value for the order.

Parameters

int $customerIsGuest

Returns: $this

Implemented in Order.

◆ setCustomerLastname()

setCustomerLastname ( $customerLastname )

Sets the customer last name for the order.

Parameters

string $customerLastname

Returns: $this

Implemented in Order.

◆ setCustomerMiddlename()

setCustomerMiddlename ( $customerMiddlename )

Sets the customer middle name for the order.

Parameters

string $customerMiddlename

Returns: $this

Implemented in Order.

◆ setCustomerNote()

setCustomerNote ( $customerNote )

Sets the customer note for the order.

Parameters

string $customerNote

Returns: $this

Implemented in Order.

◆ setCustomerNoteNotify()

setCustomerNoteNotify ( $customerNoteNotify )

Sets the customer-note-notify flag value for the order.

Parameters

int $customerNoteNotify

Returns: $this

Implemented in Order.

◆ setCustomerPrefix()

setCustomerPrefix ( $customerPrefix )

Sets the customer prefix for the order.

Parameters

string $customerPrefix

Returns: $this

Implemented in Order.

◆ setCustomerSuffix()

setCustomerSuffix ( $customerSuffix )

Sets the customer suffix for the order.

Parameters

string $customerSuffix

Returns: $this

Implemented in Order.

◆ setCustomerTaxvat()

setCustomerTaxvat ( $customerTaxvat )

Sets the customer value-added tax (VAT) for the order.

Parameters

string $customerTaxvat

Returns: $this

Implemented in Order.

◆ setDiscountAmount()

setDiscountAmount ( $amount )

Sets the discount amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setDiscountCanceled()

setDiscountCanceled ( $discountCanceled )

Sets the discount canceled for the order.

Parameters

float $discountCanceled

Returns: $this

Implemented in Order.

◆ setDiscountDescription()

setDiscountDescription ( $description )

Sets the discount description for the order.

Parameters

string $description

Returns: $this

Implemented in Order.

◆ setDiscountInvoiced()

setDiscountInvoiced ( $discountInvoiced )

Sets the discount invoiced amount for the order.

Parameters

float $discountInvoiced

Returns: $this

Implemented in Order.

◆ setDiscountRefunded()

setDiscountRefunded ( $discountRefunded )

Sets the discount refunded amount for the order.

Parameters

float $discountRefunded

Returns: $this

Implemented in Order.

◆ setDiscountTaxCompensationAmount()

setDiscountTaxCompensationAmount ( $amount )

Sets the discount tax compensation amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setDiscountTaxCompensationInvoiced()

setDiscountTaxCompensationInvoiced ( $discountTaxCompensationInvoiced )

Sets the discount tax compensation invoiced amount for the order.

Parameters

float $discountTaxCompensationInvoiced

Returns: $this

Implemented in Order.

◆ setDiscountTaxCompensationRefunded()

setDiscountTaxCompensationRefunded ( $discountTaxCompensationRefunded )

Sets the discount tax compensation refunded amount for the order.

Parameters

float $discountTaxCompensationRefunded

Returns: $this

Implemented in Order.

◆ setEditIncrement()

setEditIncrement ( $editIncrement )

Sets the edit increment value for the order.

Parameters

int $editIncrement

Returns: $this

Implemented in Order.

◆ setEmailSent()

setEmailSent ( $emailSent )

Sets the email-sent flag value for the order.

Parameters

int $emailSent

Returns: $this

Implemented in Order.

◆ setEntityId()

setEntityId ( $entityId )

Sets entity ID.

Parameters

int $entityId

Returns: $this

◆ setExtCustomerId()

setExtCustomerId ( $id )

Sets the external customer ID for the order.

Parameters

string $id

Returns: $this

Implemented in Order.

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Sales\Api\Data\OrderExtensionInterface $extensionAttributes )

Set an extension attributes object.

Parameters

\Magento\Sales\Api\Data\OrderExtensionInterface $extensionAttributes

Returns: $this

Implemented in Order.

◆ setExtOrderId()

setExtOrderId ( $id )

Sets the external order ID for the order.

Parameters

string $id

Returns: $this

Implemented in Order.

◆ setForcedShipmentWithInvoice()

setForcedShipmentWithInvoice ( $forcedShipmentWithInvoice )

Sets the forced-shipment-with-invoice flag value for the order.

Parameters

int $forcedShipmentWithInvoice

Returns: $this

Implemented in Order.

◆ setGlobalCurrencyCode()

setGlobalCurrencyCode ( $code )

Sets the global currency code for the order.

Parameters

string $code

Returns: $this

Implemented in Order.

◆ setGrandTotal()

setGrandTotal ( $amount )

Sets the grand total for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setHoldBeforeState()

setHoldBeforeState ( $holdBeforeState )

Sets the hold before state for the order.

Parameters

string $holdBeforeState

Returns: $this

Implemented in Order.

◆ setHoldBeforeStatus()

setHoldBeforeStatus ( $holdBeforeStatus )

Sets the hold before status for the order.

Parameters

string $holdBeforeStatus

Returns: $this

Implemented in Order.

◆ setIncrementId()

setIncrementId ( $id )

Sets the increment ID for the order.

Parameters

string $id

Returns: $this

Implemented in Order.

◆ setIsVirtual()

setIsVirtual ( $isVirtual )

Sets the is-virtual flag value for the order.

Parameters

int $isVirtual

Returns: $this

Implemented in Order.

◆ setItems()

setItems ( $items )

Sets items for the order.

Parameters

Implemented in Order.

◆ setOrderCurrencyCode()

setOrderCurrencyCode ( $code )

Sets the order currency code for the order.

Parameters

string $code

Returns: $this

Implemented in Order.

◆ setOriginalIncrementId()

setOriginalIncrementId ( $id )

Sets the original increment ID for the order.

Parameters

string $id

Returns: $this

Implemented in Order.

◆ setPayment()

setPayment ( \Magento\Sales\Api\Data\OrderPaymentInterface $payment = null )

Sets order payment

Parameters

\Magento\Sales\Api\Data\OrderPaymentInterface | null $payment

Returns: \Magento\Sales\Api\Data\OrderPaymentInterface

◆ setPaymentAuthExpiration()

setPaymentAuthExpiration ( $paymentAuthExpiration )

Sets the payment authorization expiration date for the order.

Parameters

int $paymentAuthExpiration

Returns: $this

Implemented in Order.

◆ setPaymentAuthorizationAmount()

setPaymentAuthorizationAmount ( $amount )

Sets the payment authorization amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setProtectCode()

setProtectCode ( $code )

Sets the protect code for the order.

Parameters

string $code

Returns: $this

Implemented in Order.

◆ setQuoteAddressId()

setQuoteAddressId ( $id )

Sets the quote address ID for the order.

Parameters

int $id

Returns: $this

Implemented in Order.

◆ setQuoteId()

setQuoteId ( $id )

Sets the quote ID for the order.

Parameters

int $id

Returns: $this

Implemented in Order.

◆ setRelationChildId()

setRelationChildId ( $id )

Sets the relation child ID for the order.

Parameters

string $id

Returns: $this

Implemented in Order.

◆ setRelationChildRealId()

setRelationChildRealId ( $realId )

Sets the relation child real ID for the order.

Parameters

string $realId

Returns: $this

Implemented in Order.

◆ setRelationParentId()

setRelationParentId ( $id )

Sets the relation parent ID for the order.

Parameters

string $id

Returns: $this

Implemented in Order.

◆ setRelationParentRealId()

setRelationParentRealId ( $realId )

Sets the relation parent real ID for the order.

Parameters

string $realId

Returns: $this

Implemented in Order.

◆ setRemoteIp()

setRemoteIp ( $remoteIp )

Sets the remote IP address for the order.

Parameters

string $remoteIp

Returns: $this

Implemented in Order.

◆ setShippingAmount()

setShippingAmount ( $amount )

Sets the shipping amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setShippingCanceled()

setShippingCanceled ( $shippingCanceled )

Sets the shipping canceled amount for the order.

Parameters

float $shippingCanceled

Returns: $this

Implemented in Order.

◆ setShippingDescription()

setShippingDescription ( $description )

Sets the shipping description for the order.

Parameters

string $description

Returns: $this

Implemented in Order.

◆ setShippingDiscountAmount()

setShippingDiscountAmount ( $amount )

Sets the shipping discount amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setShippingDiscountTaxCompensationAmount()

setShippingDiscountTaxCompensationAmount ( $amount )

Sets the shipping discount tax compensation amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setShippingInclTax()

setShippingInclTax ( $amount )

Sets the shipping including tax amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setShippingInvoiced()

setShippingInvoiced ( $shippingInvoiced )

Sets the shipping invoiced amount for the order.

Parameters

float $shippingInvoiced

Returns: $this

Implemented in Order.

◆ setShippingRefunded()

setShippingRefunded ( $shippingRefunded )

Sets the shipping refunded amount for the order.

Parameters

float $shippingRefunded

Returns: $this

Implemented in Order.

◆ setShippingTaxAmount()

setShippingTaxAmount ( $amount )

Sets the shipping tax amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setShippingTaxRefunded()

setShippingTaxRefunded ( $shippingTaxRefunded )

Sets the shipping tax refunded amount for the order.

Parameters

float $shippingTaxRefunded

Returns: $this

Implemented in Order.

◆ setState()

setState ( $state )

Sets the state for the order.

Parameters

string $state

Returns: $this

Implemented in Order.

◆ setStatus()

setStatus ( $status )

Sets the status for the order.

Parameters

string $status

Returns: $this

Implemented in Order.

◆ setStatusHistories()

setStatusHistories ( array $statusHistories = null )

Sets status histories for the order.

Parameters

Implemented in Order.

◆ setStoreCurrencyCode()

setStoreCurrencyCode ( $code )

Sets the store currency code for the order.

Parameters

string $code

Returns: $this

Implemented in Order.

◆ setStoreId()

setStoreId ( $id )

Sets the store ID for the order.

Parameters

int $id

Returns: $this

Implemented in Order.

◆ setStoreName()

setStoreName ( $storeName )

Sets the store name for the order.

Parameters

string $storeName

Returns: $this

Implemented in Order.

◆ setStoreToBaseRate()

setStoreToBaseRate ( $rate )

Sets the store-to-base rate for the order.

Parameters

float $rate

Returns: $this

Implemented in Order.

◆ setStoreToOrderRate()

setStoreToOrderRate ( $rate )

Sets the store-to-order rate for the order.

Parameters

float $rate

Returns: $this

Implemented in Order.

◆ setSubtotal()

setSubtotal ( $amount )

Sets the subtotal for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setSubtotalCanceled()

setSubtotalCanceled ( $subtotalCanceled )

Sets the subtotal canceled amount for the order.

Parameters

float $subtotalCanceled

Returns: $this

Implemented in Order.

◆ setSubtotalInclTax()

setSubtotalInclTax ( $amount )

Sets the subtotal including tax amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setSubtotalInvoiced()

setSubtotalInvoiced ( $subtotalInvoiced )

Sets the subtotal invoiced amount for the order.

Parameters

float $subtotalInvoiced

Returns: $this

Implemented in Order.

◆ setSubtotalRefunded()

setSubtotalRefunded ( $subtotalRefunded )

Sets the subtotal refunded amount for the order.

Parameters

float $subtotalRefunded

Returns: $this

Implemented in Order.

◆ setTaxAmount()

setTaxAmount ( $amount )

Sets the tax amount for the order.

Parameters

float $amount

Returns: $this

Implemented in Order.

◆ setTaxCanceled()

setTaxCanceled ( $taxCanceled )

Sets the tax canceled amount for the order.

Parameters

float $taxCanceled

Returns: $this

Implemented in Order.

◆ setTaxInvoiced()

setTaxInvoiced ( $taxInvoiced )

Sets the tax invoiced amount for the order.

Parameters

float $taxInvoiced

Returns: $this

Implemented in Order.

◆ setTaxRefunded()

setTaxRefunded ( $taxRefunded )

Sets the tax refunded amount for the order.

Parameters

float $taxRefunded

Returns: $this

Implemented in Order.

◆ setTotalCanceled()

setTotalCanceled ( $totalCanceled )

Sets the total canceled for the order.

Parameters

float $totalCanceled

Returns: $this

Implemented in Order.

◆ setTotalDue()

setTotalDue ( $totalDue )

Sets the total due for the order.

Parameters

float $totalDue

Returns: $this

Implemented in Order.

◆ setTotalInvoiced()

setTotalInvoiced ( $totalInvoiced )

Sets the total invoiced amount for the order.

Parameters

float $totalInvoiced

Returns: $this

Implemented in Order.

◆ setTotalItemCount()

setTotalItemCount ( $totalItemCount )

Sets the total item count for the order.

Parameters

int $totalItemCount

Returns: $this

Implemented in Order.

◆ setTotalOfflineRefunded()

setTotalOfflineRefunded ( $totalOfflineRefunded )

Sets the total offline refunded amount for the order.

Parameters

float $totalOfflineRefunded

Returns: $this

Implemented in Order.

◆ setTotalOnlineRefunded()

setTotalOnlineRefunded ( $totalOnlineRefunded )

Sets the total online refunded amount for the order.

Parameters

float $totalOnlineRefunded

Returns: $this

Implemented in Order.

◆ setTotalPaid()

setTotalPaid ( $totalPaid )

Sets the total paid for the order.

Parameters

float $totalPaid

Returns: $this

Implemented in Order.

◆ setTotalQtyOrdered()

setTotalQtyOrdered ( $totalQtyOrdered )

Sets the total quantity ordered for the order.

Parameters

float $totalQtyOrdered

Returns: $this

Implemented in Order.

◆ setTotalRefunded()

setTotalRefunded ( $totalRefunded )

Sets the total amount refunded amount for the order.

Parameters

float $totalRefunded

Returns: $this

Implemented in Order.

◆ setUpdatedAt()

setUpdatedAt ( $timestamp )

Sets the updated-at timestamp for the order.

Parameters

string $timestamp

Returns: $this

Implemented in Order.

◆ setWeight()

setWeight ( $weight )

Sets the weight for the order.

Parameters

float $weight

Returns: $this

Implemented in Order.

◆ setXForwardedFor()

setXForwardedFor ( $xForwardedFor )

Sets the X-Forwarded-For HTTP header field for the order.

Parameters

string $xForwardedFor

Returns: $this

Implemented in Order.

Field Documentation

◆ ADJUSTMENT_NEGATIVE

const ADJUSTMENT_NEGATIVE = 'adjustment_negative'

Definition at line 337 of file OrderInterface.php.

◆ ADJUSTMENT_POSITIVE

const ADJUSTMENT_POSITIVE = 'adjustment_positive'

Definition at line 341 of file OrderInterface.php.

◆ APPLIED_RULE_IDS

const APPLIED_RULE_IDS = 'applied_rule_ids'

Definition at line 393 of file OrderInterface.php.

◆ BASE_ADJUSTMENT_NEGATIVE

const BASE_ADJUSTMENT_NEGATIVE = 'base_adjustment_negative'

Definition at line 345 of file OrderInterface.php.

◆ BASE_ADJUSTMENT_POSITIVE

const BASE_ADJUSTMENT_POSITIVE = 'base_adjustment_positive'

Definition at line 349 of file OrderInterface.php.

◆ BASE_CURRENCY_CODE

const BASE_CURRENCY_CODE = 'base_currency_code'

Definition at line 397 of file OrderInterface.php.

◆ BASE_DISCOUNT_AMOUNT

const BASE_DISCOUNT_AMOUNT = 'base_discount_amount'

Definition at line 61 of file OrderInterface.php.

◆ BASE_DISCOUNT_CANCELED

const BASE_DISCOUNT_CANCELED = 'base_discount_canceled'

Definition at line 65 of file OrderInterface.php.

◆ BASE_DISCOUNT_INVOICED

const BASE_DISCOUNT_INVOICED = 'base_discount_invoiced'

Definition at line 69 of file OrderInterface.php.

◆ BASE_DISCOUNT_REFUNDED

const BASE_DISCOUNT_REFUNDED = 'base_discount_refunded'

Definition at line 73 of file OrderInterface.php.

◆ BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT

const BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount'

Definition at line 517 of file OrderInterface.php.

◆ BASE_DISCOUNT_TAX_COMPENSATION_INVOICED

const BASE_DISCOUNT_TAX_COMPENSATION_INVOICED = 'base_discount_tax_compensation_invoiced'

Definition at line 533 of file OrderInterface.php.

◆ BASE_DISCOUNT_TAX_COMPENSATION_REFUNDED

const BASE_DISCOUNT_TAX_COMPENSATION_REFUNDED = 'base_discount_tax_compensation_refunded'

Definition at line 541 of file OrderInterface.php.

◆ BASE_GRAND_TOTAL

const BASE_GRAND_TOTAL = 'base_grand_total'

Definition at line 77 of file OrderInterface.php.

◆ BASE_SHIPPING_AMOUNT

const BASE_SHIPPING_AMOUNT = 'base_shipping_amount'

Definition at line 81 of file OrderInterface.php.

◆ BASE_SHIPPING_CANCELED

const BASE_SHIPPING_CANCELED = 'base_shipping_canceled'

Definition at line 85 of file OrderInterface.php.

◆ BASE_SHIPPING_DISCOUNT_AMOUNT

const BASE_SHIPPING_DISCOUNT_AMOUNT = 'base_shipping_discount_amount'

Definition at line 353 of file OrderInterface.php.

◆ BASE_SHIPPING_DISCOUNT_TAX_COMPENSATION_AMNT

const BASE_SHIPPING_DISCOUNT_TAX_COMPENSATION_AMNT = 'base_shipping_discount_tax_compensation_amnt'

Definition at line 525 of file OrderInterface.php.

◆ BASE_SHIPPING_INCL_TAX

const BASE_SHIPPING_INCL_TAX = 'base_shipping_incl_tax'

Definition at line 549 of file OrderInterface.php.

◆ BASE_SHIPPING_INVOICED

const BASE_SHIPPING_INVOICED = 'base_shipping_invoiced'

Definition at line 89 of file OrderInterface.php.

◆ BASE_SHIPPING_REFUNDED

const BASE_SHIPPING_REFUNDED = 'base_shipping_refunded'

Definition at line 93 of file OrderInterface.php.

◆ BASE_SHIPPING_TAX_AMOUNT

const BASE_SHIPPING_TAX_AMOUNT = 'base_shipping_tax_amount'

Definition at line 97 of file OrderInterface.php.

◆ BASE_SHIPPING_TAX_REFUNDED

const BASE_SHIPPING_TAX_REFUNDED = 'base_shipping_tax_refunded'

Definition at line 101 of file OrderInterface.php.

◆ BASE_SUBTOTAL

const BASE_SUBTOTAL = 'base_subtotal'

Definition at line 105 of file OrderInterface.php.

◆ BASE_SUBTOTAL_CANCELED

const BASE_SUBTOTAL_CANCELED = 'base_subtotal_canceled'

Definition at line 109 of file OrderInterface.php.

◆ BASE_SUBTOTAL_INCL_TAX

const BASE_SUBTOTAL_INCL_TAX = 'base_subtotal_incl_tax'

Definition at line 357 of file OrderInterface.php.

◆ BASE_SUBTOTAL_INVOICED

const BASE_SUBTOTAL_INVOICED = 'base_subtotal_invoiced'

Definition at line 113 of file OrderInterface.php.

◆ BASE_SUBTOTAL_REFUNDED

const BASE_SUBTOTAL_REFUNDED = 'base_subtotal_refunded'

Definition at line 117 of file OrderInterface.php.

◆ BASE_TAX_AMOUNT

const BASE_TAX_AMOUNT = 'base_tax_amount'

Definition at line 121 of file OrderInterface.php.

◆ BASE_TAX_CANCELED

const BASE_TAX_CANCELED = 'base_tax_canceled'

Definition at line 125 of file OrderInterface.php.

◆ BASE_TAX_INVOICED

const BASE_TAX_INVOICED = 'base_tax_invoiced'

Definition at line 129 of file OrderInterface.php.

◆ BASE_TAX_REFUNDED

const BASE_TAX_REFUNDED = 'base_tax_refunded'

Definition at line 133 of file OrderInterface.php.

◆ BASE_TO_GLOBAL_RATE

const BASE_TO_GLOBAL_RATE = 'base_to_global_rate'

Definition at line 137 of file OrderInterface.php.

◆ BASE_TO_ORDER_RATE

const BASE_TO_ORDER_RATE = 'base_to_order_rate'

Definition at line 141 of file OrderInterface.php.

◆ BASE_TOTAL_CANCELED

const BASE_TOTAL_CANCELED = 'base_total_canceled'

Definition at line 145 of file OrderInterface.php.

◆ BASE_TOTAL_DUE

const BASE_TOTAL_DUE = 'base_total_due'

Definition at line 361 of file OrderInterface.php.

◆ BASE_TOTAL_INVOICED

const BASE_TOTAL_INVOICED = 'base_total_invoiced'

Definition at line 149 of file OrderInterface.php.

◆ BASE_TOTAL_INVOICED_COST

const BASE_TOTAL_INVOICED_COST = 'base_total_invoiced_cost'

Definition at line 153 of file OrderInterface.php.

◆ BASE_TOTAL_OFFLINE_REFUNDED

const BASE_TOTAL_OFFLINE_REFUNDED = 'base_total_offline_refunded'

Definition at line 157 of file OrderInterface.php.

◆ BASE_TOTAL_ONLINE_REFUNDED

const BASE_TOTAL_ONLINE_REFUNDED = 'base_total_online_refunded'

Definition at line 161 of file OrderInterface.php.

◆ BASE_TOTAL_PAID

const BASE_TOTAL_PAID = 'base_total_paid'

Definition at line 165 of file OrderInterface.php.

◆ BASE_TOTAL_QTY_ORDERED

const BASE_TOTAL_QTY_ORDERED = 'base_total_qty_ordered'

Definition at line 169 of file OrderInterface.php.

◆ BASE_TOTAL_REFUNDED

const BASE_TOTAL_REFUNDED = 'base_total_refunded'

Definition at line 173 of file OrderInterface.php.

◆ BILLING_ADDRESS

const BILLING_ADDRESS = 'billing_address'

Definition at line 557 of file OrderInterface.php.

◆ BILLING_ADDRESS_ID

const BILLING_ADDRESS_ID = 'billing_address_id'

Definition at line 305 of file OrderInterface.php.

◆ CAN_SHIP_PARTIALLY

const CAN_SHIP_PARTIALLY = 'can_ship_partially'

Definition at line 289 of file OrderInterface.php.

◆ CAN_SHIP_PARTIALLY_ITEM

const CAN_SHIP_PARTIALLY_ITEM = 'can_ship_partially_item'

Definition at line 293 of file OrderInterface.php.

◆ COUPON_CODE

const COUPON_CODE = 'coupon_code'

Definition at line 37 of file OrderInterface.php.

◆ CREATED_AT

const CREATED_AT = 'created_at'

Definition at line 497 of file OrderInterface.php.

◆ CUSTOMER_DOB

const CUSTOMER_DOB = 'customer_dob'

Definition at line 385 of file OrderInterface.php.

◆ CUSTOMER_EMAIL

const CUSTOMER_EMAIL = 'customer_email'

Definition at line 401 of file OrderInterface.php.

◆ CUSTOMER_FIRSTNAME

const CUSTOMER_FIRSTNAME = 'customer_firstname'

Definition at line 405 of file OrderInterface.php.

◆ CUSTOMER_GENDER

const CUSTOMER_GENDER = 'customer_gender'

Definition at line 509 of file OrderInterface.php.

◆ CUSTOMER_GROUP_ID

const CUSTOMER_GROUP_ID = 'customer_group_id'

Definition at line 309 of file OrderInterface.php.

◆ CUSTOMER_ID

const CUSTOMER_ID = 'customer_id'

Definition at line 57 of file OrderInterface.php.

◆ CUSTOMER_IS_GUEST

const CUSTOMER_IS_GUEST = 'customer_is_guest'

Definition at line 297 of file OrderInterface.php.

◆ CUSTOMER_LASTNAME

const CUSTOMER_LASTNAME = 'customer_lastname'

Definition at line 409 of file OrderInterface.php.

◆ CUSTOMER_MIDDLENAME

const CUSTOMER_MIDDLENAME = 'customer_middlename'

Definition at line 413 of file OrderInterface.php.

◆ CUSTOMER_NOTE

const CUSTOMER_NOTE = 'customer_note'

Definition at line 493 of file OrderInterface.php.

◆ CUSTOMER_NOTE_NOTIFY

const CUSTOMER_NOTE_NOTIFY = 'customer_note_notify'

Definition at line 301 of file OrderInterface.php.

◆ CUSTOMER_PREFIX

const CUSTOMER_PREFIX = 'customer_prefix'

Definition at line 417 of file OrderInterface.php.

◆ CUSTOMER_SUFFIX

const CUSTOMER_SUFFIX = 'customer_suffix'

Definition at line 421 of file OrderInterface.php.

◆ CUSTOMER_TAXVAT

const CUSTOMER_TAXVAT = 'customer_taxvat'

Definition at line 425 of file OrderInterface.php.

◆ DISCOUNT_AMOUNT

const DISCOUNT_AMOUNT = 'discount_amount'

Definition at line 177 of file OrderInterface.php.

◆ DISCOUNT_CANCELED

const DISCOUNT_CANCELED = 'discount_canceled'

Definition at line 181 of file OrderInterface.php.

◆ DISCOUNT_DESCRIPTION

const DISCOUNT_DESCRIPTION = 'discount_description'

Definition at line 429 of file OrderInterface.php.

◆ DISCOUNT_INVOICED

const DISCOUNT_INVOICED = 'discount_invoiced'

Definition at line 185 of file OrderInterface.php.

◆ DISCOUNT_REFUNDED

const DISCOUNT_REFUNDED = 'discount_refunded'

Definition at line 189 of file OrderInterface.php.

◆ DISCOUNT_TAX_COMPENSATION_AMOUNT

const DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount'

Definition at line 513 of file OrderInterface.php.

◆ DISCOUNT_TAX_COMPENSATION_INVOICED

const DISCOUNT_TAX_COMPENSATION_INVOICED = 'discount_tax_compensation_invoiced'

Definition at line 529 of file OrderInterface.php.

◆ DISCOUNT_TAX_COMPENSATION_REFUNDED

const DISCOUNT_TAX_COMPENSATION_REFUNDED = 'discount_tax_compensation_refunded'

Definition at line 537 of file OrderInterface.php.

◆ EDIT_INCREMENT

const EDIT_INCREMENT = 'edit_increment'

Definition at line 313 of file OrderInterface.php.

◆ EMAIL_SENT

const EMAIL_SENT = 'email_sent'

Definition at line 317 of file OrderInterface.php.

◆ ENTITY_ID

const ENTITY_ID = 'entity_id'

#+ Constants for keys of data array. Identical to the name of the getter in snake case.

Definition at line 25 of file OrderInterface.php.

◆ EXT_CUSTOMER_ID

const EXT_CUSTOMER_ID = 'ext_customer_id'

Definition at line 433 of file OrderInterface.php.

◆ EXT_ORDER_ID

const EXT_ORDER_ID = 'ext_order_id'

Definition at line 437 of file OrderInterface.php.

◆ FORCED_SHIPMENT_WITH_INVOICE

const FORCED_SHIPMENT_WITH_INVOICE = 'forced_shipment_with_invoice'

Definition at line 321 of file OrderInterface.php.

◆ GLOBAL_CURRENCY_CODE

const GLOBAL_CURRENCY_CODE = 'global_currency_code'

Definition at line 441 of file OrderInterface.php.

◆ GRAND_TOTAL

const GRAND_TOTAL = 'grand_total'

Definition at line 193 of file OrderInterface.php.

◆ HOLD_BEFORE_STATE

const HOLD_BEFORE_STATE = 'hold_before_state'

Definition at line 445 of file OrderInterface.php.

◆ HOLD_BEFORE_STATUS

const HOLD_BEFORE_STATUS = 'hold_before_status'

Definition at line 449 of file OrderInterface.php.

◆ INCREMENT_ID

const INCREMENT_ID = 'increment_id'

Definition at line 389 of file OrderInterface.php.

◆ IS_VIRTUAL

const IS_VIRTUAL = 'is_virtual'

Definition at line 49 of file OrderInterface.php.

◆ ITEMS

const ITEMS = 'items'

Definition at line 553 of file OrderInterface.php.

◆ ORDER_CURRENCY_CODE

const ORDER_CURRENCY_CODE = 'order_currency_code'

Definition at line 453 of file OrderInterface.php.

◆ ORIGINAL_INCREMENT_ID

const ORIGINAL_INCREMENT_ID = 'original_increment_id'

Definition at line 457 of file OrderInterface.php.

◆ PAYMENT

const PAYMENT = 'payment'

Definition at line 561 of file OrderInterface.php.

◆ PAYMENT_AUTH_EXPIRATION

const PAYMENT_AUTH_EXPIRATION = 'payment_auth_expiration'

Definition at line 325 of file OrderInterface.php.

◆ PAYMENT_AUTHORIZATION_AMOUNT

const PAYMENT_AUTHORIZATION_AMOUNT = 'payment_authorization_amount'

Definition at line 365 of file OrderInterface.php.

◆ PROTECT_CODE

const PROTECT_CODE = 'protect_code'

Definition at line 41 of file OrderInterface.php.

◆ QUOTE_ADDRESS_ID

const QUOTE_ADDRESS_ID = 'quote_address_id'

Definition at line 329 of file OrderInterface.php.

◆ QUOTE_ID

const QUOTE_ID = 'quote_id'

Definition at line 333 of file OrderInterface.php.

◆ RELATION_CHILD_ID

const RELATION_CHILD_ID = 'relation_child_id'

Definition at line 461 of file OrderInterface.php.

◆ RELATION_CHILD_REAL_ID

const RELATION_CHILD_REAL_ID = 'relation_child_real_id'

Definition at line 465 of file OrderInterface.php.

◆ RELATION_PARENT_ID

const RELATION_PARENT_ID = 'relation_parent_id'

Definition at line 469 of file OrderInterface.php.

◆ RELATION_PARENT_REAL_ID

const RELATION_PARENT_REAL_ID = 'relation_parent_real_id'

Definition at line 473 of file OrderInterface.php.

◆ REMOTE_IP

const REMOTE_IP = 'remote_ip'

Definition at line 477 of file OrderInterface.php.

◆ SHIPPING_AMOUNT

const SHIPPING_AMOUNT = 'shipping_amount'

Definition at line 197 of file OrderInterface.php.

◆ SHIPPING_CANCELED

const SHIPPING_CANCELED = 'shipping_canceled'

Definition at line 201 of file OrderInterface.php.

◆ SHIPPING_DESCRIPTION

const SHIPPING_DESCRIPTION = 'shipping_description'

Definition at line 45 of file OrderInterface.php.

◆ SHIPPING_DISCOUNT_AMOUNT

const SHIPPING_DISCOUNT_AMOUNT = 'shipping_discount_amount'

Definition at line 369 of file OrderInterface.php.

◆ SHIPPING_DISCOUNT_TAX_COMPENSATION_AMOUNT

const SHIPPING_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'shipping_discount_tax_compensation_amount'

Definition at line 521 of file OrderInterface.php.

◆ SHIPPING_INCL_TAX

const SHIPPING_INCL_TAX = 'shipping_incl_tax'

Definition at line 545 of file OrderInterface.php.

◆ SHIPPING_INVOICED

const SHIPPING_INVOICED = 'shipping_invoiced'

Definition at line 205 of file OrderInterface.php.

◆ SHIPPING_REFUNDED

const SHIPPING_REFUNDED = 'shipping_refunded'

Definition at line 209 of file OrderInterface.php.

◆ SHIPPING_TAX_AMOUNT

const SHIPPING_TAX_AMOUNT = 'shipping_tax_amount'

Definition at line 213 of file OrderInterface.php.

◆ SHIPPING_TAX_REFUNDED

const SHIPPING_TAX_REFUNDED = 'shipping_tax_refunded'

Definition at line 217 of file OrderInterface.php.

◆ STATE

const STATE = 'state'

Definition at line 29 of file OrderInterface.php.

◆ STATUS

const STATUS = 'status'

Definition at line 33 of file OrderInterface.php.

◆ STATUS_HISTORIES

const STATUS_HISTORIES = 'status_histories'

Definition at line 565 of file OrderInterface.php.

◆ STORE_CURRENCY_CODE

const STORE_CURRENCY_CODE = 'store_currency_code'

Definition at line 481 of file OrderInterface.php.

◆ STORE_ID

const STORE_ID = 'store_id'

Definition at line 53 of file OrderInterface.php.

◆ STORE_NAME

const STORE_NAME = 'store_name'

Definition at line 485 of file OrderInterface.php.

◆ STORE_TO_BASE_RATE

const STORE_TO_BASE_RATE = 'store_to_base_rate'

Definition at line 221 of file OrderInterface.php.

◆ STORE_TO_ORDER_RATE

const STORE_TO_ORDER_RATE = 'store_to_order_rate'

Definition at line 225 of file OrderInterface.php.

◆ SUBTOTAL

const SUBTOTAL = 'subtotal'

Definition at line 229 of file OrderInterface.php.

◆ SUBTOTAL_CANCELED

const SUBTOTAL_CANCELED = 'subtotal_canceled'

Definition at line 233 of file OrderInterface.php.

◆ SUBTOTAL_INCL_TAX

const SUBTOTAL_INCL_TAX = 'subtotal_incl_tax'

Definition at line 373 of file OrderInterface.php.

◆ SUBTOTAL_INVOICED

const SUBTOTAL_INVOICED = 'subtotal_invoiced'

Definition at line 237 of file OrderInterface.php.

◆ SUBTOTAL_REFUNDED

const SUBTOTAL_REFUNDED = 'subtotal_refunded'

Definition at line 241 of file OrderInterface.php.

◆ TAX_AMOUNT

const TAX_AMOUNT = 'tax_amount'

Definition at line 245 of file OrderInterface.php.

◆ TAX_CANCELED

const TAX_CANCELED = 'tax_canceled'

Definition at line 249 of file OrderInterface.php.

◆ TAX_INVOICED

const TAX_INVOICED = 'tax_invoiced'

Definition at line 253 of file OrderInterface.php.

◆ TAX_REFUNDED

const TAX_REFUNDED = 'tax_refunded'

Definition at line 257 of file OrderInterface.php.

◆ TOTAL_CANCELED

const TOTAL_CANCELED = 'total_canceled'

Definition at line 261 of file OrderInterface.php.

◆ TOTAL_DUE

const TOTAL_DUE = 'total_due'

Definition at line 377 of file OrderInterface.php.

◆ TOTAL_INVOICED

const TOTAL_INVOICED = 'total_invoiced'

Definition at line 265 of file OrderInterface.php.

◆ TOTAL_ITEM_COUNT

const TOTAL_ITEM_COUNT = 'total_item_count'

Definition at line 505 of file OrderInterface.php.

◆ TOTAL_OFFLINE_REFUNDED

const TOTAL_OFFLINE_REFUNDED = 'total_offline_refunded'

Definition at line 269 of file OrderInterface.php.

◆ TOTAL_ONLINE_REFUNDED

const TOTAL_ONLINE_REFUNDED = 'total_online_refunded'

Definition at line 273 of file OrderInterface.php.

◆ TOTAL_PAID

const TOTAL_PAID = 'total_paid'

Definition at line 277 of file OrderInterface.php.

◆ TOTAL_QTY_ORDERED

const TOTAL_QTY_ORDERED = 'total_qty_ordered'

Definition at line 281 of file OrderInterface.php.

◆ TOTAL_REFUNDED

const TOTAL_REFUNDED = 'total_refunded'

Definition at line 285 of file OrderInterface.php.

◆ UPDATED_AT

const UPDATED_AT = 'updated_at'

Definition at line 501 of file OrderInterface.php.

◆ WEIGHT

const WEIGHT = 'weight'

Definition at line 381 of file OrderInterface.php.

◆ X_FORWARDED_FOR

const X_FORWARDED_FOR = 'x_forwarded_for'

Definition at line 489 of file OrderInterface.php.

The documentation for this interface was generated from the following file:

vendor/magento/module-sales/Api/Data/OrderInterface.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ getAdjustmentNegative()

◆ getAdjustmentPositive()

◆ getAppliedRuleIds()

◆ getBaseAdjustmentNegative()

◆ getBaseAdjustmentPositive()

◆ getBaseCurrencyCode()

◆ getBaseDiscountAmount()

◆ getBaseDiscountCanceled()

◆ getBaseDiscountInvoiced()

◆ getBaseDiscountRefunded()

◆ getBaseDiscountTaxCompensationAmount()

◆ getBaseDiscountTaxCompensationInvoiced()

◆ getBaseDiscountTaxCompensationRefunded()

◆ getBaseGrandTotal()

◆ getBaseShippingAmount()

◆ getBaseShippingCanceled()

◆ getBaseShippingDiscountAmount()

◆ getBaseShippingDiscountTaxCompensationAmnt()

◆ getBaseShippingInclTax()

◆ getBaseShippingInvoiced()

◆ getBaseShippingRefunded()

◆ getBaseShippingTaxAmount()

◆ getBaseShippingTaxRefunded()

◆ getBaseSubtotal()

◆ getBaseSubtotalCanceled()

◆ getBaseSubtotalInclTax()

◆ getBaseSubtotalInvoiced()

◆ getBaseSubtotalRefunded()

◆ getBaseTaxAmount()

◆ getBaseTaxCanceled()

◆ getBaseTaxInvoiced()

◆ getBaseTaxRefunded()

◆ getBaseToGlobalRate()

◆ getBaseToOrderRate()

◆ getBaseTotalCanceled()

◆ getBaseTotalDue()

◆ getBaseTotalInvoiced()

◆ getBaseTotalInvoicedCost()

◆ getBaseTotalOfflineRefunded()

◆ getBaseTotalOnlineRefunded()

◆ getBaseTotalPaid()

◆ getBaseTotalQtyOrdered()

◆ getBaseTotalRefunded()

◆ getBillingAddress()

◆ getBillingAddressId()

◆ getCanShipPartially()

◆ getCanShipPartiallyItem()

◆ getCouponCode()

◆ getCreatedAt()

◆ getCustomerDob()

◆ getCustomerEmail()

◆ getCustomerFirstname()

◆ getCustomerGender()

◆ getCustomerGroupId()

◆ getCustomerId()

◆ getCustomerIsGuest()

◆ getCustomerLastname()

◆ getCustomerMiddlename()

◆ getCustomerNote()

◆ getCustomerNoteNotify()

◆ getCustomerPrefix()

◆ getCustomerSuffix()

◆ getCustomerTaxvat()

◆ getDiscountAmount()

◆ getDiscountCanceled()

◆ getDiscountDescription()

◆ getDiscountInvoiced()

◆ getDiscountRefunded()

◆ getDiscountTaxCompensationAmount()

◆ getDiscountTaxCompensationInvoiced()

◆ getDiscountTaxCompensationRefunded()

◆ getEditIncrement()

◆ getEmailSent()

◆ getEntityId()

◆ getExtCustomerId()

◆ getExtensionAttributes()