GetReturnOrdersByQuery
This function allows getting multiple return orders within a certain search critera.
Tags: GetReturnOrdersByQuery, ReturnOrdersQuery, GetReturnOrdersByQueryResult, ReturnOrderLineInfo
Request XML
POST /xxx/service.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/WSI/GetReturnOrdersByQuery"
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetReturnOrdersByQuery xmlns="http://ongoingsystems.se/WSI">
<GoodsOwnerCode>string</GoodsOwnerCode>
<UserName>string</UserName>
<Password>string</Password>
<ReturnOrdersQuery>
<CustomerOrderNumbersToGet>
<string>string</string>
<string>string</string>
</CustomerOrderNumbersToGet>
<ReturnOrderNumbersToGet>
<string>string</string>
<string>string</string>
</ReturnOrderNumbersToGet>
<GoodsReturnedFromDate>dateTime</GoodsReturnedFromDate>
<ReturnOrderStatusFrom>int</ReturnOrderStatusFrom>
<RetunOrderStatusTo>int</RetunOrderStatusTo>
</ReturnOrdersQuery>
</GetReturnOrdersByQuery>
</soap:Body>
</soap:Envelope>
Request specification
GetReturnOrdersByQuery |
GoodsOwnerCode |
str(400) |
Req. |
The name/code of your client |
UserName |
str(50) |
Req. |
Your username |
Password |
str(50) |
Req. |
Your password |
ReturnOrdersQuery |
ReturnOrdersQuery |
Req. |
Specifies the query/search criteria |
ReturnOrdersQuery |
CustomerOrderNumbersToGet |
collection of strings |
Optional |
A list of goods owners order number. |
ReturnOrderNumbersToGet |
collection of string |
Optional |
A list of goods owners return order numbers |
GoodsReturnedFromDate |
DatTime |
Optional |
Filter only return orders return from a certain date. Preferably used with current date when polling. |
ReturnOrderStatusFrom |
Integer |
Optional |
Return order status from. |
RetunOrderStatusTo |
Integer |
Optional |
Return order status to. |
Response XML
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetReturnOrdersByQueryResponse xmlns="http://ongoingsystems.se/WSI">
<GetReturnOrdersByQueryResult>
<Success>boolean</Success>
<ReturnOrders>
<ReturnOrderInfo>
<OrderId>int</OrderId>
<OrderNumber>string</OrderNumber>
<ReturnOrderId>int</ReturnOrderId>
<ReturnOrderNumber>string</ReturnOrderNumber>
<ReturnOrderComment>string</ReturnOrderComment>
<ReturnInDate>dateTime</ReturnInDate>
<ReturnCauseCode>string</ReturnCauseCode>
<ReturnCauseName>string</ReturnCauseName>
<ReturnCauseId>int</ReturnCauseId>
<ReturnOrderLines xsi:nil="true" />
<ReturnOrderStatusId>int</ReturnOrderStatusId>
<ReturnOrderStatusText>string</ReturnOrderStatusText>
<Warehouse>
<Name>string</Name>
<Code>string</Code>
<Id>int</Id>
</Warehouse>
</ReturnOrderInfo>
<ReturnOrderInfo>
<OrderId>int</OrderId>
<OrderNumber>string</OrderNumber>
<ReturnOrderId>int</ReturnOrderId>
<ReturnOrderNumber>string</ReturnOrderNumber>
<ReturnOrderComment>string</ReturnOrderComment>
<ReturnInDate>dateTime</ReturnInDate>
<ReturnCauseCode>string</ReturnCauseCode>
<ReturnCauseName>string</ReturnCauseName>
<ReturnCauseId>int</ReturnCauseId>
<ReturnOrderLines xsi:nil="true" />
<ReturnOrderStatusId>int</ReturnOrderStatusId>
<ReturnOrderStatusText>string</ReturnOrderStatusText>
<Warehouse>
<Name>string</Name>
<Code>string</Code>
<Id>int</Id>
</Warehouse>
</ReturnOrderInfo>
</ReturnOrders>
<GetReturnOrdersErrors>
<GetReturnOrdersError>
<Message>string</Message>
<ErrorType>UnknownError or LogonError</ErrorType>
</GetReturnOrdersError>
<GetReturnOrdersError>
<Message>string</Message>
<ErrorType>UnknownError or LogonError</ErrorType>
</GetReturnOrdersError>
</GetReturnOrdersErrors>
</GetReturnOrdersByQueryResult>
</GetReturnOrdersByQueryResponse>
</soap:Body>
</soap:Envelope>
Response specification
GetReturnOrdersByQueryResult |
OrderId |
int |
Unique internal identifier of the sales order which the return order is bound to. |
OrderNumber |
string |
Goods owner unique sales order number which the return order is bound to. |
ReturnOrderId |
int |
Unique internal identifier of the return order. |
ReturnOrderNumber |
string |
The order number of the return order. Specified by goods owner. |
ReturnOrderComment |
string |
Comment to the warehouse. |
ReturnInDate |
DateTime |
Date of arrival of the return goods |
ReturnCauseCode |
string |
Shortening for return cause. |
ReturnCauseName |
string |
Name of the return cause. |
ReturnCauseId |
int |
Unique internal identifier of the return cause. |
ReturnOrderLines |
Collection of ReturnOrderLineInfo |
The lines in the return. |
ReturnOrderStatusId |
int |
Integer representing the status of the return order. |
ReturnOrderStatusText |
str(50) |
The name of the return order status. |
Warehouse |
object |
Contains information about the warehouse which the order is supposed to be returned to. |
ReturnOrderLineInfo |
ArticleName |
string |
Name of the article. |
ArticleNumber |
string |
Goods owners identifier of the article. |
ReturnOrderLineId |
int |
Unique identifier of the line within a return order. |
ExternalOrderLineCode |
string |
Goods owners identifier of the row. |
PickedNumberOfItems |
decimal |
The number of picked items on the original sales order. |
ToBeReturnedNumberOfItems |
decimal |
The number of items to be returned. |
ReturnedNumberOfItems |
decimal |
The total number of items returned to the warehouse. Includes both items which were immediately discarded, and those there weren't discarded. |
ReturnCauseCode |
string |
Short name of the return cause. |
ReturnCauseName |
optional string |
Name of the return cause. |
ReturnCauseId |
integer |
Unique internal identifier for the return cause. |
ReturnOrderRowNumber |
string |
The row number used by external system. |
ParentReturnOrderLineId |
Optional int |
Used only if return order lines are nested. For example if articles consists of other articles. |
ReturnedRemovedByInventoryNumberOfItems |
decimal |
The number of items returned to the warehouse and which were immediately discarded. |