PUT api/SalesOrder

Toggle Order Status

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Header	Header item	MessageHeader	None.
SalesOrders	List of Sales orders with hold/release flags	Collection of HoldReleaseOrderLine	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": 3,
      "SequenceIdentifier": 1,
      "SequenceIdentifierSpecified": true,
      "IsHeld": true
    },
    {
      "CompanyIdentifier": "string 1",
      "SalesOrderIdentifier": "string 2",
      "LineIdentifier": 3,
      "SequenceIdentifier": 1,
      "SequenceIdentifierSpecified": true,
      "IsHeld": true
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<ToggleOrderStatusMessageRequest 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>
    <HoldReleaseOrderLine>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <SalesOrderIdentifier>string 2</SalesOrderIdentifier>
      <LineIdentifier>3</LineIdentifier>
      <SequenceIdentifier>1</SequenceIdentifier>
      <SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
      <IsHeld>true</IsHeld>
    </HoldReleaseOrderLine>
    <HoldReleaseOrderLine>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <SalesOrderIdentifier>string 2</SalesOrderIdentifier>
      <LineIdentifier>3</LineIdentifier>
      <SequenceIdentifier>1</SequenceIdentifier>
      <SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
      <IsHeld>true</IsHeld>
    </HoldReleaseOrderLine>
  </SalesOrders>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</ToggleOrderStatusMessageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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

ToggleOrderStatusMessageResponse

Name	Description	Type	Additional information
Header	Header item	MessageHeader	None.
HoldReleaseSalesOrderResult	List of Sales Order Hold Release result	Collection of HoldReleaseSalesOrderResult	None.
Footer	Footer item	MessageFooter	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "HoldReleaseSalesOrderResult": [
    {
      "CompanyIdentifier": "string 1",
      "OrderIdentifier": "string 2",
      "LineIdentifier": 3,
      "SequenceIdentifier": 1,
      "SequenceIdentifierSpecified": true,
      "IsHeld": true,
      "ProcessingStatus": "P",
      "HoldReleaseSalesOrderResultMessage": "string 6"
    },
    {
      "CompanyIdentifier": "string 1",
      "OrderIdentifier": "string 2",
      "LineIdentifier": 3,
      "SequenceIdentifier": 1,
      "SequenceIdentifierSpecified": true,
      "IsHeld": true,
      "ProcessingStatus": "P",
      "HoldReleaseSalesOrderResultMessage": "string 6"
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<ToggleOrderStatusMessageResponse 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>
  <HoldReleaseSalesOrderResult>
    <HoldReleaseSalesOrderResult>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <OrderIdentifier>string 2</OrderIdentifier>
      <LineIdentifier>3</LineIdentifier>
      <SequenceIdentifier>1</SequenceIdentifier>
      <SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
      <IsHeld>true</IsHeld>
      <ProcessingStatus>P</ProcessingStatus>
      <HoldReleaseSalesOrderResultMessage>string 6</HoldReleaseSalesOrderResultMessage>
    </HoldReleaseSalesOrderResult>
    <HoldReleaseSalesOrderResult>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <OrderIdentifier>string 2</OrderIdentifier>
      <LineIdentifier>3</LineIdentifier>
      <SequenceIdentifier>1</SequenceIdentifier>
      <SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
      <IsHeld>true</IsHeld>
      <ProcessingStatus>P</ProcessingStatus>
      <HoldReleaseSalesOrderResultMessage>string 6</HoldReleaseSalesOrderResultMessage>
    </HoldReleaseSalesOrderResult>
  </HoldReleaseSalesOrderResult>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</ToggleOrderStatusMessageResponse>