DELETE api/ReturnOrder

Cancel Return Order

Request Information

URI Parameters

None.

Body Parameters

Return Order message

Name	Description	Type	Additional information
Header	Header item	MessageHeader	None.
ReturnOrders	List of Return Orders	Collection of CancelReturnOrder	None.
Footer	Footer item	MessageFooter	None.

Request Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "ReturnOrders": [
    {
      "CompanyIdentifier": "string 1",
      "ReturnOrderIdentifier": "string 2",
      "LineIdentifier": 1,
      "LineIdentifierSpecified": true
    },
    {
      "CompanyIdentifier": "string 1",
      "ReturnOrderIdentifier": "string 2",
      "LineIdentifier": 1,
      "LineIdentifierSpecified": true
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<CancelReturnOrderMessageRequest 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>
  <ReturnOrders>
    <CancelReturnOrder>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <ReturnOrderIdentifier>string 2</ReturnOrderIdentifier>
      <LineIdentifier>1</LineIdentifier>
      <LineIdentifierSpecified>true</LineIdentifierSpecified>
    </CancelReturnOrder>
    <CancelReturnOrder>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <ReturnOrderIdentifier>string 2</ReturnOrderIdentifier>
      <LineIdentifier>1</LineIdentifier>
      <LineIdentifierSpecified>true</LineIdentifierSpecified>
    </CancelReturnOrder>
  </ReturnOrders>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</CancelReturnOrderMessageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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

CancelReturnOrderMessageResponse

Name	Description	Type	Additional information
Header	Header item	MessageHeader	None.
CancelReturnOrderResult	List of Return Order cancel result	Collection of CancelReturnOrderResult	None.
Footer	Footer item	MessageFooter	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "CancelReturnOrderResult": [
    {
      "CompanyIdentifier": "string 1",
      "OrderIdentifier": "string 2",
      "LineIdentifier": 1,
      "LineIdentifierSpecified": true,
      "ProcessingStatus": "P",
      "ReturnOrderImportResult": "string 4"
    },
    {
      "CompanyIdentifier": "string 1",
      "OrderIdentifier": "string 2",
      "LineIdentifier": 1,
      "LineIdentifierSpecified": true,
      "ProcessingStatus": "P",
      "ReturnOrderImportResult": "string 4"
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<CancelReturnOrderMessageResponse 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>
  <CancelReturnOrderResult>
    <CancelReturnOrderResult>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <OrderIdentifier>string 2</OrderIdentifier>
      <LineIdentifier>1</LineIdentifier>
      <LineIdentifierSpecified>true</LineIdentifierSpecified>
      <ProcessingStatus>P</ProcessingStatus>
      <ReturnOrderImportResult>string 4</ReturnOrderImportResult>
    </CancelReturnOrderResult>
    <CancelReturnOrderResult>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <OrderIdentifier>string 2</OrderIdentifier>
      <LineIdentifier>1</LineIdentifier>
      <LineIdentifierSpecified>true</LineIdentifierSpecified>
      <ProcessingStatus>P</ProcessingStatus>
      <ReturnOrderImportResult>string 4</ReturnOrderImportResult>
    </CancelReturnOrderResult>
  </CancelReturnOrderResult>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</CancelReturnOrderMessageResponse>