OrderWriteServiceInterface

Extends

Interface OrderWriteServiceInterface

category

System

package

Order

subpackage

Interfaces

Methods

Adds an item to the order.

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

Arguments

$orderId

\IdType

Order ID of the order to add the item.

$orderItem

\OrderItemInterface

The order item to add.

Response

integer

ID of the StoredOrderItem.

Adds an order item attribute to the order.

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

Arguments

$orderItemId

\IdType

Order ID of the order item to add the attribute.

$orderItemAttribute

\OrderItemAttributeInterface

The order item attribute to add.

Response

integer

ID of stored order item attribute.

Add Order Status History Entry

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

Add an order status history entry to an order, without changing the status or notifying the customer.

Arguments

$orderId

\IdType

Order ID of the order to update

$comment

\StringType

Comment of the order status history item

$customerId

\IdType

Customer ID of the admin

Adds a total price to an order.

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

Arguments

$orderId

\IdType

Order ID of the order to add the total price.

$orderTotal

\OrderTotalInterface

Total price to add to the order.

Response

integer

ID of stored order total.

Creates a new customer order and returns the order ID as an 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) : integer

Arguments

$customerId

\IdType

Customer ID.

$customerStatusInfo

\CustomerStatusInformation

Customer Status Information.

$customerNumber

\StringType

Customer Number.

$customerEmail

\EmailStringType

Customer Email.

$customerTelephone

\StringType

Customer Telephone.

$vatIdNumber

\StringType

VAT ID Number.

$customerAddress

\AddressBlockInterface

Address of the customer.

$billingAddress

\AddressBlockInterface

Billing address of the customer.

$deliveryAddress

\AddressBlockInterface

Delivery address of the customer.

$orderItemCollection

\OrderItemCollection

Collection of the order items.

$orderTotalCollection

\OrderTotalCollection

Total collection of the order.

$shippingType

\OrderShippingType

Shipping type of the order.

$paymentType

\OrderPaymentType

Payment type of the order.

$currencyCode

\CurrencyCode

Currency code of the order.

$languageCode

\LanguageCode

Language code of the order.

$totalWeight

\DecimalType

Total weight of the order in kg.

$comment

\StringType

Optional comment of the order (default = null).

$orderStatusId

\IntType

Optional id of the initial order status (default = null).

$addonValues

\KeyValueCollection

Optional key => value collection of addon values - e.g. cookies (default = null).

Response

integer

Order ID.

Creates a new standalone order (e.g. for guests) and returns the order ID as an 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) : integer

Arguments

$customerNumber

\StringType

Customer Number.

$customerEmail

\EmailStringType

Customer Email.

$customerTelephone

\StringType

Customer Telephone.

$vatIdNumber

\StringTYpe

VAT ID number of the customer.

$customerAddress

\AddressBlockInterface

Address of the customer.

$billingAddress

\AddressBlockInterface

Billing address of the customer.

$deliveryAddress

\AddressBlockInterface

Delivery address of the customer.

$orderItemCollection

\OrderItemCollection

Collection of the order items.

$orderTotalCollection

\OrderTotalCollection

Total collection of the order.

$shippingType

\OrderShippingType

Shipping type of the order.

$paymentType

\OrderPaymentType

Payment type of the order.

$currencyCode

\CurrencyCode

Currency code of the order.

$languageCode

\LanguageCode

Language code of the order.

$totalWeight

\DecimalType

Total weight of the order in kg.

$comment

\StringType

Optional comment of the order (default = null).

$orderStatusId

\IntType

Optional id of the initial order status (default = null).

$addonValues

\KeyValueCollection

Optional key => value collection of addon values - e.g. cookies (default = null).

Response

integer

Order ID.

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

removeOrderById(\IdType $orderId) 

Arguments

$orderId

\IdType

Order ID of the order to remove.

Removes an item from an order.

removeOrderItem(\StoredOrderItemInterface $orderItem) 

Arguments

$orderItem

\StoredOrderItemInterface

The order item to remove.

Removes an item attribute of an order.

removeOrderItemAttribute(\StoredOrderItemAttributeInterface $orderItemAttribute) 

Arguments

$orderItemAttribute

\StoredOrderItemAttributeInterface

The order item attribute to remove.

Removes a total price of an order.

removeOrderTotal(\StoredOrderTotalInterface $orderTotal) 

Arguments

$orderTotal

\StoredOrderTotalInterface

The total price of an order to remove.

Updates the customers billing address.

updateBillingAddress(\IdType $orderId, \AddressBlockInterface $newAddress) 

Arguments

$orderId

\IdType

Order ID which holds the current address.

$newAddress

\AddressBlockInterface

New billing address.

Updates the comment of an order.

updateComment(\IdType $orderId, \StringType $newComment) 

Arguments

$orderId

\IdType

Order ID of the order to update.

$newComment

\StringType

The new comment.

Updates the customers address.

updateCustomerAddress(\IdType $orderId, \AddressBlockInterface $newAddress) 

Arguments

$orderId

\IdType

Order ID which holds the current address.

$newAddress

\AddressBlockInterface

New address of the customer.

Updates the customers delivery address.

updateDeliveryAddress(\IdType $orderId, \AddressBlockInterface $newAddress) 

Arguments

$orderId

\IdType

Order ID which holds the current address.

$newAddress

\AddressBlockInterface

New delivery address.

Updates the provided order.

updateOrder(\OrderInterface $order) 

Arguments

$order

\OrderInterface

Order to update.

Updates an order item.

updateOrderItem(\StoredOrderItemInterface $orderItem) 

Arguments

$orderItem

\StoredOrderItemInterface

The order item to update.

Updates an item attribute of an order.

updateOrderItemAttribute(\StoredOrderItemAttributeInterface $orderItemAttribute) 

Arguments

$orderItemAttribute

\StoredOrderItemAttributeInterface

The order item attribute to update.

Updates the order status of an order.

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

Arguments

$orderId

\IdType

Order ID of the order to update.

$newOrderStatusId

\IntType

The new status ID.

$comment

\StringType

Comment of the order status history item.

$customerNotified

\BoolType

Customer notified flag.

$customerId

\IdType

Customer ID of the admin account.

Updates a total price of an order.

updateOrderTotal(\StoredOrderTotalInterface $orderTotal) 

Arguments

$orderTotal

\StoredOrderTotalInterface

The total price of an order to update.

Updates the payment type of an order.

updatePaymentType(\IdType $orderId, \OrderPaymentType $newPaymentType) 

Arguments

$orderId

\IdType

Order ID of the order to update.

$newPaymentType

\OrderPaymentType

The new payment type.

Updates the shipping type of an order.

updateShippingType(\IdType $orderId, \OrderShippingType $newShippingType) 

Arguments

$orderId

\IdType

Order ID of the order to update.

$newShippingType

\OrderShippingType

The new shipping type.