GET api/ReturnOrder?companyCode={companyCode}
Get Return Order Identifier List
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyCode |
Company Identifier |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Response message with a list of all Return Orders. HttpStatusCode.Conflict when user isn't connected to Company
GetReturnOrderListMessageResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header |
Header item |
MessageHeader |
None. |
| ReturnOrderIdentifiers |
List of Return Orders |
Collection of string |
None. |
| Footer |
Footer item |
MessageFooter |
None. |
Response Formats
application/json, text/json
Sample:
{
"Header": {
"Version": "string 1",
"Identification": "string 2",
"Sender": "string 3"
},
"ReturnOrderIdentifiers": [
"string 1",
"string 2"
],
"Footer": {
"TotalRecords": 1,
"Records": 2
}
}
application/xml, text/xml
Sample:
<GetReturnOrderListMessageResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Header>
<Version>string 1</Version>
<Identification>string 2</Identification>
<Sender>string 3</Sender>
</Header>
<ReturnOrderIdentifiers>
<string>string 1</string>
<string>string 2</string>
</ReturnOrderIdentifiers>
<Footer>
<TotalRecords>1</TotalRecords>
<Records>2</Records>
</Footer>
</GetReturnOrderListMessageResponse>