public
|
|
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 )
Create New Customer Order
Create New Customer Order
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
- Total weight of the order in kilo gram
- $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
Implementation of
|
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 )
Create New Standalone Order
Create New Standalone Order
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
Implementation of
|
public
|
#
updateCustomerAddress( IdType $orderId, AddressBlockInterface $newAddress )
Update Customer Address
Updates the customers address.
Parameters
- $orderId
- Order ID which holds the current address
- $newAddress
- New address of the customer
Implementation of
|
public
|
#
updateBillingAddress( IdType $orderId, AddressBlockInterface $newAddress )
Update Billing Address
Updates the customers billing address.
Parameters
- $orderId
- Order ID which holds the current address
- $newAddress
- New billing address
Implementation of
|
public
|
#
updateDeliveryAddress( IdType $orderId, AddressBlockInterface $newAddress )
Update Delivery Address
Updates the customers delivery address.
Parameters
- $orderId
- Order ID which holds the current address
- $newAddress
- New delivery address
Implementation of
|
public
integer
|
#
addOrderItem( IdType $orderId, OrderItemInterface $orderItem )
Add Order Item
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
Implementation of
|
public
|
|
public
|
|
public
integer
|
#
addOrderItemAttribute( IdType $orderItemId, OrderItemAttributeInterface $orderItemAttribute )
Add Order Item Attribute
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.
Implementation of
|
public
|
|
public
|
|
public
integer
|
#
addOrderTotal( IdType $orderId, OrderTotalInterface $orderTotal )
Add Order Total
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.
Implementation of
|
public
|
|
public
|
|
public
|
#
updateShippingType( IdType $orderId, OrderShippingType $newShippingType )
Update Shipping Type
Updates the shipping type of an order.
Parameters
- $orderId
- Order ID of the order to update
- $newShippingType
- The new shipping type
Implementation of
|
public
|
#
updatePaymentType( IdType $orderId, OrderPaymentType $newPaymentType )
Update Payment Type
Updates the payment type of an order.
Parameters
- $orderId
- Order ID of the order to update
- $newPaymentType
- The new payment type
Implementation of
|
public
|
#
updateOrderStatus( IdType $orderId, IntType $newOrderStatusId, StringType $comment, BoolType $customerNotified )
Update Order Status
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
Implementation of
|
public
OrderWriteService
|
|
public
|
#
removeOrderById( IdType $orderId )
Remove Order by ID
Removes a specific order, depending on the provided order ID.
Parameters
- $orderId
- Order ID of the order to remove
Implementation of
|