POST api/OmsBulkActionStatus/submit

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
GroupStatusId	integer	None.
OrderData	Collection of BulkActionOrderData	None.
CancelReasonId	integer	None.
CancelReasonText	string	None.
SendCustomerEmail	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "GroupStatusId": 1,
  "OrderData": [
    {
      "OrderItemId": 1,
      "OrderNumber": "sample string 2",
      "ShipmentNumber": 3
    },
    {
      "OrderItemId": 1,
      "OrderNumber": "sample string 2",
      "ShipmentNumber": 3
    }
  ],
  "CancelReasonId": 2,
  "CancelReasonText": "sample string 3",
  "SendCustomerEmail": true
}

application/xml, text/xml

Sample:

<BulkActionStatusSubmitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <CancelReasonId>2</CancelReasonId>
  <CancelReasonText>sample string 3</CancelReasonText>
  <GroupStatusId>1</GroupStatusId>
  <OrderData xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
    <d2p1:BulkActionOrderData>
      <d2p1:OrderItemId>1</d2p1:OrderItemId>
      <d2p1:OrderNumber>sample string 2</d2p1:OrderNumber>
      <d2p1:ShipmentNumber>3</d2p1:ShipmentNumber>
    </d2p1:BulkActionOrderData>
    <d2p1:BulkActionOrderData>
      <d2p1:OrderItemId>1</d2p1:OrderItemId>
      <d2p1:OrderNumber>sample string 2</d2p1:OrderNumber>
      <d2p1:ShipmentNumber>3</d2p1:ShipmentNumber>
    </d2p1:BulkActionOrderData>
  </OrderData>
  <SendCustomerEmail>true</SendCustomerEmail>
</BulkActionStatusSubmitRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GenericResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:

<GenericResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">
  <CorrelationId>sample string 2</CorrelationId>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</GenericResponse>