Magento 2 Documentation
2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
|
Data Fields | |
const | ENTITY = 'order' |
const | STATE_NEW = 'new' |
const | STATE_PENDING_PAYMENT = 'pending_payment' |
const | STATE_PROCESSING = 'processing' |
const | STATE_COMPLETE = 'complete' |
const | STATE_CLOSED = 'closed' |
const | STATE_CANCELED = 'canceled' |
const | STATE_HOLDED = 'holded' |
const | STATE_PAYMENT_REVIEW = 'payment_review' |
const | STATUS_FRAUD = 'fraud' |
const | ACTION_FLAG_CANCEL = 'cancel' |
const | ACTION_FLAG_HOLD = 'hold' |
const | ACTION_FLAG_UNHOLD = 'unhold' |
const | ACTION_FLAG_EDIT = 'edit' |
const | ACTION_FLAG_CREDITMEMO = 'creditmemo' |
const | ACTION_FLAG_INVOICE = 'invoice' |
const | ACTION_FLAG_REORDER = 'reorder' |
const | ACTION_FLAG_SHIP = 'ship' |
const | ACTION_FLAG_COMMENT = 'comment' |
const | REPORT_DATE_TYPE_CREATED = 'created' |
const | REPORT_DATE_TYPE_UPDATED = 'updated' |
![]() | |
const | CUSTOM_ATTRIBUTES = 'custom_attributes' |
![]() | |
const | EXTENSION_ATTRIBUTES_KEY = 'extension_attributes' |
![]() | |
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' |
Protected Member Functions | |
_construct () | |
_canVoidOrder () | |
_canReorder ($ignoreSalable=false) | |
_placePayment () | |
_getItemsRandomCollection ($limit, $nonChildrenOnly=false) | |
![]() | |
filterCustomAttributes ($data) | |
initializeCustomAttributes () | |
convertCustomAttributeValues (array &$customAttributes) | |
getCustomAttributesCodes () | |
_setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes) | |
_getExtensionAttributes () | |
![]() | |
_construct () | |
_init ($resourceModel) | |
_setResourceModel ($resourceName, $collectionName=null) | |
_getResource () | |
_getEventData () | |
_beforeLoad ($modelId, $field=null) | |
_afterLoad () | |
_hasModelChanged () | |
_getValidatorBeforeSave () | |
_createValidatorBeforeSave () | |
_getValidationRulesBeforeSave () | |
_clearReferences () | |
_clearData () | |
![]() | |
_getData ($key) | |
_underscore ($name) | |
Additional Inherited Members | |
![]() | |
static | $_underscoreCache = [] |
Order model
Supported events: sales_order_load_after sales_order_save_before sales_order_save_after sales_order_delete_before sales_order_delete_after
@api @method int getGiftMessageId() @method \Magento\Sales\Model\Order setGiftMessageId(int $value) @method bool hasBillingAddressId() @method \Magento\Sales\Model\Order unsBillingAddressId() @method bool hasShippingAddressId() @method \Magento\Sales\Model\Order unsShippingAddressId() @method int getShippigAddressId() @method bool hasCustomerNoteNotify() @method bool hasForcedCanCreditmemo() @method bool getIsInProcess() @method \Magento\Customer\Model\Customer getCustomer() @method \Magento\Sales\Model\Order setSendEmail(bool $value) @SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)
__construct | ( | \Magento\Framework\Model\Context | $context, |
\Magento\Framework\Registry | $registry, | ||
\Magento\Framework\Api\ExtensionAttributesFactory | $extensionFactory, | ||
AttributeValueFactory | $customAttributeFactory, | ||
\Magento\Framework\Stdlib\DateTime\TimezoneInterface | $timezone, | ||
\Magento\Store\Model\StoreManagerInterface | $storeManager, | ||
\Magento\Sales\Model\Order\Config | $orderConfig, | ||
\Magento\Catalog\Api\ProductRepositoryInterface | $productRepository, | ||
\Magento\Sales\Model\ResourceModel\Order\Item\CollectionFactory | $orderItemCollectionFactory, | ||
\Magento\Catalog\Model\Product\Visibility | $productVisibility, | ||
\Magento\Sales\Api\InvoiceManagementInterface | $invoiceManagement, | ||
\Magento\Directory\Model\CurrencyFactory | $currencyFactory, | ||
\Magento\Eav\Model\Config | $eavConfig, | ||
\Magento\Sales\Model\Order\Status\HistoryFactory | $orderHistoryFactory, | ||
\Magento\Sales\Model\ResourceModel\Order\Address\CollectionFactory | $addressCollectionFactory, | ||
\Magento\Sales\Model\ResourceModel\Order\Payment\CollectionFactory | $paymentCollectionFactory, | ||
\Magento\Sales\Model\ResourceModel\Order\Status\History\CollectionFactory | $historyCollectionFactory, | ||
\Magento\Sales\Model\ResourceModel\Order\Invoice\CollectionFactory | $invoiceCollectionFactory, | ||
\Magento\Sales\Model\ResourceModel\Order\Shipment\CollectionFactory | $shipmentCollectionFactory, | ||
\Magento\Sales\Model\ResourceModel\Order\Creditmemo\CollectionFactory | $memoCollectionFactory, | ||
\Magento\Sales\Model\ResourceModel\Order\Shipment\Track\CollectionFactory | $trackCollectionFactory, | ||
\Magento\Sales\Model\ResourceModel\Order\CollectionFactory | $salesOrderCollectionFactory, | ||
PriceCurrencyInterface | $priceCurrency, | ||
\Magento\Catalog\Model\ResourceModel\Product\CollectionFactory | $productListFactory, | ||
\Magento\Framework\Model\ResourceModel\AbstractResource | $resource = null , |
||
\Magento\Framework\Data\Collection\AbstractDb | $resourceCollection = null , |
||
array | $data = [] , |
||
ResolverInterface | $localeResolver = null |
||
) |
\Magento\Framework\Model\Context | $context | |
\Magento\Framework\Registry | $registry | |
\Magento\Framework\Api\ExtensionAttributesFactory | $extensionFactory | |
AttributeValueFactory | $customAttributeFactory | |
\Magento\Framework\Stdlib\DateTime\TimezoneInterface | $timezone | |
\Magento\Store\Model\StoreManagerInterface | $storeManager | |
Order\Config | $orderConfig | |
\Magento\Catalog\Api\ProductRepositoryInterface | $productRepository | |
\Magento\Sales\Model\ResourceModel\Order\Item\CollectionFactory | $orderItemCollectionFactory | |
\Magento\Catalog\Model\Product\Visibility | $productVisibility | |
\Magento\Sales\Api\InvoiceManagementInterface | $invoiceManagement | |
\Magento\Directory\Model\CurrencyFactory | $currencyFactory | |
\Magento\Eav\Model\Config | $eavConfig | |
Order\Status\HistoryFactory | $orderHistoryFactory | |
\Magento\Sales\Model\ResourceModel\Order\Address\CollectionFactory | $addressCollectionFactory | |
\Magento\Sales\Model\ResourceModel\Order\Payment\CollectionFactory | $paymentCollectionFactory | |
\Magento\Sales\Model\ResourceModel\Order\Status\History\CollectionFactory | $historyCollectionFactory | |
\Magento\Sales\Model\ResourceModel\Order\Invoice\CollectionFactory | $invoiceCollectionFactory | |
\Magento\Sales\Model\ResourceModel\Order\Shipment\CollectionFactory | $shipmentCollectionFactory | |
\Magento\Sales\Model\ResourceModel\Order\Creditmemo\CollectionFactory | $memoCollectionFactory | |
\Magento\Sales\Model\ResourceModel\Order\Shipment\Track\CollectionFactory | $trackCollectionFactory | |
ResourceModel\Order\CollectionFactory | $salesOrderCollectionFactory | |
PriceCurrencyInterface | $priceCurrency | |
\Magento\Catalog\Model\ResourceModel\Product\CollectionFactory | $productListFactory | |
\Magento\Framework\Model\ResourceModel\AbstractResource | $resource | |
\Magento\Framework\Data\Collection\AbstractDb | $resourceCollection | |
array | $data | |
ResolverInterface | $localeResolver | @SuppressWarnings(PHPMD.ExcessiveParameterList) |
Definition at line 313 of file Order.php.
|
protected |
Retrieve order reorder availability
bool | $ignoreSalable |
Definition at line 793 of file Order.php.
|
protected |
|
protected |
|
protected |
|
protected |
addAddress | ( | \Magento\Sales\Model\Order\Address | $address | ) |
Add address
\Magento\Sales\Model\Order\Address | $address |
Definition at line 1280 of file Order.php.
Add a comment to order status history.
Different or default status may be specified.
string | $comment | |
bool | string | $status | |
bool | $isVisibleOnFront |
Definition at line 1038 of file Order.php.
addItem | ( | \Magento\Sales\Model\Order\Item | $item | ) |
addRelatedObject | ( | \Magento\Framework\Model\AbstractModel | $object | ) |
addStatusHistory | ( | \Magento\Sales\Model\Order\Status\History | $history | ) |
Adds the object to the status history collection, which is automatically saved when the order is saved. See the entity_id attribute backend model. Or the history record can be saved standalone after this.
\Magento\Sales\Model\Order\Status\History | $history |
Definition at line 1588 of file Order.php.
addStatusHistoryComment | ( | $comment, | |
$status = false |
|||
) |
Add a comment to order.
Different or default status may be specified.
string | $comment | |
bool | string | $status |
Definition at line 1022 of file Order.php.
addStatusToHistory | ( | $status, | |
$comment = '' , |
|||
$isCustomerNotified = false |
|||
) |
Add status change information to history
string | $status | |
string | $comment | |
bool | $isCustomerNotified |
Definition at line 1005 of file Order.php.
canCancel | ( | ) |
Retrieve order cancel availability
Definition at line 530 of file Order.php.
cancel | ( | ) |
Cancel order
Definition at line 1137 of file Order.php.
canComment | ( | ) |
canCreditmemo | ( | ) |
Retrieve order credit memo (refund) availability
We can have problem with float in php (on some server $a=762.73;$b=762.73; $a-$b!=0) for this we have additional diapason for 0 TotalPaid - contains amount, that were not rounded.
Definition at line 619 of file Order.php.
canFetchPaymentReviewUpdate | ( | ) |
canInvoice | ( | ) |
canReorder | ( | ) |
canReorderIgnoreSalable | ( | ) |
canReviewPayment | ( | ) |
canShip | ( | ) |
canUnhold | ( | ) |
canVoidPayment | ( | ) |
formatBasePrice | ( | $price | ) |
Format BasePrice
float | $price |
Definition at line 1682 of file Order.php.
formatBasePricePrecision | ( | $price, | |
$precision | |||
) |
formatPrice | ( | $price, | |
$addBrackets = false |
|||
) |
Get formatted price value including order currency rate to order website currency
float | $price | |
bool | $addBrackets |
Definition at line 1634 of file Order.php.
formatPricePrecision | ( | $price, | |
$precision, | |||
$addBrackets = false |
|||
) |
formatPriceTxt | ( | $price | ) |
getActionFlag | ( | $action | ) |
getAddressById | ( | $addressId | ) |
getAddresses | ( | ) |
Get addresses
Definition at line 2044 of file Order.php.
getAddressesCollection | ( | ) |
getAdjustmentNegative | ( | ) |
Return adjustment_negative
Implements OrderInterface.
Definition at line 2099 of file Order.php.
getAdjustmentPositive | ( | ) |
Return adjustment_positive
Implements OrderInterface.
Definition at line 2109 of file Order.php.
getAllItems | ( | ) |
getAllStatusHistory | ( | ) |
Return array of order status history items without deleted.
Definition at line 1535 of file Order.php.
getAllVisibleItems | ( | ) |
getAppliedRuleIds | ( | ) |
Return applied_rule_ids
Implements OrderInterface.
Definition at line 2119 of file Order.php.
getBaseAdjustmentNegative | ( | ) |
Return base_adjustment_negative
Implements OrderInterface.
Definition at line 2129 of file Order.php.
getBaseAdjustmentPositive | ( | ) |
Return base_adjustment_positive
Implements OrderInterface.
Definition at line 2139 of file Order.php.
getBaseCurrency | ( | ) |
getBaseCurrencyCode | ( | ) |
Return base_currency_code
Implements OrderInterface.
Definition at line 2149 of file Order.php.
getBaseDiscountAmount | ( | ) |
Return base_discount_amount
Implements OrderInterface.
Definition at line 2159 of file Order.php.
getBaseDiscountCanceled | ( | ) |
Return base_discount_canceled
Implements OrderInterface.
Definition at line 2169 of file Order.php.
getBaseDiscountInvoiced | ( | ) |
Return base_discount_invoiced
Implements OrderInterface.
Definition at line 2179 of file Order.php.
getBaseDiscountRefunded | ( | ) |
Return base_discount_refunded
Implements OrderInterface.
Definition at line 2189 of file Order.php.
getBaseDiscountTaxCompensationAmount | ( | ) |
Return base_discount_tax_compensation_amount
Implements OrderInterface.
Definition at line 2209 of file Order.php.
getBaseDiscountTaxCompensationInvoiced | ( | ) |
Return base_discount_tax_compensation_invoiced
Implements OrderInterface.
Definition at line 2219 of file Order.php.
getBaseDiscountTaxCompensationRefunded | ( | ) |
Return base_discount_tax_compensation_refunded
Implements OrderInterface.
Definition at line 2229 of file Order.php.
getBaseGrandTotal | ( | ) |
Return base_grand_total
Implements OrderInterface.
Definition at line 2199 of file Order.php.
getBaseShippingAmount | ( | ) |
Return base_shipping_amount
Implements OrderInterface.
Definition at line 2239 of file Order.php.
getBaseShippingCanceled | ( | ) |
Return base_shipping_canceled
Implements OrderInterface.
Definition at line 2249 of file Order.php.
getBaseShippingDiscountAmount | ( | ) |
Return base_shipping_discount_amount
Implements OrderInterface.
Definition at line 2259 of file Order.php.
getBaseShippingDiscountTaxCompensationAmnt | ( | ) |
Return base_shipping_discount_tax_compensation_amnt
Implements OrderInterface.
Definition at line 2269 of file Order.php.
getBaseShippingInclTax | ( | ) |
Return base_shipping_incl_tax
Implements OrderInterface.
Definition at line 2279 of file Order.php.
getBaseShippingInvoiced | ( | ) |
Return base_shipping_invoiced
Implements OrderInterface.
Definition at line 2289 of file Order.php.
getBaseShippingRefunded | ( | ) |
Return base_shipping_refunded
Implements OrderInterface.
Definition at line 2299 of file Order.php.
getBaseShippingTaxAmount | ( | ) |
Return base_shipping_tax_amount
Implements OrderInterface.
Definition at line 2309 of file Order.php.
getBaseShippingTaxRefunded | ( | ) |
Return base_shipping_tax_refunded
Implements OrderInterface.
Definition at line 2319 of file Order.php.
getBaseSubtotal | ( | ) |
Return base_subtotal
Implements OrderInterface.
Definition at line 2329 of file Order.php.
getBaseSubtotalCanceled | ( | ) |
Return base_subtotal_canceled
Implements OrderInterface.
Definition at line 2339 of file Order.php.
getBaseSubtotalInclTax | ( | ) |
Return base_subtotal_incl_tax
Implements OrderInterface.
Definition at line 2349 of file Order.php.
getBaseSubtotalInvoiced | ( | ) |
Return base_subtotal_invoiced
Implements OrderInterface.
Definition at line 2359 of file Order.php.
getBaseSubtotalRefunded | ( | ) |
Return base_subtotal_refunded
Implements OrderInterface.
Definition at line 2369 of file Order.php.
getBaseTaxAmount | ( | ) |
Return base_tax_amount
Implements OrderInterface.
Definition at line 2379 of file Order.php.
getBaseTaxCanceled | ( | ) |
Return base_tax_canceled
Implements OrderInterface.
Definition at line 2389 of file Order.php.
getBaseTaxInvoiced | ( | ) |
Return base_tax_invoiced
Implements OrderInterface.
Definition at line 2399 of file Order.php.
getBaseTaxRefunded | ( | ) |
Return base_tax_refunded
Implements OrderInterface.
Definition at line 2409 of file Order.php.
getBaseToGlobalRate | ( | ) |
Return base_to_global_rate
Implements OrderInterface.
Definition at line 2499 of file Order.php.
getBaseToOrderRate | ( | ) |
Return base_to_order_rate
Implements OrderInterface.
Definition at line 2509 of file Order.php.
getBaseTotalCanceled | ( | ) |
Return base_total_canceled
Implements OrderInterface.
Definition at line 2419 of file Order.php.
getBaseTotalDue | ( | ) |
Retrieve order total due value
Implements OrderInterface.
Definition at line 1726 of file Order.php.
getBaseTotalInvoiced | ( | ) |
Return base_total_invoiced
Implements OrderInterface.
Definition at line 2429 of file Order.php.
getBaseTotalInvoicedCost | ( | ) |
Return base_total_invoiced_cost
Implements OrderInterface.
Definition at line 2439 of file Order.php.
getBaseTotalOfflineRefunded | ( | ) |
Return base_total_offline_refunded
Implements OrderInterface.
Definition at line 2449 of file Order.php.
getBaseTotalOnlineRefunded | ( | ) |
Return base_total_online_refunded
Implements OrderInterface.
Definition at line 2459 of file Order.php.
getBaseTotalPaid | ( | ) |
Return base_total_paid
Implements OrderInterface.
Definition at line 2469 of file Order.php.
getBaseTotalQtyOrdered | ( | ) |
Return base_total_qty_ordered
Implements OrderInterface.
Definition at line 2479 of file Order.php.
getBaseTotalRefunded | ( | ) |
Return base_total_refunded
Implements OrderInterface.
Definition at line 2489 of file Order.php.
getBillingAddress | ( | ) |
Retrieve order billing address
Implements OrderInterface.
Definition at line 951 of file Order.php.
getBillingAddressId | ( | ) |
Return billing_address_id
Implements OrderInterface.
Definition at line 2519 of file Order.php.
getCanSendNewEmailFlag | ( | ) |
getCanShipPartially | ( | ) |
Return can_ship_partially
Implements OrderInterface.
Definition at line 2529 of file Order.php.
getCanShipPartiallyItem | ( | ) |
Return can_ship_partially_item
Implements OrderInterface.
Definition at line 2539 of file Order.php.
getConfig | ( | ) |
getCouponCode | ( | ) |
Return coupon_code
Implements OrderInterface.
Definition at line 2549 of file Order.php.
getCreatedAt | ( | ) |
Return created_at
Implements OrderInterface.
Definition at line 2559 of file Order.php.
getCreatedAtFormatted | ( | $format | ) |
getCreditmemosCollection | ( | ) |
getCustomerDob | ( | ) |
Return customer_dob
Implements OrderInterface.
Definition at line 2577 of file Order.php.
getCustomerEmail | ( | ) |
Return customer_email
Implements OrderInterface.
Definition at line 2587 of file Order.php.
getCustomerFirstname | ( | ) |
Return customer_firstname
Implements OrderInterface.
Definition at line 2597 of file Order.php.
getCustomerGender | ( | ) |
Return customer_gender
Implements OrderInterface.
Definition at line 2607 of file Order.php.
getCustomerGroupId | ( | ) |
Return customer_group_id
Implements OrderInterface.
Definition at line 2617 of file Order.php.
getCustomerId | ( | ) |
Return customer_id
Implements OrderInterface.
Definition at line 2627 of file Order.php.
getCustomerIsGuest | ( | ) |
Return customer_is_guest
Implements OrderInterface.
Definition at line 2637 of file Order.php.
getCustomerLastname | ( | ) |
Return customer_lastname
Implements OrderInterface.
Definition at line 2647 of file Order.php.
getCustomerMiddlename | ( | ) |
Return customer_middlename
Implements OrderInterface.
Definition at line 2657 of file Order.php.
getCustomerNote | ( | ) |
Return customer_note
Implements OrderInterface.
Definition at line 2667 of file Order.php.
getCustomerNoteNotify | ( | ) |
Return customer_note_notify
Implements OrderInterface.
Definition at line 2677 of file Order.php.
getCustomerPrefix | ( | ) |
Return customer_prefix
Implements OrderInterface.
Definition at line 2687 of file Order.php.
getCustomerSuffix | ( | ) |
Return customer_suffix
Implements OrderInterface.
Definition at line 2697 of file Order.php.
getCustomerTaxvat | ( | ) |
Return customer_taxvat
Implements OrderInterface.
Definition at line 2707 of file Order.php.
getData | ( | $key = '' , |
|
$index = null |
|||
) |
getDiscountAmount | ( | ) |
Return discount_amount
Implements OrderInterface.
Definition at line 2717 of file Order.php.
getDiscountCanceled | ( | ) |
Return discount_canceled
Implements OrderInterface.
Definition at line 2727 of file Order.php.
getDiscountDescription | ( | ) |
Return discount_description
Implements OrderInterface.
Definition at line 2737 of file Order.php.
getDiscountInvoiced | ( | ) |
Return discount_invoiced
Implements OrderInterface.
Definition at line 2747 of file Order.php.
getDiscountRefunded | ( | ) |
Return discount_refunded
Implements OrderInterface.
Definition at line 2757 of file Order.php.
getDiscountTaxCompensationAmount | ( | ) |
Return discount_tax_compensation_amount
Implements OrderInterface.
Definition at line 2837 of file Order.php.
getDiscountTaxCompensationInvoiced | ( | ) |
Return discount_tax_compensation_invoiced
Implements OrderInterface.
Definition at line 2847 of file Order.php.
getDiscountTaxCompensationRefunded | ( | ) |
Return discount_tax_compensation_refunded
Implements OrderInterface.
Definition at line 2857 of file Order.php.
getEditIncrement | ( | ) |
Return edit_increment
Implements OrderInterface.
Definition at line 2767 of file Order.php.
getEmailCustomerNote | ( | ) |
getEmailSent | ( | ) |
Return email_sent
Implements OrderInterface.
Definition at line 2777 of file Order.php.
getExtCustomerId | ( | ) |
Return ext_customer_id
Implements OrderInterface.
Definition at line 2787 of file Order.php.
getExtensionAttributes | ( | ) |
Get ExtensionAttributes
Implements OrderInterface.
Definition at line 2076 of file Order.php.
getExtOrderId | ( | ) |
Return ext_order_id
Implements OrderInterface.
Definition at line 2797 of file Order.php.
getForcedShipmentWithInvoice | ( | ) |
Return forced_shipment_with_invoice
Implements OrderInterface.
Definition at line 2807 of file Order.php.
getGlobalCurrencyCode | ( | ) |
Return global_currency_code
Implements OrderInterface.
Definition at line 2817 of file Order.php.
getGrandTotal | ( | ) |
Return grand_total
Implements OrderInterface.
Definition at line 2827 of file Order.php.
getHoldBeforeState | ( | ) |
Return hold_before_state
Implements OrderInterface.
Definition at line 2867 of file Order.php.
getHoldBeforeStatus | ( | ) |
Return hold_before_status
Implements OrderInterface.
Definition at line 2877 of file Order.php.
getIncrementId | ( | ) |
Return increment id
@codeCoverageIgnore
Implements OrderInterface.
Definition at line 2009 of file Order.php.
getInvoiceCollection | ( | ) |
getIsNotVirtual | ( | ) |
getIsVirtual | ( | ) |
Return is_virtual
Implements OrderInterface.
Definition at line 2887 of file Order.php.
getItemById | ( | $itemId | ) |
getItemByQuoteItemId | ( | $quoteItemId | ) |
getItems | ( | ) |
Get Items
Implements OrderInterface.
Definition at line 2019 of file Order.php.
getItemsCollection | ( | $filterByTypes = [] , |
|
$nonChildrenOnly = false |
|||
) |
getOrderCurrency | ( | ) |
getOrderCurrencyCode | ( | ) |
Return order_currency_code
Implements OrderInterface.
Definition at line 2897 of file Order.php.
getOriginalIncrementId | ( | ) |
Return original_increment_id
Implements OrderInterface.
Definition at line 2907 of file Order.php.
getParentItemsRandomCollection | ( | $limit = 1 | ) |
Get random items collection without related children
int | $limit |
Definition at line 1322 of file Order.php.
getPayment | ( | ) |
Gets order payment
Implements OrderInterface.
Definition at line 887 of file Order.php.
getPaymentAuthExpiration | ( | ) |
Return payment_auth_expiration
Implements OrderInterface.
Definition at line 2927 of file Order.php.
getPaymentAuthorizationAmount | ( | ) |
Return payment_authorization_amount
Implements OrderInterface.
Definition at line 2917 of file Order.php.
getPaymentById | ( | $paymentId | ) |
getPaymentsCollection | ( | ) |
getProtectCode | ( | ) |
Return protect_code
Implements OrderInterface.
Definition at line 2937 of file Order.php.
getQuoteAddressId | ( | ) |
Return quote_address_id
Implements OrderInterface.
Definition at line 2947 of file Order.php.
getQuoteId | ( | ) |
Return quote_id
Implements OrderInterface.
Definition at line 2957 of file Order.php.
getRelatedObjects | ( | ) |
getRelationChildId | ( | ) |
Return relation_child_id
Implements OrderInterface.
Definition at line 2967 of file Order.php.
getRelationChildRealId | ( | ) |
Return relation_child_real_id
Implements OrderInterface.
Definition at line 2977 of file Order.php.
getRelationParentId | ( | ) |
Return relation_parent_id
Implements OrderInterface.
Definition at line 2987 of file Order.php.
getRelationParentRealId | ( | ) |
Return relation_parent_real_id
Implements OrderInterface.
Definition at line 2997 of file Order.php.
getRemoteIp | ( | ) |
Return remote_ip
Implements OrderInterface.
Definition at line 3007 of file Order.php.
getShipmentsCollection | ( | ) |
getShippingAddress | ( | ) |
getShippingAmount | ( | ) |
Return shipping_amount
Implements OrderInterface.
Definition at line 3017 of file Order.php.
getShippingCanceled | ( | ) |
Return shipping_canceled
Implements OrderInterface.
Definition at line 3027 of file Order.php.
getShippingDescription | ( | ) |
Return shipping_description
Implements OrderInterface.
Definition at line 3037 of file Order.php.
getShippingDiscountAmount | ( | ) |
Return shipping_discount_amount
Implements OrderInterface.
Definition at line 3047 of file Order.php.
getShippingDiscountTaxCompensationAmount | ( | ) |
Return shipping_discount_tax_compensation_amount
Implements OrderInterface.
Definition at line 3057 of file Order.php.
getShippingInclTax | ( | ) |
Return shipping_incl_tax
Implements OrderInterface.
Definition at line 3067 of file Order.php.
getShippingInvoiced | ( | ) |
Return shipping_invoiced
Implements OrderInterface.
Definition at line 3077 of file Order.php.
getShippingMethod | ( | $asObject = false | ) |
getShippingRefunded | ( | ) |
Return shipping_refunded
Implements OrderInterface.
Definition at line 3087 of file Order.php.
getShippingTaxAmount | ( | ) |
Return shipping_tax_amount
Implements OrderInterface.
Definition at line 3097 of file Order.php.
getShippingTaxRefunded | ( | ) |
Return shipping_tax_refunded
Implements OrderInterface.
Definition at line 3107 of file Order.php.
getState | ( | ) |
Return state
Implements OrderInterface.
Definition at line 3117 of file Order.php.
getStatus | ( | ) |
Return status
Implements OrderInterface.
Definition at line 3127 of file Order.php.
getStatusHistories | ( | ) |
Get status History
Implements OrderInterface.
Definition at line 2060 of file Order.php.
getStatusHistoryById | ( | $statusId | ) |
GetStatus history by id
mixed | $statusId |
Definition at line 1568 of file Order.php.
getStatusHistoryCollection | ( | ) |
getStatusLabel | ( | ) |
getStore | ( | ) |
getStoreCurrencyCode | ( | ) |
Return store_currency_code
Implements OrderInterface.
Definition at line 3137 of file Order.php.
getStoreId | ( | ) |
Return store_id
Implements OrderInterface.
Definition at line 3147 of file Order.php.
getStoreName | ( | ) |
Return store_name
Implements OrderInterface.
Definition at line 3157 of file Order.php.
getStoreToBaseRate | ( | ) |
Return store_to_base_rate
Implements OrderInterface.
Definition at line 3167 of file Order.php.
getStoreToOrderRate | ( | ) |
Return store_to_order_rate
Implements OrderInterface.
Definition at line 3177 of file Order.php.
getSubtotal | ( | ) |
Return subtotal
Implements OrderInterface.
Definition at line 3187 of file Order.php.
getSubtotalCanceled | ( | ) |
Return subtotal_canceled
Implements OrderInterface.
Definition at line 3197 of file Order.php.
getSubtotalInclTax | ( | ) |
Return subtotal_incl_tax
Implements OrderInterface.
Definition at line 3207 of file Order.php.
getSubtotalInvoiced | ( | ) |
Return subtotal_invoiced
Implements OrderInterface.
Definition at line 3217 of file Order.php.
getSubtotalRefunded | ( | ) |
Return subtotal_refunded
Implements OrderInterface.
Definition at line 3227 of file Order.php.
getTaxAmount | ( | ) |
Return tax_amount
Implements OrderInterface.
Definition at line 3237 of file Order.php.
getTaxCanceled | ( | ) |
Return tax_canceled
Implements OrderInterface.
Definition at line 3247 of file Order.php.
getTaxInvoiced | ( | ) |
Return tax_invoiced
Implements OrderInterface.
Definition at line 3257 of file Order.php.
getTaxRefunded | ( | ) |
Return tax_refunded
Implements OrderInterface.
Definition at line 3267 of file Order.php.
getTotalCanceled | ( | ) |
Return total_canceled
Implements OrderInterface.
Definition at line 3277 of file Order.php.
getTotalDue | ( | ) |
Retrieve order total due value
Implements OrderInterface.
Definition at line 1714 of file Order.php.
getTotalInvoiced | ( | ) |
Return total_invoiced
Implements OrderInterface.
Definition at line 3287 of file Order.php.
getTotalItemCount | ( | ) |
Return total_item_count
Implements OrderInterface.
Definition at line 3297 of file Order.php.
getTotalOfflineRefunded | ( | ) |
Return total_offline_refunded
Implements OrderInterface.
Definition at line 3307 of file Order.php.
getTotalOnlineRefunded | ( | ) |
Return total_online_refunded
Implements OrderInterface.
Definition at line 3317 of file Order.php.
getTotalPaid | ( | ) |
Return total_paid
Implements OrderInterface.
Definition at line 3327 of file Order.php.
getTotalQtyOrdered | ( | ) |
Return total_qty_ordered
Implements OrderInterface.
Definition at line 3337 of file Order.php.
getTotalRefunded | ( | ) |
Return total_refunded
Implements OrderInterface.
Definition at line 3347 of file Order.php.
getTrackingNumbers | ( | ) |
getTracksCollection | ( | ) |
getUpdatedAt | ( | ) |
Return updated_at
Implements OrderInterface.
Definition at line 3357 of file Order.php.
getVisibleStatusHistory | ( | ) |
Return collection of visible on frontend order status history items.
Definition at line 1551 of file Order.php.
getWeight | ( | ) |
Return weight
Implements OrderInterface.
Definition at line 3367 of file Order.php.
getXForwardedFor | ( | ) |
Return x_forwarded_for
Implements OrderInterface.
Definition at line 3377 of file Order.php.
hasCreditmemos | ( | ) |
Check order creditmemos availability
Definition at line 1858 of file Order.php.
hasInvoices | ( | ) |
hasShipments | ( | ) |
hold | ( | ) |
Hold
Definition at line 1101 of file Order.php.
isCanceled | ( | ) |
isCurrencyDifferent | ( | ) |
isFraudDetected | ( | ) |
Is order status in DB "Fraud detected"
Definition at line 1154 of file Order.php.
isPaymentReview | ( | ) |
loadByAttribute | ( | $attribute, | |
$value | |||
) |
Load order by custom attribute value. Attribute value should be unique
string | $attribute | |
string | $value |
Definition at line 503 of file Order.php.
loadByIncrementId | ( | $incrementId | ) |
Load order by system increment identifier
string | $incrementId |
Definition at line 457 of file Order.php.
loadByIncrementIdAndStoreId | ( | $incrementId, | |
$storeId | |||
) |
prepareInvoice | ( | $qtys = [] | ) |
registerCancellation | ( | $comment = '' , |
|
$graceful = true |
|||
) |
Prepare order totals to cancellation
string | $comment | |
bool | $graceful |
Definition at line 1169 of file Order.php.
reset | ( | ) |
Reset all data in object so after another load it will be complete new object.
Definition at line 1951 of file Order.php.
setActionFlag | ( | $action, | |
$flag | |||
) |
setAdjustmentNegative | ( | $adjustmentNegative | ) |
Sets the negative adjustment value for the order.
float | $adjustmentNegative |
Implements OrderInterface.
Definition at line 4001 of file Order.php.
setAdjustmentPositive | ( | $adjustmentPositive | ) |
Sets the positive adjustment value for the order.
float | $adjustmentPositive |
Implements OrderInterface.
Definition at line 4009 of file Order.php.
setAppliedRuleIds | ( | $appliedRuleIds | ) |
Sets the applied rule IDs for the order.
string | $appliedRuleIds |
Implements OrderInterface.
Definition at line 4113 of file Order.php.
setBaseAdjustmentNegative | ( | $baseAdjustmentNegative | ) |
Sets the base negative adjustment value for the order.
float | $baseAdjustmentNegative |
Implements OrderInterface.
Definition at line 4017 of file Order.php.
setBaseAdjustmentPositive | ( | $baseAdjustmentPositive | ) |
Sets the base positive adjustment value for the order.
float | $baseAdjustmentPositive |
Implements OrderInterface.
Definition at line 4025 of file Order.php.
setBaseCurrencyCode | ( | $code | ) |
Sets the base currency code for the order.
string | $code |
Implements OrderInterface.
Definition at line 4121 of file Order.php.
setBaseDiscountAmount | ( | $amount | ) |
Sets the base discount amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 3449 of file Order.php.
setBaseDiscountCanceled | ( | $baseDiscountCanceled | ) |
Sets the base discount canceled for the order.
float | $baseDiscountCanceled |
Implements OrderInterface.
Definition at line 3457 of file Order.php.
setBaseDiscountInvoiced | ( | $baseDiscountInvoiced | ) |
Sets the base discount invoiced amount for the order.
float | $baseDiscountInvoiced |
Implements OrderInterface.
Definition at line 3465 of file Order.php.
setBaseDiscountRefunded | ( | $baseDiscountRefunded | ) |
Sets the base discount refunded amount for the order.
float | $baseDiscountRefunded |
Implements OrderInterface.
Definition at line 3473 of file Order.php.
setBaseDiscountTaxCompensationAmount | ( | $amount | ) |
Sets the base discount tax compensation amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 4353 of file Order.php.
setBaseDiscountTaxCompensationInvoiced | ( | $baseDiscountTaxCompensationInvoiced | ) |
Sets the base discount tax compensation invoiced amount for the order.
float | $baseDiscountTaxCompensationInvoiced |
Implements OrderInterface.
Definition at line 4385 of file Order.php.
setBaseDiscountTaxCompensationRefunded | ( | $baseDiscountTaxCompensationRefunded | ) |
Sets the base discount tax compensation refunded amount for the order.
float | $baseDiscountTaxCompensationRefunded |
Implements OrderInterface.
Definition at line 4407 of file Order.php.
setBaseGrandTotal | ( | $amount | ) |
Sets the base grand total for the order.
float | $amount |
Implements OrderInterface.
Definition at line 3481 of file Order.php.
setBaseShippingAmount | ( | $amount | ) |
Sets the base shipping amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 3489 of file Order.php.
setBaseShippingCanceled | ( | $baseShippingCanceled | ) |
Sets the base shipping canceled for the order.
float | $baseShippingCanceled |
Implements OrderInterface.
Definition at line 3497 of file Order.php.
setBaseShippingDiscountAmount | ( | $amount | ) |
Sets the base shipping discount amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 4033 of file Order.php.
setBaseShippingDiscountTaxCompensationAmnt | ( | $amnt | ) |
Sets the base shipping discount tax compensation amount for the order.
float | $amnt |
Implements OrderInterface.
Definition at line 4369 of file Order.php.
setBaseShippingInclTax | ( | $amount | ) |
Sets the base shipping including tax for the order.
float | $amount |
Implements OrderInterface.
Definition at line 4426 of file Order.php.
setBaseShippingInvoiced | ( | $baseShippingInvoiced | ) |
Sets the base shipping invoiced amount for the order.
float | $baseShippingInvoiced |
Implements OrderInterface.
Definition at line 3505 of file Order.php.
setBaseShippingRefunded | ( | $baseShippingRefunded | ) |
Sets the base shipping refunded amount for the order.
float | $baseShippingRefunded |
Implements OrderInterface.
Definition at line 3513 of file Order.php.
setBaseShippingTaxAmount | ( | $amount | ) |
Sets the base shipping tax amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 3521 of file Order.php.
setBaseShippingTaxRefunded | ( | $baseShippingTaxRefunded | ) |
Sets the base shipping tax refunded amount for the order.
float | $baseShippingTaxRefunded |
Implements OrderInterface.
Definition at line 3529 of file Order.php.
setBaseSubtotal | ( | $amount | ) |
Sets the base subtotal for the order.
float | $amount |
Implements OrderInterface.
Definition at line 3537 of file Order.php.
setBaseSubtotalCanceled | ( | $baseSubtotalCanceled | ) |
Sets the base subtotal canceled for the order.
float | $baseSubtotalCanceled |
Implements OrderInterface.
Definition at line 3545 of file Order.php.
setBaseSubtotalInclTax | ( | $amount | ) |
Sets the base subtotal including tax for the order.
float | $amount |
Implements OrderInterface.
Definition at line 4041 of file Order.php.
setBaseSubtotalInvoiced | ( | $baseSubtotalInvoiced | ) |
Sets the base subtotal invoiced amount for the order.
float | $baseSubtotalInvoiced |
Implements OrderInterface.
Definition at line 3553 of file Order.php.
setBaseSubtotalRefunded | ( | $baseSubtotalRefunded | ) |
Sets the base subtotal refunded amount for the order.
float | $baseSubtotalRefunded |
Implements OrderInterface.
Definition at line 3561 of file Order.php.
setBaseTaxAmount | ( | $amount | ) |
Sets the base tax amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 3569 of file Order.php.
setBaseTaxCanceled | ( | $baseTaxCanceled | ) |
Sets the base tax canceled for the order.
float | $baseTaxCanceled |
Implements OrderInterface.
Definition at line 3577 of file Order.php.
setBaseTaxInvoiced | ( | $baseTaxInvoiced | ) |
Sets the base tax invoiced amount for the order.
float | $baseTaxInvoiced |
Implements OrderInterface.
Definition at line 3585 of file Order.php.
setBaseTaxRefunded | ( | $baseTaxRefunded | ) |
Sets the base tax refunded amount for the order.
float | $baseTaxRefunded |
Implements OrderInterface.
Definition at line 3593 of file Order.php.
setBaseToGlobalRate | ( | $rate | ) |
Sets the base-to-global rate for the order.
float | $rate |
Implements OrderInterface.
Definition at line 3601 of file Order.php.
setBaseToOrderRate | ( | $rate | ) |
Sets the base-to-order rate for the order.
float | $rate |
Implements OrderInterface.
Definition at line 3609 of file Order.php.
setBaseTotalCanceled | ( | $baseTotalCanceled | ) |
Sets the base total canceled for the order.
float | $baseTotalCanceled |
Implements OrderInterface.
Definition at line 3617 of file Order.php.
setBaseTotalDue | ( | $baseTotalDue | ) |
Sets the base total due for the order.
float | $baseTotalDue |
Implements OrderInterface.
Definition at line 4049 of file Order.php.
setBaseTotalInvoiced | ( | $baseTotalInvoiced | ) |
Sets the base total invoiced amount for the order.
float | $baseTotalInvoiced |
Implements OrderInterface.
Definition at line 3625 of file Order.php.
setBaseTotalInvoicedCost | ( | $baseTotalInvoicedCost | ) |
Sets the base total invoiced cost for the order.
float | $baseTotalInvoicedCost |
Implements OrderInterface.
Definition at line 3633 of file Order.php.
setBaseTotalOfflineRefunded | ( | $baseTotalOfflineRefunded | ) |
Sets the base total offline refunded amount for the order.
float | $baseTotalOfflineRefunded |
Implements OrderInterface.
Definition at line 3641 of file Order.php.
setBaseTotalOnlineRefunded | ( | $baseTotalOnlineRefunded | ) |
Sets the base total online refunded amount for the order.
float | $baseTotalOnlineRefunded |
Implements OrderInterface.
Definition at line 3649 of file Order.php.
setBaseTotalPaid | ( | $baseTotalPaid | ) |
Sets the base total paid for the order.
float | $baseTotalPaid |
Implements OrderInterface.
Definition at line 3657 of file Order.php.
setBaseTotalQtyOrdered | ( | $baseTotalQtyOrdered | ) |
Sets the base total quantity ordered for the order.
float | $baseTotalQtyOrdered |
Implements OrderInterface.
Definition at line 3665 of file Order.php.
setBaseTotalRefunded | ( | $baseTotalRefunded | ) |
Sets the base total refunded amount for the order.
float | $baseTotalRefunded |
Implements OrderInterface.
Definition at line 3673 of file Order.php.
setBillingAddress | ( | \Magento\Sales\Api\Data\OrderAddressInterface | $address = null | ) |
Sets the billing address, if any, for the order.
\Magento\Sales\Api\Data\OrderAddressInterface | $address |
Definition at line 912 of file Order.php.
setBillingAddressId | ( | $id | ) |
Sets the billing address ID for the order.
int | $id |
Implements OrderInterface.
Definition at line 3937 of file Order.php.
setCanSendNewEmailFlag | ( | $flag | ) |
setCanShipPartially | ( | $flag | ) |
Sets the can-ship-partially flag value for the order.
int | $flag |
Implements OrderInterface.
Definition at line 3905 of file Order.php.
setCanShipPartiallyItem | ( | $flag | ) |
Sets the can-ship-partially-item flag value for the order.
int | $flag |
Implements OrderInterface.
Definition at line 3913 of file Order.php.
setCouponCode | ( | $code | ) |
Sets the coupon code for the order.
string | $code |
Implements OrderInterface.
Definition at line 3401 of file Order.php.
setCreatedAt | ( | $createdAt | ) |
Sets the created-at timestamp for the order.
string | $createdAt | timestamp |
Implements OrderInterface.
Definition at line 2567 of file Order.php.
setCustomerDob | ( | $customerDob | ) |
Sets the customer date-of-birth (DOB) for the order.
string | $customerDob |
Implements OrderInterface.
Definition at line 4097 of file Order.php.
setCustomerEmail | ( | $customerEmail | ) |
Sets the customer email address for the order.
string | $customerEmail |
Implements OrderInterface.
Definition at line 4129 of file Order.php.
setCustomerFirstname | ( | $customerFirstname | ) |
Sets the customer first name for the order.
string | $customerFirstname |
Implements OrderInterface.
Definition at line 4137 of file Order.php.
setCustomerGender | ( | $customerGender | ) |
Sets the customer gender for the order.
int | $customerGender |
Implements OrderInterface.
Definition at line 4337 of file Order.php.
setCustomerGroupId | ( | $id | ) |
Sets the customer group ID for the order.
int | $id |
Implements OrderInterface.
Definition at line 3945 of file Order.php.
setCustomerId | ( | $id | ) |
Sets the customer ID for the order.
int | $id |
Implements OrderInterface.
Definition at line 3441 of file Order.php.
setCustomerIsGuest | ( | $customerIsGuest | ) |
Sets the customer-is-guest flag value for the order.
int | $customerIsGuest |
Implements OrderInterface.
Definition at line 3921 of file Order.php.
setCustomerLastname | ( | $customerLastname | ) |
Sets the customer last name for the order.
string | $customerLastname |
Implements OrderInterface.
Definition at line 4145 of file Order.php.
setCustomerMiddlename | ( | $customerMiddlename | ) |
Sets the customer middle name for the order.
string | $customerMiddlename |
Implements OrderInterface.
Definition at line 4153 of file Order.php.
setCustomerNote | ( | $customerNote | ) |
Sets the customer note for the order.
string | $customerNote |
Implements OrderInterface.
Definition at line 4313 of file Order.php.
setCustomerNoteNotify | ( | $customerNoteNotify | ) |
Sets the customer-note-notify flag value for the order.
int | $customerNoteNotify |
Implements OrderInterface.
Definition at line 3929 of file Order.php.
setCustomerPrefix | ( | $customerPrefix | ) |
Sets the customer prefix for the order.
string | $customerPrefix |
Implements OrderInterface.
Definition at line 4161 of file Order.php.
setCustomerSuffix | ( | $customerSuffix | ) |
Sets the customer suffix for the order.
string | $customerSuffix |
Implements OrderInterface.
Definition at line 4169 of file Order.php.
setCustomerTaxvat | ( | $customerTaxvat | ) |
Sets the customer value-added tax (VAT) for the order.
string | $customerTaxvat |
Implements OrderInterface.
Definition at line 4177 of file Order.php.
setDiscountAmount | ( | $amount | ) |
Sets the discount amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 3681 of file Order.php.
setDiscountCanceled | ( | $discountCanceled | ) |
Sets the discount canceled for the order.
float | $discountCanceled |
Implements OrderInterface.
Definition at line 3689 of file Order.php.
setDiscountDescription | ( | $description | ) |
Sets the discount description for the order.
string | $description |
Implements OrderInterface.
Definition at line 4185 of file Order.php.
setDiscountInvoiced | ( | $discountInvoiced | ) |
Sets the discount invoiced amount for the order.
float | $discountInvoiced |
Implements OrderInterface.
Definition at line 3697 of file Order.php.
setDiscountRefunded | ( | $discountRefunded | ) |
Sets the discount refunded amount for the order.
float | $discountRefunded |
Implements OrderInterface.
Definition at line 3705 of file Order.php.
setDiscountTaxCompensationAmount | ( | $amount | ) |
Sets the discount tax compensation amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 4345 of file Order.php.
setDiscountTaxCompensationInvoiced | ( | $discountTaxCompensationInvoiced | ) |
Sets the discount tax compensation invoiced amount for the order.
float | $discountTaxCompensationInvoiced |
Implements OrderInterface.
Definition at line 4377 of file Order.php.
setDiscountTaxCompensationRefunded | ( | $discountTaxCompensationRefunded | ) |
Sets the discount tax compensation refunded amount for the order.
float | $discountTaxCompensationRefunded |
Implements OrderInterface.
Definition at line 4396 of file Order.php.
setEditIncrement | ( | $editIncrement | ) |
Sets the edit increment value for the order.
int | $editIncrement |
Implements OrderInterface.
Definition at line 3953 of file Order.php.
setEmailSent | ( | $emailSent | ) |
Sets the email-sent flag value for the order.
int | $emailSent |
Implements OrderInterface.
Definition at line 3961 of file Order.php.
setExtCustomerId | ( | $id | ) |
Sets the external customer ID for the order.
string | $id |
Implements OrderInterface.
Definition at line 4193 of file Order.php.
setExtensionAttributes | ( | \Magento\Sales\Api\Data\OrderExtensionInterface | $extensionAttributes | ) |
Set an extension attributes object.
\Magento\Sales\Api\Data\OrderExtensionInterface | $extensionAttributes |
\Magento\Sales\Api\Data\OrderExtensionInterface | $extensionAttributes |
Implements OrderInterface.
Definition at line 2087 of file Order.php.
setExtOrderId | ( | $id | ) |
Sets the external order ID for the order.
string | $id |
Implements OrderInterface.
Definition at line 4201 of file Order.php.
setForcedShipmentWithInvoice | ( | $forcedShipmentWithInvoice | ) |
Sets the forced-shipment-with-invoice flag value for the order.
int | $forcedShipmentWithInvoice |
Implements OrderInterface.
Definition at line 3969 of file Order.php.
setGlobalCurrencyCode | ( | $code | ) |
Sets the global currency code for the order.
string | $code |
Implements OrderInterface.
Definition at line 4209 of file Order.php.
setGrandTotal | ( | $amount | ) |
Sets the grand total for the order.
float | $amount |
Implements OrderInterface.
Definition at line 3713 of file Order.php.
setHistoryEntityName | ( | $entityName | ) |
setHoldBeforeState | ( | $holdBeforeState | ) |
Sets the hold before state for the order.
string | $holdBeforeState |
Implements OrderInterface.
Definition at line 4217 of file Order.php.
setHoldBeforeStatus | ( | $holdBeforeStatus | ) |
Sets the hold before status for the order.
string | $holdBeforeStatus |
Implements OrderInterface.
Definition at line 4225 of file Order.php.
setIncrementId | ( | $id | ) |
Sets the increment ID for the order.
string | $id |
Implements OrderInterface.
Definition at line 4105 of file Order.php.
setInvoiceCollection | ( | InvoiceCollection | $invoices | ) |
setIsVirtual | ( | $isVirtual | ) |
Sets the is-virtual flag value for the order.
int | $isVirtual |
Implements OrderInterface.
Definition at line 3425 of file Order.php.
setItems | ( | $items | ) |
Sets items for the order.
Implements OrderInterface.
Definition at line 2034 of file Order.php.
setOrderCurrencyCode | ( | $code | ) |
Sets the order currency code for the order.
string | $code |
Implements OrderInterface.
Definition at line 4233 of file Order.php.
setOriginalIncrementId | ( | $id | ) |
Sets the original increment ID for the order.
string | $id |
Implements OrderInterface.
Definition at line 4241 of file Order.php.
setPayment | ( | \Magento\Sales\Api\Data\OrderPaymentInterface | $payment = null | ) |
Definition at line 1498 of file Order.php.
setPaymentAuthExpiration | ( | $paymentAuthExpiration | ) |
Sets the payment authorization expiration date for the order.
int | $paymentAuthExpiration |
Implements OrderInterface.
Definition at line 3977 of file Order.php.
setPaymentAuthorizationAmount | ( | $amount | ) |
Sets the payment authorization amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 4057 of file Order.php.
setProtectCode | ( | $code | ) |
Sets the protect code for the order.
string | $code |
Implements OrderInterface.
Definition at line 3409 of file Order.php.
setQuoteAddressId | ( | $id | ) |
Sets the quote address ID for the order.
int | $id |
Implements OrderInterface.
Definition at line 3985 of file Order.php.
setQuoteId | ( | $id | ) |
Sets the quote ID for the order.
int | $id |
Implements OrderInterface.
Definition at line 3993 of file Order.php.
setRelationChildId | ( | $id | ) |
Sets the relation child ID for the order.
string | $id |
Implements OrderInterface.
Definition at line 4249 of file Order.php.
setRelationChildRealId | ( | $realId | ) |
Sets the relation child real ID for the order.
string | $realId |
Implements OrderInterface.
Definition at line 4257 of file Order.php.
setRelationParentId | ( | $id | ) |
Sets the relation parent ID for the order.
string | $id |
Implements OrderInterface.
Definition at line 4265 of file Order.php.
setRelationParentRealId | ( | $realId | ) |
Sets the relation parent real ID for the order.
string | $realId |
Implements OrderInterface.
Definition at line 4273 of file Order.php.
setRemoteIp | ( | $remoteIp | ) |
Sets the remote IP address for the order.
string | $remoteIp |
Implements OrderInterface.
Definition at line 4281 of file Order.php.
setShippingAddress | ( | \Magento\Sales\Api\Data\OrderAddressInterface | $address = null | ) |
Declare order shipping address
\Magento\Sales\Api\Data\OrderAddressInterface | $address |
Definition at line 932 of file Order.php.
setShippingAmount | ( | $amount | ) |
Sets the shipping amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 3721 of file Order.php.
setShippingCanceled | ( | $shippingCanceled | ) |
Sets the shipping canceled amount for the order.
float | $shippingCanceled |
Implements OrderInterface.
Definition at line 3729 of file Order.php.
setShippingDescription | ( | $description | ) |
Sets the shipping description for the order.
string | $description |
Implements OrderInterface.
Definition at line 3417 of file Order.php.
setShippingDiscountAmount | ( | $amount | ) |
Sets the shipping discount amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 4065 of file Order.php.
setShippingDiscountTaxCompensationAmount | ( | $amount | ) |
Sets the shipping discount tax compensation amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 4361 of file Order.php.
setShippingInclTax | ( | $amount | ) |
Sets the shipping including tax amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 4418 of file Order.php.
setShippingInvoiced | ( | $shippingInvoiced | ) |
Sets the shipping invoiced amount for the order.
float | $shippingInvoiced |
Implements OrderInterface.
Definition at line 3737 of file Order.php.
setShippingMethod | ( | $shippingMethod | ) |
Sets shipping method to order
string | $shippingMethod |
Definition at line 4438 of file Order.php.
setShippingRefunded | ( | $shippingRefunded | ) |
Sets the shipping refunded amount for the order.
float | $shippingRefunded |
Implements OrderInterface.
Definition at line 3745 of file Order.php.
setShippingTaxAmount | ( | $amount | ) |
Sets the shipping tax amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 3753 of file Order.php.
setShippingTaxRefunded | ( | $shippingTaxRefunded | ) |
Sets the shipping tax refunded amount for the order.
float | $shippingTaxRefunded |
Implements OrderInterface.
Definition at line 3761 of file Order.php.
setState | ( | $state | ) |
Sets the state for the order.
string | $state |
string | $state |
Implements OrderInterface.
Definition at line 982 of file Order.php.
setStatus | ( | $status | ) |
Sets the status for the order.
string | $status |
Implements OrderInterface.
Definition at line 3393 of file Order.php.
setStatusHistories | ( | array | $statusHistories = null | ) |
Sets status histories for the order.
Implements OrderInterface.
Definition at line 3385 of file Order.php.
setStoreCurrencyCode | ( | $code | ) |
Sets the store currency code for the order.
string | $code |
Implements OrderInterface.
Definition at line 4289 of file Order.php.
setStoreId | ( | $id | ) |
Sets the store ID for the order.
int | $id |
Implements OrderInterface.
Definition at line 3433 of file Order.php.
setStoreName | ( | $storeName | ) |
Sets the store name for the order.
string | $storeName |
Implements OrderInterface.
Definition at line 4297 of file Order.php.
setStoreToBaseRate | ( | $rate | ) |
Sets the store-to-base rate for the order.
float | $rate |
Implements OrderInterface.
Definition at line 3769 of file Order.php.
setStoreToOrderRate | ( | $rate | ) |
Sets the store-to-order rate for the order.
float | $rate |
Implements OrderInterface.
Definition at line 3777 of file Order.php.
setSubtotal | ( | $amount | ) |
Sets the subtotal for the order.
float | $amount |
Implements OrderInterface.
Definition at line 3785 of file Order.php.
setSubtotalCanceled | ( | $subtotalCanceled | ) |
Sets the subtotal canceled amount for the order.
float | $subtotalCanceled |
Implements OrderInterface.
Definition at line 3793 of file Order.php.
setSubtotalInclTax | ( | $amount | ) |
Sets the subtotal including tax amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 4073 of file Order.php.
setSubtotalInvoiced | ( | $subtotalInvoiced | ) |
Sets the subtotal invoiced amount for the order.
float | $subtotalInvoiced |
Implements OrderInterface.
Definition at line 3801 of file Order.php.
setSubtotalRefunded | ( | $subtotalRefunded | ) |
Sets the subtotal refunded amount for the order.
float | $subtotalRefunded |
Implements OrderInterface.
Definition at line 3809 of file Order.php.
setTaxAmount | ( | $amount | ) |
Sets the tax amount for the order.
float | $amount |
Implements OrderInterface.
Definition at line 3817 of file Order.php.
setTaxCanceled | ( | $taxCanceled | ) |
Sets the tax canceled amount for the order.
float | $taxCanceled |
Implements OrderInterface.
Definition at line 3825 of file Order.php.
setTaxInvoiced | ( | $taxInvoiced | ) |
Sets the tax invoiced amount for the order.
float | $taxInvoiced |
Implements OrderInterface.
Definition at line 3833 of file Order.php.
setTaxRefunded | ( | $taxRefunded | ) |
Sets the tax refunded amount for the order.
float | $taxRefunded |
Implements OrderInterface.
Definition at line 3841 of file Order.php.
setTotalCanceled | ( | $totalCanceled | ) |
Sets the total canceled for the order.
float | $totalCanceled |
Implements OrderInterface.
Definition at line 3849 of file Order.php.
setTotalDue | ( | $totalDue | ) |
Sets the total due for the order.
float | $totalDue |
Implements OrderInterface.
Definition at line 4081 of file Order.php.
setTotalInvoiced | ( | $totalInvoiced | ) |
Sets the total invoiced amount for the order.
float | $totalInvoiced |
Implements OrderInterface.
Definition at line 3857 of file Order.php.
setTotalItemCount | ( | $totalItemCount | ) |
Sets the total item count for the order.
int | $totalItemCount |
Implements OrderInterface.
Definition at line 4329 of file Order.php.
setTotalOfflineRefunded | ( | $totalOfflineRefunded | ) |
Sets the total offline refunded amount for the order.
float | $totalOfflineRefunded |
Implements OrderInterface.
Definition at line 3865 of file Order.php.
setTotalOnlineRefunded | ( | $totalOnlineRefunded | ) |
Sets the total online refunded amount for the order.
float | $totalOnlineRefunded |
Implements OrderInterface.
Definition at line 3873 of file Order.php.
setTotalPaid | ( | $totalPaid | ) |
Sets the total paid for the order.
float | $totalPaid |
Implements OrderInterface.
Definition at line 3881 of file Order.php.
setTotalQtyOrdered | ( | $totalQtyOrdered | ) |
Sets the total quantity ordered for the order.
float | $totalQtyOrdered |
Implements OrderInterface.
Definition at line 3889 of file Order.php.
setTotalRefunded | ( | $totalRefunded | ) |
Sets the total amount refunded amount for the order.
float | $totalRefunded |
Implements OrderInterface.
Definition at line 3897 of file Order.php.
setUpdatedAt | ( | $timestamp | ) |
Sets the updated-at timestamp for the order.
string | $timestamp |
Implements OrderInterface.
Definition at line 4321 of file Order.php.
setWeight | ( | $weight | ) |
Sets the weight for the order.
float | $weight |
Implements OrderInterface.
Definition at line 4089 of file Order.php.
setXForwardedFor | ( | $xForwardedFor | ) |
Sets the X-Forwarded-For HTTP header field for the order.
string | $xForwardedFor |
Implements OrderInterface.
Definition at line 4305 of file Order.php.
unhold | ( | ) |
Attempt to unhold the order
Definition at line 1119 of file Order.php.
unsetData | ( | $key = null | ) |
const REPORT_DATE_TYPE_CREATED = 'created' |