public
integer
|
#
createNewCustomerOrder( IdType $customerId, CustomerStatusInformation $customerStatusInfo, StringType $customerNumber, EmailStringType $customerEmail, StringType $customerTelephone, StringType $vatIdNumber, AddressBlockInterface $customerAddress, AddressBlockInterface $billingAddress, AddressBlockInterface $deliveryAddress, OrderItemCollection $orderItemCollection, OrderTotalCollection $orderTotalCollection, OrderShippingType $shippingType, OrderPaymentType $paymentType, CurrencyCode $currencyCode, LanguageCode $languageCode, DecimalType $totalWeight, StringType $comment = null, IntType $orderStatusId = null, KeyValueCollection $addonValues = null )
Creates a new customer order and returns the order ID as an integer.
Creates a new customer order and returns the order ID as an integer.
Parameters
- $customerId
- Customer ID.
- $customerStatusInfo
- Customer Status Information.
- $customerNumber
- Customer Number.
- $customerEmail
- Customer Email.
- $customerTelephone
- Customer Telephone.
- $vatIdNumber
- VAT ID Number.
- $customerAddress
- Address of the customer.
- $billingAddress
- Billing address of the customer.
- $deliveryAddress
- Delivery address of the customer.
- $orderItemCollection
- Collection of the order items.
- $orderTotalCollection
- Total collection of the order.
- $shippingType
- Shipping type of the order.
- $paymentType
- Payment type of the order.
- $currencyCode
- Currency code of the order.
- $languageCode
- Language code of the order.
- $totalWeight
- $comment Optional comment of the order (default = null).
- $comment
- $totalWeight Total weight of the order in kg.
- $orderStatusId
- Optional id of the initial order status (default = null).
- $addonValues
Optional key => value collection of addon values - e.g.
cookies (default = null).
Returns
integer Order ID.
|
public
integer
|
#
createNewStandaloneOrder( StringType $customerNumber, EmailStringType $customerEmail, StringType $customerTelephone, StringType $vatIdNumber, AddressBlockInterface $customerAddress, AddressBlockInterface $billingAddress, AddressBlockInterface $deliveryAddress, OrderItemCollection $orderItemCollection, OrderTotalCollection $orderTotalCollection, OrderShippingType $shippingType, OrderPaymentType $paymentType, CurrencyCode $currencyCode, LanguageCode $languageCode, DecimalType $totalWeight, StringType $comment = null, IntType $orderStatusId = null, KeyValueCollection $addonValues = null )
Creates a new standalone order (e.g. for guests) and returns the order ID as an integer.
Creates a new standalone order (e.g. for guests) and returns the order ID as an integer.
Parameters
- $customerNumber
- Customer Number.
- $customerEmail
- Customer Email.
- $customerTelephone
- Customer Telephone.
- $vatIdNumber
- VAT ID number of the customer.
- $customerAddress
- Address of the customer.
- $billingAddress
- Billing address of the customer.
- $deliveryAddress
- Delivery address of the customer.
- $orderItemCollection
- Collection of the order items.
- $orderTotalCollection
- Total collection of the order.
- $shippingType
- Shipping type of the order.
- $paymentType
- Payment type of the order.
- $currencyCode
- Currency code of the order.
- $languageCode
- Language code of the order.
- $totalWeight
- Total weight of the order in kg.
- $comment
- Optional comment of the order (default = null).
- $orderStatusId
- Optional id of the initial order status (default = null).
- $addonValues
Optional key => value collection of addon values - e.g.
cookies (default = null).
Returns
integer Order ID.
|
public
|
|
public
|
#
updateBillingAddress( IdType $orderId, AddressBlockInterface $newAddress )
Updates the customers billing address.
Updates the customers billing address.
Parameters
- $orderId
- Order ID which holds the current address.
- $newAddress
- New billing address.
|
public
|
#
updateDeliveryAddress( IdType $orderId, AddressBlockInterface $newAddress )
Updates the customers delivery address.
Updates the customers delivery address.
Parameters
- $orderId
- Order ID which holds the current address.
- $newAddress
- New delivery address.
|
public
integer
|
#
addOrderItem( IdType $orderId, OrderItemInterface $orderItem )
Adds an item to the order.
Adds an item to the order.
Parameters
- $orderId
- Order ID of the order to add the item.
- $orderItem
- The order item to add.
Returns
integer ID of the StoredOrderItem.
|
public
|
|
public
|
|
public
integer
|
#
addOrderItemAttribute( IdType $orderItemId, OrderItemAttributeInterface $orderItemAttribute )
Adds an order item attribute to the order.
Adds an order item attribute to the order.
Parameters
- $orderItemId
- Order ID of the order item to add the attribute.
- $orderItemAttribute
- The order item attribute to add.
Returns
integer ID of stored order item attribute.
|
public
|
|
public
|
|
public
integer
|
#
addOrderTotal( IdType $orderId, OrderTotalInterface $orderTotal )
Adds a total price to an order.
Adds a total price to an order.
Parameters
- $orderId
- Order ID of the order to add the total price.
- $orderTotal
- Total price to add to the order.
Returns
integer ID of stored order total.
|
public
|
|
public
|
|
public
|
#
updateShippingType( IdType $orderId, OrderShippingType $newShippingType )
Updates the shipping type of an order.
Updates the shipping type of an order.
Parameters
- $orderId
- Order ID of the order to update.
- $newShippingType
- The new shipping type.
|
public
|
#
updatePaymentType( IdType $orderId, OrderPaymentType $newPaymentType )
Updates the payment type of an order.
Updates the payment type of an order.
Parameters
- $orderId
- Order ID of the order to update.
- $newPaymentType
- The new payment type.
|
public
|
#
updateOrderStatus( IdType $orderId, IntType $newOrderStatusId, StringType $comment, BoolType $customerNotified )
Updates the order status of an order.
Updates the order status of an order.
Parameters
- $orderId
- Order ID of the order to update.
- $newOrderStatusId
- The new status ID.
- $comment
- Comment of the order status history item.
- $customerNotified
- Customer notified flag.
|
public
|
|
public
|
#
removeOrderById( IdType $orderId )
Removes a specific order, depending on the provided order ID.
Removes a specific order, depending on the provided order ID.
Parameters
- $orderId
- Order ID of the order to remove.
|