POST api/RmaReceiptPackage

Add or update Rma Receipt Package.

Request Information

URI Parameters

None.

Body Parameters

Rma Receipt Package Message

Name	Description	Type	Additional information
Header	Header item	MessageHeader	None.
RmaReceiptPackages	List of RMA Receipt Packages	Collection of RmaReceiptPackageBase	None.
Footer	Footer item	MessageFooter	None.

Request Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "RmaReceiptPackages": [
    {
      "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:

<PutRmaReceiptPackageMessageRequest 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>
  <RmaReceiptPackages>
    <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>
  </RmaReceiptPackages>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</PutRmaReceiptPackageMessageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OK: Message with result. Invalid APIKey: HttpStatusCode.Conflict

PutRmaReceiptPackageMessageResponse

Name	Description	Type	Additional information
Header	Header item	MessageHeader	None.
RmaReceiptPackageResult	List of RMA Receipt Packages result	Collection of RmaReceiptPackageResult	None.
Footer	Footer item	MessageFooter	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "RmaReceiptPackageResult": [
    {
      "CompanyIdentifier": "string 1",
      "ReturnOrderIdentifier": "string 2",
      "Code": "string 3",
      "ProcessingStatus": "P",
      "RmaReceiptPackageImportResult": "string 4"
    },
    {
      "CompanyIdentifier": "string 1",
      "ReturnOrderIdentifier": "string 2",
      "Code": "string 3",
      "ProcessingStatus": "P",
      "RmaReceiptPackageImportResult": "string 4"
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<PutRmaReceiptPackageMessageResponse 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>
    <RmaReceiptPackageResult>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <ReturnOrderIdentifier>string 2</ReturnOrderIdentifier>
      <Code>string 3</Code>
      <ProcessingStatus>P</ProcessingStatus>
      <RmaReceiptPackageImportResult>string 4</RmaReceiptPackageImportResult>
    </RmaReceiptPackageResult>
    <RmaReceiptPackageResult>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <ReturnOrderIdentifier>string 2</ReturnOrderIdentifier>
      <Code>string 3</Code>
      <ProcessingStatus>P</ProcessingStatus>
      <RmaReceiptPackageImportResult>string 4</RmaReceiptPackageImportResult>
    </RmaReceiptPackageResult>
  </RmaReceiptPackageResult>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</PutRmaReceiptPackageMessageResponse>