ROUND_ITEM
ROUND_ITEM
None found |
None found |
None found |
None found |
None found |
None found |
None found |
None found |
$valid : boolean
None found |
$reference : string
None found |
None found |
deleteProduct( $order, $orderDetail, $quantity)
$order | ||
$orderDetail | ||
$quantity |
None found |
getCartProducts() : array
This function return products of the orders It's similar to Order::getProducts but with similar outputs of Cart::getProducts
None found |
deleteCustomization( $id_customization, $quantity, $orderDetail)
$id_customization | ||
$quantity | ||
$orderDetail |
None found |
getHistory(integer $id_lang, integer $id_order_state = false, integer $no_hidden = false, integer $filters) : array
Get order history
integer | $id_lang | Language id |
integer | $id_order_state | Filter a specific order status |
integer | $no_hidden | Filter no hidden status |
integer | $filters | Flag to use specific field filter |
History entries ordered by date DESC
None found |
setProductPrices( $row)
Marked as deprecated but should not throw any "deprecated" message This function is used in order to keep front office backward compatibility 14 -> 1.5 (Order History)
$row |
None found |
getProducts( $products = false, $selectedProducts = false, $selectedQty = false) : array
Get order products
$products | ||
$selectedProducts | ||
$selectedQty |
Products with price, quantity (with taxe and without)
None found |
getIdOrderProduct( $id_customer, $id_product)
$id_customer | ||
$id_product |
None found |
getVirtualProducts() : integer
Count virtual products in order
number of virtual products
None found |
isVirtual(boolean $strict = true) : boolean
Check if order contains (only) virtual products
boolean | $strict | If false return true if there are at least one product virtual |
true if is a virtual order or false
None found |
None found |
getDiscountsCustomer( $id_customer, $id_cart_rule)
$id_customer | ||
$id_cart_rule |
None found |
getCurrentState() : integer
Get current order status (eg. Awaiting payment, Delivered.
..)
Order status id
None found |
getCurrentStateFull( $id_lang) : array
Get current order status name (eg. Awaiting payment, Delivered.
..)
$id_lang |
Order status details
None found |
None found |
isPaidAndShipped() : boolean
Checks if the current order status is paid and shipped
None found |
getCustomerOrders(integer $id_customer, boolean $showHiddenStatus = false, \Context $context = null) : array
Get customer orders
integer | $id_customer | Customer id |
boolean | $showHiddenStatus | Display or not hidden order statuses |
\Context | $context |
Customer orders
None found |
getOrdersIdByDate( $date_from, $date_to, $id_customer = null, $type = null)
$date_from | ||
$date_to | ||
$id_customer | ||
$type |
None found |
getOrdersWithInformations( $limit = null, \Context $context = null)
$limit | ||
\Context | $context |
None found |
getOrdersIdInvoiceByDate( $date_from, $date_to, $id_customer = null, $type = null) : array
$date_from | ||
$date_to | ||
$id_customer | ||
$type |
static |
---|
getOrderIdsByStatus( $id_order_state) : array
$id_order_state |
static |
---|
getTotalProductsWithoutTaxes( $products = false) : \Product
Get product total without taxes
$products |
total without taxes
None found |
getTotalProductsWithTaxes( $products = false) : \Product
Get product total with taxes
$products |
total with taxes
None found |
None found |
getCustomerNbOrders(integer $id_customer) : array
Get customer orders number
integer | $id_customer | Customer id |
Customer orders number
None found |
getOrderByCartId(integer $id_cart) : array
Get an order by its cart id
integer | $id_cart | Cart id |
Order details
None found |
addDiscount(integer $id_cart_rule, string $name, float $value) : boolean
integer | $id_cart_rule | |
string | $name | |
float | $value |
None found |
addCartRule(integer $id_cart_rule, string $name, array $values, integer $id_order_invoice, $free_shipping = null) : boolean
integer | $id_cart_rule | |
string | $name | |
array | $values | |
integer | $id_order_invoice | |
$free_shipping |
since | 1.5.0.1 |
---|
None found |
setLastInvoiceNumber( $order_invoice_id, $id_shop)
$order_invoice_id | ||
$id_shop |
None found |
None found |
setInvoice( $use_existing_payment = false)
This method allows to generate first invoice of the current order
$use_existing_payment |
None found |
setDeliverySlip()
This method allows to generate first delivery slip of the current order
None found |
setDeliveryNumber( $order_invoice_id, $id_shop)
$order_invoice_id | ||
$id_shop |
None found |
None found |
getByReference(string $reference) : \PrestaShopCollection
Get a collection of orders using reference
string | $reference |
Collection of Order
since | 1.5.0.14 |
---|
None found |
getCartIdStatic(integer $id_order, integer $id_customer) : integer
integer | $id_order | |
integer | $id_customer | optionnal |
id_cart
None found |
setCurrentState(integer $id_order_state, integer $id_employee)
Set current order status
integer | $id_order_state | |
integer | $id_employee | (/!\ not optional except for Webservice. |
None found |
None found |
getPreviousOrderId() : integer
This method return the ID of the previous order
since | 1.5.0.1 |
---|
getNextOrderId() : integer
This method return the ID of the next order
since | 1.5.0.1 |
---|
getOrderDetailList() : array
Get the an order detail list of the current order
None found |
generateReference() : String
Gennerate a unique reference for orders generated with the same cart id This references, is usefull for check payment
None found |
useOneAfterAnotherTaxComputationMethod() : boolean
This method returns true if at least one order details uses the One After Another tax computation method.
since | 1.5.0.1 |
---|
getOrderPaymentCollection() : \PrestaShopCollection
This method allows to get all Order Payment for the current order
Collection of OrderPayment
since | 1.5.0.1 |
---|
addOrderPayment(float $amount_paid, string $payment_method = null, string $payment_transaction_id = null, \Currency $currency = null, string $date = null, \OrderInvoice $order_invoice = null) : boolean
This method allows to add a payment to the current order
float | $amount_paid | |
string | $payment_method | |
string | $payment_transaction_id | |
\Currency | $currency | |
string | $date | |
\OrderInvoice | $order_invoice |
since | 1.5.0.1 |
---|
getDocuments() : array
Returns the correct product taxes breakdown.
Get all documents linked to the current order
since | 1.5.0.1 |
---|
getShipping() : array
return all shipping method for the current order state_name sql var is now deprecated - use order_state_name for the state name and carrier_name for the carrier_name
None found |
getOrderSlipsCollection() : \PrestaShopCollection
Get all order_slips for the current order
Collection of OrderSlip
since | 1.5.0.2 |
---|
getInvoicesCollection() : \PrestaShopCollection
Get all invoices for the current order
Collection of OrderInvoice
since | 1.5.0.1 |
---|
getDeliverySlipsCollection() : \PrestaShopCollection
Get all delivery slips for the current order
Collection of OrderInvoice
since | 1.5.0.2 |
---|
getNotPaidInvoicesCollection() : \PrestaShopCollection
Get all not paid invoices for the current order
Collection of Order invoice not paid
since | 1.5.0.2 |
---|
getTotalPaid(\Currency $currency = null) : float
Get total paid
\Currency | $currency | currency used for the total paid of the current order |
amount in the $currency
since | 1.5.0.1 |
---|
getOrdersTotalPaid() : float
Get the sum of total_paid_tax_incl of the orders with similar reference
since | 1.5.0.1 |
---|
updateShippingCost(float $amount) : boolean
This method allows to change the shipping cost of the current order
float | $amount |
since | 1.5.0.1 |
---|
getProductTaxesBreakdown() : array
Returns the correct product taxes breakdown.
since | 1.5.0.1 |
---|
getShippingTaxesBreakdown() : array
Returns the shipping taxes breakdown
since | 1.5.0.1 |
---|
getWrappingTaxesBreakdown() : array
Returns the wrapping taxes breakdown
todo | |
---|---|
since | 1.5.0.1 |
getEcoTaxTaxesBreakdown() : array
Returns the ecotax taxes breakdown
since | 1.5.0.1 |
---|
hasInvoice() : boolean
Has invoice return true if this order has already an invoice
None found |
hasDelivery() : boolean
Has Delivery return true if this order has already a delivery slip
None found |
getWarehouseList()
Get warehouse associated to the order
return array List of warehouse
None found |
getCurrentOrderState() : \OrderState
or null if Order haven't a state
since | 1.5.0.4 |
---|
getWebserviceObjectList( $sql_join, $sql_filter, $sql_sort, $sql_limit)
$sql_join | ||
$sql_filter | ||
$sql_sort | ||
$sql_limit |
None found |
getUniqReference()
Return a unique reference like : GWJTHMZUN#2
With multishipping, order reference are the same for all orders made with the same cart in this case this method suffix the order reference by a # and the order number
since | 1.5.0.14 |
---|
getUniqReferenceOf( $id_order)
Return a unique reference like : GWJTHMZUN#2
With multishipping, order reference are the same for all orders made with the same cart in this case this method suffix the order reference by a # and the order number
$id_order |
since | 1.5.0.14 |
---|
since | 1.5.5.0 |
---|
None found |
None found |
setProductCustomizedDatas( $product, $customized_datas)
$product | ||
$customized_datas |
None found |
setProductCurrentStock( $product)
This method allow to add stock information on a product detail
If advanced stock management is active, get physical stock of this product in the warehouse associated to the ptoduct for the current order Else get the available quantity of the product in fucntion of the shop associated to the order
$product |
None found |