AddClientOrderCustomer

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

This call is available since SOAP version 109.

AddClientOrderCustomer Input

Field Type Occurrence Meaning Available since
DeliveryAddress ObjectOptional Delivery address 109
DeliveryAddress.
PlentySoapObject_AddClientOrderCustomerDeliveryAddress.
City
String Optional City 109
DeliveryAddress.
PlentySoapObject_AddClientOrderCustomerDeliveryAddress.
Country
String Optional Country (DE, EN, FR) 109
DeliveryAddress.
PlentySoapObject_AddClientOrderCustomerDeliveryAddress.
CountryID
Integer Optional CountryID 109
DeliveryAddress.
PlentySoapObject_AddClientOrderCustomerDeliveryAddress.
FirstName
String Optional First name 109
DeliveryAddress.
PlentySoapObject_AddClientOrderCustomerDeliveryAddress.
HouseNumber
String Optional House number 109
DeliveryAddress.
PlentySoapObject_AddClientOrderCustomerDeliveryAddress.
Street
String Optional Street 109
DeliveryAddress.
PlentySoapObject_AddClientOrderCustomerDeliveryAddress.
Surname
String Optional Surname 109
DeliveryAddress.
PlentySoapObject_AddClientOrderCustomerDeliveryAddress.
ZIP
String Optional ZIP code 109
InvoiceAddress ObjectOptional Invoice address 109
InvoiceAddress.
PlentySoapObject_AddClientOrderCustomerInvoiceAddress.
City
String Optional City 109
InvoiceAddress.
PlentySoapObject_AddClientOrderCustomerInvoiceAddress.
Country
String Optional Country (DE, EN, FR) 109
InvoiceAddress.
PlentySoapObject_AddClientOrderCustomerInvoiceAddress.
CountryID
Integer Optional Country 109
InvoiceAddress.
PlentySoapObject_AddClientOrderCustomerInvoiceAddress.
FirstName
String Optional First name 109
InvoiceAddress.
PlentySoapObject_AddClientOrderCustomerInvoiceAddress.
HouseNumber
String Optional House number 109
InvoiceAddress.
PlentySoapObject_AddClientOrderCustomerInvoiceAddress.
Street
String Optional Street 109
InvoiceAddress.
PlentySoapObject_AddClientOrderCustomerInvoiceAddress.
Surname
String Optional Surname 109
InvoiceAddress.
PlentySoapObject_AddClientOrderCustomerInvoiceAddress.
ZIP
String Optional ZIP code 109
MethodOfPaymentID Integer Optional ID of the method of payment 109
OrderID Integer Required ID of the order 109
TransactionNumber String Optional payment transaction number 109

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

AddClientOrderCustomer Output

Field Type Occurrence Meaning Available since
CustomerID Integer Optional Customer ID 109
ResponseMessages not definedOptional 112
Success not definedOptional 112

AddClientOrderCustomer 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_AddClientOrderCustomer> </PlentySoapResponse_AddClientOrderCustomer>

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 CustomerID 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>CustomerID</Key>
</item>
</Success>

Error messages

Code Key Value Message Explanation
800 OrderID Missing parameter External sales order ID is invalid or was not entered

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>
</ErrorMessages>

Warnings

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben