GetReturns

The GetReturns call provides a list of returns. You can specify additional parameters to filter which returns you are searching for (e.g. only returns that are in a specific status).

This call is available since SOAP version 100.
It is important to work with the LastUpdate parameter. It is technically possible to give this parameter the value 0, but doing so would provide you with all of the returns in your system. After having retrieved all of the returns one time, you should only use LastUpdate to retrieve returns incrementally.
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 150 returns can be provided per call.

GetReturns Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
ExternalReturnID String Required External return ID 105
LastUpdate Integer Required Timestamp of the last update 105
Page Integer Optional Page 105
ReferrerID Integer Required Sales order referrer 105
ReturnStatus Double Required Sales order status 105

GetReturns 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_GetReturns>
<Page>Integer</Page>
</PlentySoapRequest_GetReturns>

GetReturns Output

Field Type Occurrence Meaning Available since
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
Returns ObjectOptional List of sales order 105
Returns.
PlentySoapObject_Return.
ReturnHead
ObjectOptional Retouren Daten 105
Returns.
PlentySoapObject_Return.
ReturnHead.
PlentySoapObject_ReturnHead.
ExternalReturnID
String Optional Externe ID des Auftrags 105
Returns.
PlentySoapObject_Return.
ReturnHead.
PlentySoapObject_ReturnHead.
OrderID
Integer Optional ID des Auftrags 105
Returns.
PlentySoapObject_Return.
ReturnHead.
PlentySoapObject_ReturnHead.
ReasonForReturnID
Integer Optional ID des Retourengrundes 105
Returns.
PlentySoapObject_Return.
ReturnHead.
PlentySoapObject_ReturnHead.
ReturnForExternalOrderID
String Optional Externe AuftragsID des Hauptauftrags 105
Returns.
PlentySoapObject_Return.
ReturnHead.
PlentySoapObject_ReturnHead.
ReturnForOrderID
Integer Optional AuftragsID des Hauptauftrags 105
Returns.
PlentySoapObject_Return.
ReturnHead.
PlentySoapObject_ReturnHead.
ReturnStatus
Double Optional Auftragsstatus 105
Returns.
PlentySoapObject_Return.
ReturnItems
ObjectOptional Retouren Artikel 105
Returns.
PlentySoapObject_Return.
ReturnItems.
PlentySoapObject_ReturnItem.
Comment
String Optional Kommentar zur Artikelposition 105
Returns.
PlentySoapObject_Return.
ReturnItems.
PlentySoapObject_ReturnItem.
ExternalItemID
String Optional External item id 105
Returns.
PlentySoapObject_Return.
ReturnItems.
PlentySoapObject_ReturnItem.
ItemStatusID
Integer Optional item status id 105
Returns.
PlentySoapObject_Return.
ReturnItems.
PlentySoapObject_ReturnItem.
OrderRowID
Integer Optional Order row id 105
Returns.
PlentySoapObject_Return.
ReturnItems.
PlentySoapObject_ReturnItem.
Quantity
Double Optional quantity 105
Returns.
PlentySoapObject_Return.
ReturnItems.
PlentySoapObject_ReturnItem.
RemainingPercentage
Integer Optional Remaining percentage 105
Returns.
PlentySoapObject_Return.
ReturnItems.
PlentySoapObject_ReturnItem.
SKU
String Optional Item SKU 105
Success Boolean Optional Has the value true or false, depending on whether a request worked. 112

GetReturns 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
ExternalReturnID 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 - - - Return was successfully returned.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 Too few parameters were given At least one of these parameters needs to be set: ReturnStatus, ExternalReturnID, ReferrerID, LastUpdate.
800 quelle status settings required The parameters quelle, status, settings are required.

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 No data No data found No search result is available for the parameters that were entered.
110 Page Unused parameter Parameter was not entered. A default value was used for the call.
110 LastUpdate Unused parameter Parameter was not entered. A default value was used for the call.

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> </item>
<item>
<Value>Unused parameter</Value>
</item>
<item>
<Value>Unused parameter</Value>
<Key>LastUpdate</Key>
</item>
</Warnings>
Nach oben