AddOrderItems

Use the AddOrderItems call to add items to a sales order. One of the following parameters has to be used to identify the items: ItemID, SKU or ExternalItemID.

This call is available since SOAP version 100.
It is necessary to specify the sales order ID (OrderID).
Please note that the ExternalItemID is not a unique number. In some cases, it could lead to an incorrect item being added.
A maximum of 50 items can be added per call.
It is possible to transmit one of EAN1-EAN4 instead of SKU to add an item to order.
The following row types are valid: Default, ShippingCosts, Bundle, BundleItem, PromotionItem, Coupon, Discount, AdditionalCosts, AdditionalCostsProperty, TrustedShops, Surcharge, SurchargeForPaymentMethod, SurchargeForShippingMethod. If you enter an invalid row type, the default row type will be used.

AddOrderItems Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
Items ObjectOptional Items 105
Items.
PlentySoapObject_OrderItem.
BundleItemID
Integer Optional Bundle item ID 105
Items.
PlentySoapObject_OrderItem.
Currency
String Optional Currency 105
Items.
PlentySoapObject_OrderItem.
EAN
String Optional EAN 111
Items.
PlentySoapObject_OrderItem.
EAN2
String Optional EAN 2 111
Items.
PlentySoapObject_OrderItem.
EAN3
String Optional EAN 3 111
Items.
PlentySoapObject_OrderItem.
EAN4
String Optional EAN 4 111
Items.
PlentySoapObject_OrderItem.
ExternalItemID
String Optional external item id 105
Items.
PlentySoapObject_OrderItem.
ExternalOrderItemID
String Optional External item ID 106
Items.
PlentySoapObject_OrderItem.
ItemID
Integer Optional Item ID 105
Items.
PlentySoapObject_OrderItem.
ItemNo
String Optional Item no 106
Items.
PlentySoapObject_OrderItem.
ItemRebate
Double Optional Item rebate (percentaged) 108
Items.
PlentySoapObject_OrderItem.
ItemText
String Optional Item text 105
Items.
PlentySoapObject_OrderItem.
NeckermannItemNo
String Optional Neckermann item no 106
Items.
PlentySoapObject_OrderItem.
OrderID
Integer Required Order ID 105
Items.
PlentySoapObject_OrderItem.
OrderRowID
Integer Optional Order row id 105
Items.
PlentySoapObject_OrderItem.
ParentOrderRowID
Integer Optional Parent order row id 110
Items.
PlentySoapObject_OrderItem.
Price
Double Optional Price 105
Items.
PlentySoapObject_OrderItem.
Quantity
Double Optional Quantity 105
Items.
PlentySoapObject_OrderItem.
ReferrerID
Integer Optional Referrer 105
Items.
PlentySoapObject_OrderItem.
RowType
ObjectOptional Item row type 111
Items.
PlentySoapObject_OrderItem.
SKU
String Optional The item's SKU 105
Items.
PlentySoapObject_OrderItem.
SalesOrderProperties
ObjectOptional Sales order Properties 106
Items.
PlentySoapObject_OrderItem.
SalesOrderProperties.
PlentySoapObject_SalesOrderProperty.
SalesOrderPropertyID
Integer Optional Sales order property id 106
Items.
PlentySoapObject_OrderItem.
SalesOrderProperties.
PlentySoapObject_SalesOrderProperty.
SalesOrderPropertyName
String Optional Sales order property name 106
Items.
PlentySoapObject_OrderItem.
SalesOrderProperties.
PlentySoapObject_SalesOrderProperty.
SalesOrderPropertyType
String Optional Sales order property type 106
Items.
PlentySoapObject_OrderItem.
SalesOrderProperties.
PlentySoapObject_SalesOrderProperty.
SalesOrderPropertyValue
String Optional Sales order property value 106
Items.
PlentySoapObject_OrderItem.
VAT
Double Optional VAT 105
Items.
PlentySoapObject_OrderItem.
WarehouseID
Integer Optional Warehouse ID 105

AddOrderItems 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.

AddOrderItems Output

Field Type Occurrence Meaning Available since
ResponseMessages ObjectOptional Returns a list of error messages for the current call. 112
ResponseMessages.
PlentySoapResponseMessage.
Code
Integer Optional Code 105
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
IdentificationKey
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
IdentificationValue
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
Success Boolean Optional Has the value true or false, depending on whether a request worked. 112

AddOrderItems 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.

Identification Keys

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

Key Value
OrderID 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 - - - Item was successfully added.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 OrderID Missing parameter Required parameter was not entered.
800 WarehouseID Missing parameter Required parameter was not entered
800 EAN1-EAN4 Missing parameter Required parameter was not entered
810 CustomerID Missing parameter More than one data row found for the given value of parameter EAN. The given value of EAN is not unique! Order item could not be added because too many data rows were found for the given EAN value!

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>OrderID</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>WarehouseID</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>EAN1-EAN4</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>CustomerID</Key>
</item>
</ErrorMessages>

Warnings

Code Key Value Message Explanation
110 No data No data found No items were found for the given EAN.

Warnings Output schema

The box below lists all warning 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.

Nach oben