SetOrderStatus

Use the SetOrderStatus call to set the statuses of sales orders. You can either use the OrderID or the ExternalOrderID to specify which sales orders you want to use.

This call is available since SOAP version 100.
Please note that all of the procedures that are tied to a status will be carried out.

SetOrderStatus Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
OrderStatus ObjectRequired List of order statuses 105
OrderStatus.
PlentySoapObject_SetOrderStatus.
ExternalOrderID
Integer Required External oder ID 105
OrderStatus.
PlentySoapObject_SetOrderStatus.
OrderID
Integer Required Order ID 105
OrderStatus.
PlentySoapObject_SetOrderStatus.
OrderStatus
Double Required Sales order status 105
OrderStatus.
PlentySoapObject_SetOrderStatus.
Responsible
Integer Optional The person responsible ID 105

SetOrderStatus 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_SetOrderStatus> </PlentySoapRequest_SetOrderStatus>

SetOrderStatus 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

SetOrderStatus 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 - - - The status for this sales order ID was successfully changed.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 OrderID Invalid parameter The value of entered parameter is not allowed
800 OrderStatus Missing parameter Required parameter was not entered
800 OrderID Missing parameter Required parameter was not entered
800 ExternalOrderID Missing parameter Required parameter was not entered
800 OrderID Error when setting the sales order status
r 810 Limit 50 Max item 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>Invalid parameter</Value>
<Key>OrderID</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>OrderStatus</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>OrderID</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>ExternalOrderID</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