Interface OrderWriteServiceInterface

Interface OrderWriteServiceInterface

Direct known implementers

OrderWriteService

Package: Order\Interfaces
Category: System
Located at Services/Core/Order/Interfaces/OrderWriteServiceInterface.inc.php

Methods summary

public 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 ) : integer

Creates a new customer order and returns the order ID as an integer.

public 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 ) : integer

Creates a new standalone order (e.g. for guests) and returns the order ID as an integer.

public updateCustomerAddress( IdType $orderId, AddressBlockInterface $newAddress )

Updates the customers address.

public updateBillingAddress( IdType $orderId, AddressBlockInterface $newAddress )

Updates the customers billing address.

public updateDeliveryAddress( IdType $orderId, AddressBlockInterface $newAddress )

Updates the customers delivery address.

public addOrderItem( IdType $orderId, OrderItemInterface $orderItem ) : integer

Adds an item to the order.

public updateOrderItem( StoredOrderItemInterface $orderItem )

Updates an order item.

public removeOrderItem( StoredOrderItemInterface $orderItem )

Removes an item from an order.

public addOrderItemAttribute( IdType $orderItemId, OrderItemAttributeInterface $orderItemAttribute ) : integer

Adds an order item attribute to the order.

public updateOrderItemAttribute( StoredOrderItemAttributeInterface $orderItemAttribute )

Updates an item attribute of an order.

public removeOrderItemAttribute( StoredOrderItemAttributeInterface $orderItemAttribute )

Removes an item attribute of an order.

public addOrderTotal( IdType $orderId, OrderTotalInterface $orderTotal ) : integer

Adds a total price to an order.

public updateOrderTotal( StoredOrderTotalInterface $orderTotal )

Updates a total price of an order.

public removeOrderTotal( StoredOrderTotalInterface $orderTotal )

Removes a total price of an order.

public updateShippingType( IdType $orderId, OrderShippingType $newShippingType )

Updates the shipping type of an order.

public updatePaymentType( IdType $orderId, OrderPaymentType $newPaymentType )

Updates the payment type of an order.

public updateComment( IdType $orderId, StringType $newComment )

Updates the comment of an order.

public updateOrderStatus( IdType $orderId, IntType $newOrderStatusId, StringType $comment, BoolType $customerNotified, IdType $customerId = null )

Updates the order status of an order.

public addOrderStatusHistoryEntry( IdType $orderId, StringType $comment, IdType $customerId )

Add Order Status History Entry

public updateOrder( OrderInterface $order )

Updates the provided order.

public removeOrderById( IdType $orderId )

Removes a specific order, depending on the provided order ID.