PATCH api/SalesOrder?companyCode={companyCode}
Release Order from Hold process
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyCode |
Company Identifier |
string |
Required |
Body Parameters
ReleaseSalesOrderFromHoldMessageRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Header |
Header item |
MessageHeader |
None. |
| SalesOrders |
List of Sales Orders |
Collection of ReleaseOrderLineFromHold |
None. |
| Footer |
Footer item |
MessageFooter |
None. |
Request Formats
application/json, text/json
Sample:
{
"Header": {
"Version": "string 1",
"Identification": "string 2",
"Sender": "string 3"
},
"SalesOrders": [
{
"SalesOrderIdentifier": "string 1",
"LineIdentifier": 1,
"LineIdentifierSpecified": true,
"SequenceIdentifier": 1,
"SequenceIdentifierSpecified": true,
"PromisedDeliveryDate": "2025-12-06T03:59:11.5964898+01:00",
"PromisedDeliveryDateSpecified": true,
"PromisedDeliveryDateType": "OnDate",
"PromisedDeliveryDateTypeSpecified": true,
"ReleaseType": "Release"
},
{
"SalesOrderIdentifier": "string 1",
"LineIdentifier": 1,
"LineIdentifierSpecified": true,
"SequenceIdentifier": 1,
"SequenceIdentifierSpecified": true,
"PromisedDeliveryDate": "2025-12-06T03:59:11.5964898+01:00",
"PromisedDeliveryDateSpecified": true,
"PromisedDeliveryDateType": "OnDate",
"PromisedDeliveryDateTypeSpecified": true,
"ReleaseType": "Release"
}
],
"Footer": {
"TotalRecords": 1,
"Records": 2
}
}
application/xml, text/xml
Sample:
<ReleaseSalesOrderFromHoldMessageRequest 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>
<ReleaseOrderLineFromHold>
<SalesOrderIdentifier>string 1</SalesOrderIdentifier>
<LineIdentifier>1</LineIdentifier>
<LineIdentifierSpecified>true</LineIdentifierSpecified>
<SequenceIdentifier>1</SequenceIdentifier>
<SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
<PromisedDeliveryDate>2025-12-06T03:59:11.5964898+01:00</PromisedDeliveryDate>
<PromisedDeliveryDateSpecified>true</PromisedDeliveryDateSpecified>
<PromisedDeliveryDateType>OnDate</PromisedDeliveryDateType>
<PromisedDeliveryDateTypeSpecified>true</PromisedDeliveryDateTypeSpecified>
<ReleaseType>Release</ReleaseType>
</ReleaseOrderLineFromHold>
<ReleaseOrderLineFromHold>
<SalesOrderIdentifier>string 1</SalesOrderIdentifier>
<LineIdentifier>1</LineIdentifier>
<LineIdentifierSpecified>true</LineIdentifierSpecified>
<SequenceIdentifier>1</SequenceIdentifier>
<SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
<PromisedDeliveryDate>2025-12-06T03:59:11.5964898+01:00</PromisedDeliveryDate>
<PromisedDeliveryDateSpecified>true</PromisedDeliveryDateSpecified>
<PromisedDeliveryDateType>OnDate</PromisedDeliveryDateType>
<PromisedDeliveryDateTypeSpecified>true</PromisedDeliveryDateTypeSpecified>
<ReleaseType>Release</ReleaseType>
</ReleaseOrderLineFromHold>
</SalesOrders>
<Footer>
<TotalRecords>1</TotalRecords>
<Records>2</Records>
</Footer>
</ReleaseSalesOrderFromHoldMessageRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Ok: Message with result. Invalid APIKey: HttpStatusCode.Conflict
ReleaseSalesOrderFromHoldMessageResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header |
Header item |
MessageHeader |
None. |
| ReleaseSalesOrderFromHoldResult |
List of Release Sales Order From Hold result |
Collection of ReleaseSalesOrderFromHoldResult |
None. |
| Footer |
Footer item |
MessageFooter |
None. |
Response Formats
application/json, text/json
Sample:
{
"Header": {
"Version": "string 1",
"Identification": "string 2",
"Sender": "string 3"
},
"ReleaseSalesOrderFromHoldResult": [
{
"CompanyIdentifier": "string 1",
"OrderIdentifier": "string 2",
"LineIdentifier": 1,
"LineIdentifierSpecified": true,
"SequenceIdentifier": 1,
"SequenceIdentifierSpecified": true,
"ReleasedType": "Release",
"ProcessingStatus": "P",
"ReleaseSalesOrderFromHoldResultMessage": "string 5"
},
{
"CompanyIdentifier": "string 1",
"OrderIdentifier": "string 2",
"LineIdentifier": 1,
"LineIdentifierSpecified": true,
"SequenceIdentifier": 1,
"SequenceIdentifierSpecified": true,
"ReleasedType": "Release",
"ProcessingStatus": "P",
"ReleaseSalesOrderFromHoldResultMessage": "string 5"
}
],
"Footer": {
"TotalRecords": 1,
"Records": 2
}
}
application/xml, text/xml
Sample:
<ReleaseSalesOrderFromHoldMessageResponse 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>
<ReleaseSalesOrderFromHoldResult>
<ReleaseSalesOrderFromHoldResult>
<CompanyIdentifier>string 1</CompanyIdentifier>
<OrderIdentifier>string 2</OrderIdentifier>
<LineIdentifier>1</LineIdentifier>
<LineIdentifierSpecified>true</LineIdentifierSpecified>
<SequenceIdentifier>1</SequenceIdentifier>
<SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
<ReleasedType>Release</ReleasedType>
<ProcessingStatus>P</ProcessingStatus>
<ReleaseSalesOrderFromHoldResultMessage>string 5</ReleaseSalesOrderFromHoldResultMessage>
</ReleaseSalesOrderFromHoldResult>
<ReleaseSalesOrderFromHoldResult>
<CompanyIdentifier>string 1</CompanyIdentifier>
<OrderIdentifier>string 2</OrderIdentifier>
<LineIdentifier>1</LineIdentifier>
<LineIdentifierSpecified>true</LineIdentifierSpecified>
<SequenceIdentifier>1</SequenceIdentifier>
<SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
<ReleasedType>Release</ReleasedType>
<ProcessingStatus>P</ProcessingStatus>
<ReleaseSalesOrderFromHoldResultMessage>string 5</ReleaseSalesOrderFromHoldResultMessage>
</ReleaseSalesOrderFromHoldResult>
</ReleaseSalesOrderFromHoldResult>
<Footer>
<TotalRecords>1</TotalRecords>
<Records>2</Records>
</Footer>
</ReleaseSalesOrderFromHoldMessageResponse>