SetReturns

The SetReturns call adds a return sales order.

This call is available since SOAP version 100.

SetReturns Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
CustomerID Integer Optional Customer ID 105
OrderID Integer Required Sales order ID 105
OrderStatus Double Optional Sales order status 105
PackageNumber String Optional Package number 105
ReasonForReturnID Integer Optional Reason for return ID 105
ReturnItems ObjectOptional List of return items 105
ReturnItems.
PlentySoapObject_SetReturns.
Comment
String Optional Comment on item position 105
ReturnItems.
PlentySoapObject_SetReturns.
ItemID
Integer Required Item ID 105
ReturnItems.
PlentySoapObject_SetReturns.
ItemStatusID
Integer Optional Item status ID 105
ReturnItems.
PlentySoapObject_SetReturns.
Quantity
Double Required Number 105
ReturnItems.
PlentySoapObject_SetReturns.
RemainingPercentage
Integer Optional Percentage of the value of items 105
ReturnItems.
PlentySoapObject_SetReturns.
SKU
String Required SKU 105

SetReturns 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_SetReturns>
<OrderID>Integer</OrderID>
</PlentySoapRequest_SetReturns>

SetReturns 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

SetReturns 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 - - - Return 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 OrderStatus Missing parameter Required parameter was not entered
800 OrderStatus Invalid parameter The value of entered parameter is not allowed
800 ReasonForReturnID Missing parameter Required parameter was not entered
800 ReturnItem Missing parameter Required parameter was not entered
800 Error Adding Return Error while adding the return
810 Limit 50 Max items limit 50 The request contains more items than the maximum of 50 items

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>OrderStatus</Key>
</item>
<item>
<Value>Invalid parameter</Value>
<Key>OrderStatus</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>ReasonForReturnID</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>ReturnItem</Key>
</item>
<item> </item>
</ErrorMessages>

Warnings

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben