GetCustomerOrders

The GetCustomerOrders call uses a specific customer ID (customer number or external customer ID) to return a list of all orders placed by a customer.

This call is available since SOAP version 104.

GetCustomerOrders Input

Field Type Occurrence Meaning Available since
CustomerID Integer Required Customer ID 105
CustomerNo String Required Customer number 105
DateFrom Integer Optional Date from 112
DateTo Integer Optional Date to 112
ExternalCustomerID String Required External customer ID 105

GetCustomerOrders 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_GetCustomerOrders>
<DateFrom>Integer</DateFrom>
<DateTo>Integer</DateTo>
</PlentySoapRequest_GetCustomerOrders>

GetCustomerOrders Output

Field Type Occurrence Meaning Available since
Orders ObjectOptional 105
Orders.
PlentySoapObject_GetCustomerOrders.
OrderID
Integer Optional Sales order ID 105
Orders.
PlentySoapObject_GetCustomerOrders.
OrderTyp
String Optional Sales order type 105
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

GetCustomerOrders 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
CustomerID 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 - - - Orders for the customer matching the specified customer ID were returned.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 ExternalCustomerID Missing parameter Required parameter was not entered
800 CustomerNo Missing parameter Required parameter was not entered
800 CustomerID Missing parameter Required parameter 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>ExternalCustomerID</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>CustomerNo</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 customer orders found for the given request parameters.

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