AddClientOrder

The AddOrders call creates one or more sales orders in your system. A sales order is split up into the actual sales order itself and the corresponding stock units.

A customer ID is necessary in order for a sales order to be created. You can use the AddCustomers call to create a new customer. This call returns the necessary customer ID. You can also use the GetCustomers call in order to search for customers. For further information, please refer to the corresponding pages of the manual.

If you do not specify a shipping profile, then it will be detected by the system. If you transmit the shipping costs, then they will also be saved in the sales order and will not be calculated.

If you transmit an E-mail template ID (TemplateID), then the corresponding E-mail template will be used to send an E-mail to the customers.

The stock will automatically be recalculated after a sales order was created.

This call is available since SOAP version 109.

AddClientOrder Input

Field Type Occurrence Meaning Available since
ApplyDeliveryAddress Boolean Optional Apply the delivery address 109
ApplyInvoiceAddress Boolean Optional Apply the invoice address 109
CustomerID Integer Required ID of the customer 109
MethodOfPaymentID Integer Required ID of the method of payment 109
SessionID String Required ID of the user session 109

AddClientOrder Input schema

The box below lists all fields that could be included in the call request (version 112). To learn more about an individual field or its type, click its name in the box.

<PlentySoapRequest_AddClientOrder> </PlentySoapRequest_AddClientOrder>

AddClientOrder Output

Field Type Occurrence Meaning Available since
OrderCustomerAddress ObjectOptional Customer address 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
AdditionalName
String Optional Additional name 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
City
String Optional City 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
Company
String Optional Company 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
CountryID
Integer Optional Country ID 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
CountryISO2
String Optional Country ISO2 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
CustomerID
Integer Optional Customer ID 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
EbayName
String Optional eBay Name 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
Email
String Optional E-mail address 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
Fax
String Optional Fax 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
FirstName
String Optional Firstname 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
FormOfAddress
Integer Optional Form of address 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
HouseNumber
String Optional House number 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
Street
String Optional Street 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
Surname
String Optional Lastname 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
Telephone
String Optional Telephone number 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
Title
String Optional Title 109
OrderCustomerAddress.
PlentySoapObject_AddClientOrderCustomerAddress.
ZIP
String Optional ZIP 109
OrderDeliveryAddress ObjectOptional Delivery address 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
AdditionalName
String Optional Additional name 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
City
String Optional City 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
Company
String Optional Company 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
CountryID
Integer Optional Country ID 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
CountryISO2
String Optional Country code 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
CustomerID
Integer Optional Customer ID 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
DeliveryAddressID
Integer Optional Delivery address ID 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
Email
String Optional E-mail address 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
Evaluation
String Optional Evaluation 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
ExternalDeliveryAddressID
String Optional External delivery address ID 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
Fax
String Optional Fax number 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
FirstName
String Optional First name 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
FormOfAddress
Integer Optional Form of address 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
HouseNumber
String Optional House number 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
Street
String Optional Street 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
Surname
String Optional Surname 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
Telephone
String Optional Telephone number 109
OrderDeliveryAddress.
PlentySoapObject_AddClientOrderDeliveryAddress.
ZIP
String Optional ZIP code 109
OrderHead ObjectOptional Sales order data 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
Currency
String Optional Currency 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
CustomerID
Integer Required Customer ID 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
DeliveryAddressID
Integer Optional Delivery address ID 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
DoneTimestamp
String Optional Order completion timestamp 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
DunningLevel
Integer Optional Dunning level 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
EstimatedTimeOfShipment
String Optional $Estimated time of shipment 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
ExchangeRatio
Double Optional Exchange ratio 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
ExternalOrderID
String Required External sales order ID 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
Invoice
String Optional Invoice number 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
IsNetto
Boolean Optional Is netto? 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
LastUpdate
Integer Optional Last update 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
Marking1ID
Integer Optional ID of marking 1 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
MethodOfPaymentID
Integer Optional Payment method ID 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
OrderID
Integer Optional Sales order ID 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
OrderStatus
Double Optional Sales order status 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
OrderTimestamp
Integer Optional The time of the sales order - timestamp 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
OrderType
String Optional Sales order type 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
PackageNumber
String Optional Package number 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
PaidTimestamp
String Optional Incoming payment timestamp 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
ParentOrderID
Integer Optional Parent sales order ID 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
PaymentStatus
Integer Optional Payment status 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
ReferrerID
Integer Optional Sales order referrer ID 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
RemoteIP
String Optional IP 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
ResponsibleID
Integer Optional ID of the person responsible 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
SalesAgentID
Integer Optional SalesAgentID 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
ShippingCosts
Double Optional Shipping costs 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
ShippingID
Integer Optional Shipping ID 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
ShippingMethodID
Integer Optional Shipping service provider ID 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
ShippingProfileID
Integer Optional Shipping profile ID 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
StoreID
Integer Optional Multishop ID 110
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
TotalBrutto
Double Optional Gross 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
TotalInvoice
Double Optional Total invoice 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
TotalNetto
Double Optional Net 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
TotalVAT
Double Optional Total VAT 109
OrderHead.
PlentySoapObject_AddClientOrderOrderHead.
WarehouseID
Integer Optional Warehouse ID 109
OrderItems ObjectOptional List of order items 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
BundleItemID
Integer Optional Bundle item ID 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
Currency
String Optional Currency 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
ExternalItemID
String Optional external item id 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
ExternalOrderItemID
String Optional External item ID 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
ItemID
Integer Optional Item ID 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
ItemNo
String Optional Item no 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
ItemRebate
Double Optional Item rebate (percentaged) 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
ItemText
String Optional Item text 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
OrderID
Integer Required Order ID 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
OrderRowID
Integer Optional Order row id 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
Price
Double Optional Price 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
Quantity
Double Optional Quantity 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
ReferrerID
Integer Optional Referrer 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
SKU
String Optional The item's SKU 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
VAT
Double Optional VAT 109
OrderItems.
PlentySoapObject_AddClientOrderOrderItem.
WarehouseID
Integer Optional Warehouse ID 109
ResponseMessages not definedOptional 112
Success not definedOptional 112

