POST api/ReturnOrderTransactions?companyCode={companyCode}

Set Transaction Status to Processed

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	Company Identifier	string	Required

Body Parameters

Message with Transaction Identifiers to set to processed

SetTransactionProcessedMessageRequest

Name	Type	Additional information
Header	MessageHeader	None.
Identifiers	Collection of integer	None.
Footer	MessageFooter	None.

Request Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "Identifiers": [
    1,
    2
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<SetTransactionProcessedMessageRequest 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>
  <Identifiers>
    <int>1</int>
    <int>2</int>
  </Identifiers>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</SetTransactionProcessedMessageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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

SetTransactionProcessedMessageResponse

Name	Type	Additional information
Header	MessageHeader	None.
TransactionProcesedStatus	Collection of TransactionListProcessedResponseItem	None.
ProcessingMessage	string	None.
Footer	MessageFooter	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "TransactionProcesedStatus": [
    {
      "TransactionIdentifier": 1,
      "ProcessingStatus": "P",
      "ProcessingMessage": "string 2"
    },
    {
      "TransactionIdentifier": 1,
      "ProcessingStatus": "P",
      "ProcessingMessage": "string 2"
    }
  ],
  "ProcessingMessage": "string 1",
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<SetTransactionProcessedMessageResponse 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>
  <TransactionProcesedStatus>
    <TransactionListProcessedResponseItem>
      <TransactionIdentifier>1</TransactionIdentifier>
      <ProcessingStatus>P</ProcessingStatus>
      <ProcessingMessage>string 2</ProcessingMessage>
    </TransactionListProcessedResponseItem>
    <TransactionListProcessedResponseItem>
      <TransactionIdentifier>1</TransactionIdentifier>
      <ProcessingStatus>P</ProcessingStatus>
      <ProcessingMessage>string 2</ProcessingMessage>
    </TransactionListProcessedResponseItem>
  </TransactionProcesedStatus>
  <ProcessingMessage>string 1</ProcessingMessage>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</SetTransactionProcessedMessageResponse>