GET api/RmaReceiptPackage?companyCode={companyCode}&returnOrderIdentifier={returnOrderIdentifier}&code={code}
Get a specific Rma Receipt Package per order.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyCode |
Company Identifier |
string |
Required |
| returnOrderIdentifier |
Return Order Identifier |
string |
Required |
| code |
RMA Receipt Package Code. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Response message with requested Rma Receipt Package. HttpStatusCode.Conflict when user isn't connected to Company
GetRmaReceiptPackageMessageResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header |
Header item |
MessageHeader |
None. |
| RmaReceiptPackageResult |
List of RMA Receipt Packages result |
Collection of RmaReceiptPackageBase |
None. |
| Footer |
Footer item |
MessageFooter |
None. |
Response Formats
application/json, text/json
Sample:
{
"Header": {
"Version": "string 1",
"Identification": "string 2",
"Sender": "string 3"
},
"RmaReceiptPackageResult": [
{
"ReturnOrderIdentifier": "string 1",
"CompanyIdentifier": "string 2",
"Quantity": 1,
"QuantitySpecified": true,
"Code": "string 4",
"CodeType": "TrackAndTrace",
"Status": "New"
},
{
"ReturnOrderIdentifier": "string 1",
"CompanyIdentifier": "string 2",
"Quantity": 1,
"QuantitySpecified": true,
"Code": "string 4",
"CodeType": "TrackAndTrace",
"Status": "New"
}
],
"Footer": {
"TotalRecords": 1,
"Records": 2
}
}
application/xml, text/xml
Sample:
<GetRmaReceiptPackageMessageResponse 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>
<RmaReceiptPackageResult>
<RmaReceiptPackageBase>
<ReturnOrderIdentifier>string 1</ReturnOrderIdentifier>
<CompanyIdentifier>string 2</CompanyIdentifier>
<Quantity>1</Quantity>
<QuantitySpecified>true</QuantitySpecified>
<Code>string 4</Code>
<CodeType>TrackAndTrace</CodeType>
<Status>New</Status>
</RmaReceiptPackageBase>
<RmaReceiptPackageBase>
<ReturnOrderIdentifier>string 1</ReturnOrderIdentifier>
<CompanyIdentifier>string 2</CompanyIdentifier>
<Quantity>1</Quantity>
<QuantitySpecified>true</QuantitySpecified>
<Code>string 4</Code>
<CodeType>TrackAndTrace</CodeType>
<Status>New</Status>
</RmaReceiptPackageBase>
</RmaReceiptPackageResult>
<Footer>
<TotalRecords>1</TotalRecords>
<Records>2</Records>
</Footer>
</GetRmaReceiptPackageMessageResponse>