DELETE api/SalesOrder

Cancel Sales Order

Request Information

URI Parameters

None.

Body Parameters

Sales Order message

Name	Description	Type	Additional information
Header	Header item	MessageHeader	None.
SalesOrders	List of Sales Orders	Collection of CancelSalesOrder	None.
Footer	Footer item	MessageFooter	None.

Request Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "SalesOrders": [
    {
      "CompanyIdentifier": "string 1",
      "SalesOrderIdentifier": "string 2",
      "LineIdentifier": 1,
      "LineIdentifierSpecified": true,
      "SequenceIdentifier": 1,
      "SequenceIdentifierSpecified": true
    },
    {
      "CompanyIdentifier": "string 1",
      "SalesOrderIdentifier": "string 2",
      "LineIdentifier": 1,
      "LineIdentifierSpecified": true,
      "SequenceIdentifier": 1,
      "SequenceIdentifierSpecified": true
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<CancelSalesOrderMessageRequest 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>
  <SalesOrders>
    <CancelSalesOrder>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <SalesOrderIdentifier>string 2</SalesOrderIdentifier>
      <LineIdentifier>1</LineIdentifier>
      <LineIdentifierSpecified>true</LineIdentifierSpecified>
      <SequenceIdentifier>1</SequenceIdentifier>
      <SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
    </CancelSalesOrder>
    <CancelSalesOrder>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <SalesOrderIdentifier>string 2</SalesOrderIdentifier>
      <LineIdentifier>1</LineIdentifier>
      <LineIdentifierSpecified>true</LineIdentifierSpecified>
      <SequenceIdentifier>1</SequenceIdentifier>
      <SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
    </CancelSalesOrder>
  </SalesOrders>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</CancelSalesOrderMessageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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

CancelSalesOrderMessageResponse

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

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "CancelSalesOrderResult": [
    {
      "CompanyIdentifier": "string 1",
      "OrderIdentifier": "string 2",
      "LineIdentifier": 1,
      "LineIdentifierSpecified": true,
      "SequenceIdentifier": 1,
      "SequenceIdentifierSpecified": true,
      "ProcessingStatus": "P",
      "SalesOrderImportResult": "string 5"
    },
    {
      "CompanyIdentifier": "string 1",
      "OrderIdentifier": "string 2",
      "LineIdentifier": 1,
      "LineIdentifierSpecified": true,
      "SequenceIdentifier": 1,
      "SequenceIdentifierSpecified": true,
      "ProcessingStatus": "P",
      "SalesOrderImportResult": "string 5"
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<CancelSalesOrderMessageResponse 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>
  <CancelSalesOrderResult>
    <CancelSalesOrderResult>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <OrderIdentifier>string 2</OrderIdentifier>
      <LineIdentifier>1</LineIdentifier>
      <LineIdentifierSpecified>true</LineIdentifierSpecified>
      <SequenceIdentifier>1</SequenceIdentifier>
      <SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
      <ProcessingStatus>P</ProcessingStatus>
      <SalesOrderImportResult>string 5</SalesOrderImportResult>
    </CancelSalesOrderResult>
    <CancelSalesOrderResult>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <OrderIdentifier>string 2</OrderIdentifier>
      <LineIdentifier>1</LineIdentifier>
      <LineIdentifierSpecified>true</LineIdentifierSpecified>
      <SequenceIdentifier>1</SequenceIdentifier>
      <SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
      <ProcessingStatus>P</ProcessingStatus>
      <SalesOrderImportResult>string 5</SalesOrderImportResult>
    </CancelSalesOrderResult>
  </CancelSalesOrderResult>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</CancelSalesOrderMessageResponse>