POST api/OmsInboundOrderAppeasement/v2/submit

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
OrderNumber	string	None.
OrderPaymentId	integer	None.
AppeasementType	AppeasementType	None.
OrderItems	Collection of OrderAppeasementItemRequest	None.
Shipping	OrderAppeasementShippingRequest	None.
RestockingFee	OrderAppeasementRestockingFeeRequest	None.
OrderTaxes	Collection of OrderAppeasementOrderTaxRequest	None.
WholeOrder	OrderAppeasementWholeOrderRequest	None.
SendTransactionalEmail	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderNumber": "sample string 1",
  "OrderPaymentId": 2,
  "AppeasementType": "errorNotSpecified",
  "OrderItems": [
    {
      "OrderItemId": 1,
      "Taxes": [
        {
          "ID": 1,
          "Amount": 2.0
        },
        {
          "ID": 1,
          "Amount": 2.0
        }
      ],
      "Amount": 2.0,
      "ReasonText": "sample string 3",
      "AdjustmentClassificationId": 4
    },
    {
      "OrderItemId": 1,
      "Taxes": [
        {
          "ID": 1,
          "Amount": 2.0
        },
        {
          "ID": 1,
          "Amount": 2.0
        }
      ],
      "Amount": 2.0,
      "ReasonText": "sample string 3",
      "AdjustmentClassificationId": 4
    }
  ],
  "Shipping": {
    "OverrideNonRefundableTax": true,
    "Amount": 2.0,
    "ReasonText": "sample string 3",
    "AdjustmentClassificationId": 4
  },
  "RestockingFee": {
    "Amount": 1.0,
    "ReasonText": "sample string 2",
    "AdjustmentClassificationId": 3
  },
  "OrderTaxes": [
    {
      "OrderTaxId": 1,
      "Amount": 2.0,
      "ReasonText": "sample string 3",
      "AdjustmentClassificationId": 4
    },
    {
      "OrderTaxId": 1,
      "Amount": 2.0,
      "ReasonText": "sample string 3",
      "AdjustmentClassificationId": 4
    }
  ],
  "WholeOrder": {
    "OverrideNonRefundableTax": true,
    "Amount": 2.0,
    "ReasonText": "sample string 3",
    "AdjustmentClassificationId": 4
  },
  "SendTransactionalEmail": true
}

application/xml, text/xml

Sample:

<OrderAppeasementV2Request xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <AppeasementType>ErrorNotSpecified</AppeasementType>
  <OrderItems>
    <OrderAppeasementItemRequest>
      <AdjustmentClassificationId>4</AdjustmentClassificationId>
      <Amount>2</Amount>
      <ReasonText>sample string 3</ReasonText>
      <OrderItemId>1</OrderItemId>
      <Taxes>
        <OrderAppeasementItemTaxRequest>
          <Amount>2</Amount>
          <ID>1</ID>
        </OrderAppeasementItemTaxRequest>
        <OrderAppeasementItemTaxRequest>
          <Amount>2</Amount>
          <ID>1</ID>
        </OrderAppeasementItemTaxRequest>
      </Taxes>
    </OrderAppeasementItemRequest>
    <OrderAppeasementItemRequest>
      <AdjustmentClassificationId>4</AdjustmentClassificationId>
      <Amount>2</Amount>
      <ReasonText>sample string 3</ReasonText>
      <OrderItemId>1</OrderItemId>
      <Taxes>
        <OrderAppeasementItemTaxRequest>
          <Amount>2</Amount>
          <ID>1</ID>
        </OrderAppeasementItemTaxRequest>
        <OrderAppeasementItemTaxRequest>
          <Amount>2</Amount>
          <ID>1</ID>
        </OrderAppeasementItemTaxRequest>
      </Taxes>
    </OrderAppeasementItemRequest>
  </OrderItems>
  <OrderNumber>sample string 1</OrderNumber>
  <OrderPaymentId>2</OrderPaymentId>
  <OrderTaxes>
    <OrderAppeasementOrderTaxRequest>
      <AdjustmentClassificationId>4</AdjustmentClassificationId>
      <Amount>2</Amount>
      <ReasonText>sample string 3</ReasonText>
      <OrderTaxId>1</OrderTaxId>
    </OrderAppeasementOrderTaxRequest>
    <OrderAppeasementOrderTaxRequest>
      <AdjustmentClassificationId>4</AdjustmentClassificationId>
      <Amount>2</Amount>
      <ReasonText>sample string 3</ReasonText>
      <OrderTaxId>1</OrderTaxId>
    </OrderAppeasementOrderTaxRequest>
  </OrderTaxes>
  <RestockingFee>
    <AdjustmentClassificationId>3</AdjustmentClassificationId>
    <Amount>1</Amount>
    <ReasonText>sample string 2</ReasonText>
  </RestockingFee>
  <SendTransactionalEmail>true</SendTransactionalEmail>
  <Shipping>
    <AdjustmentClassificationId>4</AdjustmentClassificationId>
    <Amount>2</Amount>
    <ReasonText>sample string 3</ReasonText>
    <OverrideNonRefundableTax>true</OverrideNonRefundableTax>
  </Shipping>
  <WholeOrder>
    <AdjustmentClassificationId>4</AdjustmentClassificationId>
    <Amount>2</Amount>
    <ReasonText>sample string 3</ReasonText>
    <OverrideNonRefundableTax>true</OverrideNonRefundableTax>
  </WholeOrder>
</OrderAppeasementV2Request>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderAppeasementV2Response

Name	Type	Additional Information
IsSuccess	boolean	None.
Errors	Collection of string	None.
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "ResponseCode": 0,
  "Message": "sample string 2",
  "CorrelationId": "sample string 3"
}

application/xml, text/xml

Sample:

<OrderAppeasementV2Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <CorrelationId xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 3</CorrelationId>
  <Message xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 2</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">Success</ResponseCode>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <IsSuccess>true</IsSuccess>
</OrderAppeasementV2Response>