POST api/Centers/GetItemProcessingOptions
Request Information
URI Parameters
None.
Body Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| OrderId | integer |
None. |
|
| SiteId | integer |
None. |
|
| ItemsId | Collection of integer |
None. |
|
| StatusGroup | ItemStatusGroup |
None. |
|
| SelectedItemStatus | integer |
None. |
|
| UserId | integer |
None. |
|
| OrderRmaJson | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"OrderId": 1,
"SiteId": 2,
"ItemsId": [
1,
2
],
"StatusGroup": 0,
"SelectedItemStatus": 3,
"UserId": 4,
"OrderRmaJson": "sample string 5"
}
application/xml, text/xml
Sample:
<ItemProcessingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
<ItemsId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</ItemsId>
<OrderId>1</OrderId>
<OrderRmaJson>sample string 5</OrderRmaJson>
<SelectedItemStatus>3</SelectedItemStatus>
<SiteId>2</SiteId>
<StatusGroup>Default</StatusGroup>
<UserId>4</UserId>
</ItemProcessingModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GetItemProcessingOptionsResponse
| Name | Description | Type | Additional Information |
|---|---|---|---|
| ResponseCode | APIResponseCodes |
None. |
|
| Message | string |
None. |
|
| ItemStatusGroupOptions | ItemStatusGroupOptions |
None. |
|
| CorrelationId | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ResponseCode": 0,
"Message": "sample string 1",
"ItemStatusGroupOptions": {
"EmailCheckbox": true,
"SendCustomerEmail": true,
"GiftCardNumber": "sample string 3",
"GiftCardPinNumber": "sample string 4",
"TrackingNumber": "sample string 5",
"Subtotal": "sample string 6",
"SubtotalValue": 7.0,
"ShippingCost": "sample string 8",
"ShippingCostValue": 9.0,
"Total": "sample string 10",
"TotalValue": 11.0,
"DiscountValue": 12.0,
"Discount": "sample string 13",
"ProcessingFee": "sample string 14",
"ProcessingFeeValue": 15.0,
"Taxes": [
{
"TaxType": 1,
"Amount": 1.0,
"AmountDisplay": "sample string 2",
"TaxTypeDescription": "sample string 3",
"IsVAT": true,
"IsShippingTaxType": true,
"TaxRefundType": 0,
"OrderItemID": 6
},
{
"TaxType": 1,
"Amount": 1.0,
"AmountDisplay": "sample string 2",
"TaxTypeDescription": "sample string 3",
"IsVAT": true,
"IsShippingTaxType": true,
"TaxRefundType": 0,
"OrderItemID": 6
}
],
"ShippingMethods": [
{
"Value": 1,
"Text": "sample string 2",
"Code": "sample string 3"
},
{
"Value": 1,
"Text": "sample string 2",
"Code": "sample string 3"
}
],
"AllowReturnCredit": true,
"DefaultReturnCredit": 17.0,
"CanCreditToGiftCard": true,
"SelectedShippingMethodID": 19,
"ErrorCode": -1,
"PoNumber": "sample string 20",
"PoDate": "sample string 21",
"ErpNumber": "sample string 22",
"ShowGiftCardTextBox": true,
"ShowGiftCardTrackingNumberTextBox": true,
"DisplayReturnTotal": true,
"RefundAdjustmentInputValue": 26.0,
"RefundAdjustmentType": "sample string 27",
"InstockWarehouses": [
{
"Value": 1,
"Text": "sample string 2",
"Code": "sample string 3"
},
{
"Value": 1,
"Text": "sample string 2",
"Code": "sample string 3"
}
],
"BackorderWarehouses": [
{
"Value": 1,
"Text": "sample string 2",
"Code": "sample string 3"
},
{
"Value": 1,
"Text": "sample string 2",
"Code": "sample string 3"
}
],
"Warehouses": [
{
"Value": 1,
"Text": "sample string 2",
"Code": "sample string 3"
},
{
"Value": 1,
"Text": "sample string 2",
"Code": "sample string 3"
}
],
"GiftCards": null,
"ResponseCode": 28,
"ResponseMessage": "sample string 29",
"DeliveredDate": "sample string 30",
"ReturnReasonID": 31,
"ReturnTypeID": 32,
"ReturnReasonText": "sample string 33",
"ReturnLocationID": 34,
"CarrierCode": "sample string 35",
"PhysicalReturnNotRequired": true,
"ReturnNoCredit": true,
"ReturnInvoiceNumber": "sample string 38",
"ReturnRefundTypeId": 39,
"GiftCardRecipientName": "sample string 40",
"GiftCardRecipientEmail": "sample string 41",
"RmaProcessingCharge": 42.0,
"ShippingCredit": 43.0
},
"CorrelationId": "sample string 2"
}
application/xml, text/xml
Sample:
<GetItemProcessingOptionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API.Centers">
<CorrelationId>sample string 2</CorrelationId>
<ItemStatusGroupOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.OrderItems.Models">
<d2p1:AllowReturnCredit>true</d2p1:AllowReturnCredit>
<d2p1:BackorderWarehouses xmlns:d3p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
<d3p1:ValueTextModel>
<d3p1:Code>sample string 3</d3p1:Code>
<d3p1:Text>sample string 2</d3p1:Text>
<d3p1:Value>1</d3p1:Value>
</d3p1:ValueTextModel>
<d3p1:ValueTextModel>
<d3p1:Code>sample string 3</d3p1:Code>
<d3p1:Text>sample string 2</d3p1:Text>
<d3p1:Value>1</d3p1:Value>
</d3p1:ValueTextModel>
</d2p1:BackorderWarehouses>
<d2p1:CanCreditToGiftCard>true</d2p1:CanCreditToGiftCard>
<d2p1:CarrierCode>sample string 35</d2p1:CarrierCode>
<d2p1:DefaultReturnCredit>17</d2p1:DefaultReturnCredit>
<d2p1:DeliveredDate>sample string 30</d2p1:DeliveredDate>
<d2p1:Discount>sample string 13</d2p1:Discount>
<d2p1:DiscountValue>12</d2p1:DiscountValue>
<d2p1:DisplayReturnTotal>true</d2p1:DisplayReturnTotal>
<d2p1:EmailCheckbox>true</d2p1:EmailCheckbox>
<d2p1:ErpNumber>sample string 22</d2p1:ErpNumber>
<d2p1:ErrorCode>SeparateShipments</d2p1:ErrorCode>
<d2p1:GiftCardNumber>sample string 3</d2p1:GiftCardNumber>
<d2p1:GiftCardPinNumber>sample string 4</d2p1:GiftCardPinNumber>
<d2p1:GiftCardRecipientEmail>sample string 41</d2p1:GiftCardRecipientEmail>
<d2p1:GiftCardRecipientName>sample string 40</d2p1:GiftCardRecipientName>
<d2p1:GiftCards xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<d2p1:InstockWarehouses xmlns:d3p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
<d3p1:ValueTextModel>
<d3p1:Code>sample string 3</d3p1:Code>
<d3p1:Text>sample string 2</d3p1:Text>
<d3p1:Value>1</d3p1:Value>
</d3p1:ValueTextModel>
<d3p1:ValueTextModel>
<d3p1:Code>sample string 3</d3p1:Code>
<d3p1:Text>sample string 2</d3p1:Text>
<d3p1:Value>1</d3p1:Value>
</d3p1:ValueTextModel>
</d2p1:InstockWarehouses>
<d2p1:PhysicalReturnNotRequired>true</d2p1:PhysicalReturnNotRequired>
<d2p1:PoDate>sample string 21</d2p1:PoDate>
<d2p1:PoNumber>sample string 20</d2p1:PoNumber>
<d2p1:ProcessingFee>sample string 14</d2p1:ProcessingFee>
<d2p1:ProcessingFeeValue>15</d2p1:ProcessingFeeValue>
<d2p1:RefundAdjustmentInputValue>26</d2p1:RefundAdjustmentInputValue>
<d2p1:RefundAdjustmentType>sample string 27</d2p1:RefundAdjustmentType>
<d2p1:ResponseCode>28</d2p1:ResponseCode>
<d2p1:ResponseMessage>sample string 29</d2p1:ResponseMessage>
<d2p1:ReturnInvoiceNumber>sample string 38</d2p1:ReturnInvoiceNumber>
<d2p1:ReturnLocationID>34</d2p1:ReturnLocationID>
<d2p1:ReturnNoCredit>true</d2p1:ReturnNoCredit>
<d2p1:ReturnReasonID>31</d2p1:ReturnReasonID>
<d2p1:ReturnReasonText>sample string 33</d2p1:ReturnReasonText>
<d2p1:ReturnRefundTypeId>39</d2p1:ReturnRefundTypeId>
<d2p1:ReturnTypeID>32</d2p1:ReturnTypeID>
<d2p1:RmaProcessingCharge>42</d2p1:RmaProcessingCharge>
<d2p1:SelectedShippingMethodID>19</d2p1:SelectedShippingMethodID>
<d2p1:SendCustomerEmail>true</d2p1:SendCustomerEmail>
<d2p1:ShippingCost>sample string 8</d2p1:ShippingCost>
<d2p1:ShippingCostValue>9</d2p1:ShippingCostValue>
<d2p1:ShippingCredit>43</d2p1:ShippingCredit>
<d2p1:ShippingMethods xmlns:d3p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
<d3p1:ValueTextModel>
<d3p1:Code>sample string 3</d3p1:Code>
<d3p1:Text>sample string 2</d3p1:Text>
<d3p1:Value>1</d3p1:Value>
</d3p1:ValueTextModel>
<d3p1:ValueTextModel>
<d3p1:Code>sample string 3</d3p1:Code>
<d3p1:Text>sample string 2</d3p1:Text>
<d3p1:Value>1</d3p1:Value>
</d3p1:ValueTextModel>
</d2p1:ShippingMethods>
<d2p1:ShowGiftCardTextBox>true</d2p1:ShowGiftCardTextBox>
<d2p1:ShowGiftCardTrackingNumberTextBox>true</d2p1:ShowGiftCardTrackingNumberTextBox>
<d2p1:Subtotal>sample string 6</d2p1:Subtotal>
<d2p1:SubtotalValue>7</d2p1:SubtotalValue>
<d2p1:Taxes xmlns:d3p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
<d3p1:SimpleTaxDisplay>
<d3p1:Amount>1</d3p1:Amount>
<d3p1:AmountDisplay>sample string 2</d3p1:AmountDisplay>
<d3p1:IsShippingTaxType>true</d3p1:IsShippingTaxType>
<d3p1:IsVAT>true</d3p1:IsVAT>
<d3p1:OrderItemID>6</d3p1:OrderItemID>
<d3p1:TaxRefundType>Refundable</d3p1:TaxRefundType>
<d3p1:TaxType>USSalesTotal</d3p1:TaxType>
<d3p1:TaxTypeDescription>sample string 3</d3p1:TaxTypeDescription>
</d3p1:SimpleTaxDisplay>
<d3p1:SimpleTaxDisplay>
<d3p1:Amount>1</d3p1:Amount>
<d3p1:AmountDisplay>sample string 2</d3p1:AmountDisplay>
<d3p1:IsShippingTaxType>true</d3p1:IsShippingTaxType>
<d3p1:IsVAT>true</d3p1:IsVAT>
<d3p1:OrderItemID>6</d3p1:OrderItemID>
<d3p1:TaxRefundType>Refundable</d3p1:TaxRefundType>
<d3p1:TaxType>USSalesTotal</d3p1:TaxType>
<d3p1:TaxTypeDescription>sample string 3</d3p1:TaxTypeDescription>
</d3p1:SimpleTaxDisplay>
</d2p1:Taxes>
<d2p1:Total>sample string 10</d2p1:Total>
<d2p1:TotalValue>11</d2p1:TotalValue>
<d2p1:TrackingNumber>sample string 5</d2p1:TrackingNumber>
<d2p1:Warehouses xmlns:d3p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
<d3p1:ValueTextModel>
<d3p1:Code>sample string 3</d3p1:Code>
<d3p1:Text>sample string 2</d3p1:Text>
<d3p1:Value>1</d3p1:Value>
</d3p1:ValueTextModel>
<d3p1:ValueTextModel>
<d3p1:Code>sample string 3</d3p1:Code>
<d3p1:Text>sample string 2</d3p1:Text>
<d3p1:Value>1</d3p1:Value>
</d3p1:ValueTextModel>
</d2p1:Warehouses>
</ItemStatusGroupOptions>
<Message>sample string 1</Message>
<ResponseCode>Success</ResponseCode>
</GetItemProcessingOptionsResponse>