GetCustomerDeliveryAddresses

The GetCustomerDeliveryAddresses call returns a list of delivery addresses for a customer.

This call is available since SOAP version 100.
One of the following IDs has to be transmitted in order to identify the customer: CustomerID, DeliveryAddressID, ExternalDeliveryAddressID.
You can use the parameter Page to specify which page you want to retrieve. In the response object, the value Pages indicates how many pages can be retrieved in total. If you want to retrieve the first page, then you have to use the value 0 as the Page parameter (this is the default numbering scheme for retrieving pages). The last page has the value Pages minus 1.
A maximum of 50 customers can be returned per call.

GetCustomerDeliveryAddresses Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
CustomerID Integer Required Customer ID 105
DeliveryAddressID Integer Required Delivery address ID 105
ExternalDeliveryAddressID String Required External delivery address ID 105
Page Integer Optional Page 105
TimestampFrom Integer Optional Last update from 105
TimestampTill Integer Optional Last update till 105

GetCustomerDeliveryAddresses 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_GetCustomerDeliveryAddresses>
<Page>Integer</Page>
</PlentySoapRequest_GetCustomerDeliveryAddresses>

GetCustomerDeliveryAddresses Output

Field Type Occurrence Meaning Available since
DeliveryAddresses ObjectOptional Liste with delivery addresses 105
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
AdditionalName
String Optional Additional name 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
City
String Required City 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
Company
String Optional Company 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
CountryID
Integer Required Country ID 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
CustomerID
Integer Required Customer ID 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
DeliveryAddressID
Integer Optional Delivery address ID 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
Email
String Optional E-mail address 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
Evaluation
String Optional Evaluation 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
ExternalDeliveryAddressID
String Optional External delivery address ID 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
Fax
String Optional Fax number 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
FirstName
String Required First name 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
FormOfAddress
Integer Optional Form of address 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
HouseNumber
String Required House number 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
PackstationNr
String Optional PackstationNr 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
Postident
String Optional Postident 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
Street
String Required Street 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
Surname
String Required Surname 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
Telephone
String Optional Telephone number 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
VAT_number
String Optional VAT Number 112
DeliveryAddresses.
PlentySoapResponse_ObjectGetCustomerDeliveryAddresses.
ZIP
String Required ZIP 112
Pages Integer Optional Pages 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

GetCustomerDeliveryAddresses 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_GetCustomerDeliveryAddresses>
<Pages>Integer</Pages>
<Success>Boolean</Success>
</PlentySoapResponse_GetCustomerDeliveryAddresses>

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 - - - The delivery address was successfully loaded. The delivery address ID is returned.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 At least one of the following parameter is needed: CustomerID;DeliveryAddressID;ExternalDeliveryAddressID Too few parameter have been given. For this call at least one of the defined request parameter are needed.
800 Unable to load data records The data records were not loaded

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.

Warnings

Code Key Value Message Explanation
110 Page Unused parameter Parameter was not entered. A default value was used for the call.
110 No data No data found No customer delivery addresses found for the given request data.

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.

<Warnings>
<item>
<Value>Unused parameter</Value>
</item>
<item> </item>
</Warnings>
Nach oben