AddClientOrder Output schema

The box below lists all fields that could be included in the response call (version 112). To learn more about an individual field or its type, click its name in the box.

<PlentySoapResponse_AddClientOrder> </PlentySoapResponse_AddClientOrder>

Identification Keys

(The dynamicValue stands for any parameter values that could be outputted.)

Key Value
SessionID dynamicValue

Identification Output schema

The box below lists all identification fields that could be outputted in the call response (version 112). The dynamicValue stands for any parameter values that could be outputted. To learn more about an individual field or its type, click its name in the box.

Success messages

(The dynamicValue stands for any parameter values that could be outputted.)

Code Key Value Message Explanation
100 OrderID dynamicValue   Sales order was successfully added

Success Messages Output schema

The box below lists all success messages fields that could be outputted in the call response (version 112). The dynamicValue stands for any parameter values that could be outputted. To learn more about an individual field or its type, click its name in the box.

<SuccessMessages>
<item>
<Value>dynamicValue</Value>
<Key>OrderID</Key>
</item>
</Success>

Error messages

Code Key Value Message Explanation
800 SessionID Missing parameter Required parameter was not entered
800 SessionID Invalid parameter Value of entered parameter is not allowed.

Error messages Output schema

The box below lists all error message fields that could be outputted in the call response (version 112). To learn more about an individual field or its type, click its name in the box.

<ErrorMessages>
<item>
<Value>Missing parameter</Value>
<Key>SessionID</Key>
</item>
<item>
<Value>Invalid parameter</Value>
<Key>SessionID</Key>
</item>
</ErrorMessages>

Warnings

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben