POST api/Centers/ProcessIsfOrderItems

Request Information

URI Parameters

None.

Body Parameters

OmniProcessItemsRequest

NameDescriptionTypeAdditional Information
RequestModel

ItemStatusChange

None.

OrderId

integer

None.

OrderHash

string

None.

Request Formats

application/json, text/json

Sample:
{
  "RequestModel": {
    "ItemIDs": [
      1,
      2
    ],
    "TrackingNumber": "sample string 1",
    "ShippingProblemID": 2,
    "SendReplacement": true,
    "IsExpectingPayment": true,
    "IsExpectingReturn": true,
    "AlternateStyle": "sample string 6",
    "ShippingErrorID": 7,
    "ReturnTypeID": 8,
    "ReturnReasonID": 9,
    "ReturnReasonText": "sample string 10",
    "ReturnWarehouseID": 11,
    "ReshipFulfillmentLocationID": 12,
    "IssueRefundToGiftCard": true,
    "SendCustomerEmail": true,
    "PrintShippingLabel": true,
    "ShippingLabelShipmentNumberToPrint": 16,
    "PrintReturnShippingLabel": true,
    "ReturnShippingLabelShipmentNumberToPrint": 18,
    "PrintPackingSlip": true,
    "ReturnPackingSlipWarehouseNumberToPrint": 20,
    "ShippingMethodID": 21,
    "ReturnShippingCredit": 22.0,
    "ReturnProcessingFee": 23.0,
    "StatusID": 24,
    "StatusGroup": 0,
    "GiftCardNumber": "sample string 25",
    "GiftCardPinNumber": "sample string 26",
    "EstimatedShipDate": "2025-12-20T13:04:38.4814446+00:00",
    "EndEstimatedShipDate": "2025-12-20T13:04:38.4814446+00:00",
    "PoNumber": "sample string 27",
    "PoDate": "sample string 28",
    "ErpNumber": "sample string 29",
    "ReturnInvoiceNumber": "sample string 30",
    "NewRoutingID": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "OrderNote": "sample string 31",
    "CurrentUser": "sample string 32",
    "BillingAddress1": "sample string 33",
    "BillingAddress2": "sample string 34",
    "BillingAddress3": "sample string 35",
    "BillingCountry": "sample string 36",
    "BillingGivenName": "sample string 37",
    "BillingLocality": "sample string 38",
    "BillingPostalCode": "sample string 39",
    "billingProvince": "sample string 40",
    "BillingSurName": "sample string 41",
    "BillingEmail": "sample string 42",
    "InstockWarehouseID": 43,
    "BackorderWarehouseID": 44,
    "ReturnShipping": 45.0,
    "ConsolidateShipments": true,
    "CancelReasonID": 47,
    "CancelReasonText": "sample string 48",
    "DeliveredDate": "sample string 49",
    "ShipmentTrackingNumber": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "ForceExchangeRelease": true,
    "ReturnRefundTypeId": 51,
    "PhysicalReturnNotRequired": true,
    "ReturnNoCredit": true,
    "GiftRecipientName": "sample string 54",
    "GiftRecipientEmail": "sample string 55",
    "CarrierCode": "sample string 56",
    "RmaNumber": "sample string 57",
    "RmaProcessingCharge": 58.0,
    "ProcessingFromUi": true,
    "EditShippingDetails": true,
    "DateShipped": "sample string 61",
    "CurrentOrder": null,
    "IsContinuousStatusChange": true
  },
  "OrderId": 1,
  "OrderHash": "sample string 2"
}

application/xml, text/xml

Sample:
<OmniProcessItemsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API.Centers">
  <OrderHash>sample string 2</OrderHash>
  <OrderId>1</OrderId>
  <RequestModel xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.OrderItems.Models">
    <d2p1:AlternateStyle>sample string 6</d2p1:AlternateStyle>
    <d2p1:BackorderWarehouseID>44</d2p1:BackorderWarehouseID>
    <d2p1:BillingAddress1>sample string 33</d2p1:BillingAddress1>
    <d2p1:BillingAddress2>sample string 34</d2p1:BillingAddress2>
    <d2p1:BillingAddress3>sample string 35</d2p1:BillingAddress3>
    <d2p1:BillingCountry>sample string 36</d2p1:BillingCountry>
    <d2p1:BillingEmail>sample string 42</d2p1:BillingEmail>
    <d2p1:BillingGivenName>sample string 37</d2p1:BillingGivenName>
    <d2p1:BillingLocality>sample string 38</d2p1:BillingLocality>
    <d2p1:BillingPostalCode>sample string 39</d2p1:BillingPostalCode>
    <d2p1:BillingSurName>sample string 41</d2p1:BillingSurName>
    <d2p1:CancelReasonID>47</d2p1:CancelReasonID>
    <d2p1:CancelReasonText>sample string 48</d2p1:CancelReasonText>
    <d2p1:CarrierCode>sample string 56</d2p1:CarrierCode>
    <d2p1:ConsolidateShipments>true</d2p1:ConsolidateShipments>
    <d2p1:CurrentOrder i:nil="true" />
    <d2p1:CurrentUser>sample string 32</d2p1:CurrentUser>
    <d2p1:DateShipped>sample string 61</d2p1:DateShipped>
    <d2p1:DeliveredDate>sample string 49</d2p1:DeliveredDate>
    <d2p1:EditShippingDetails>true</d2p1:EditShippingDetails>
    <d2p1:EndEstimatedShipDate>2025-12-20T13:04:38.4814446+00:00</d2p1:EndEstimatedShipDate>
    <d2p1:ErpNumber>sample string 29</d2p1:ErpNumber>
    <d2p1:EstimatedShipDate>2025-12-20T13:04:38.4814446+00:00</d2p1:EstimatedShipDate>
    <d2p1:ForceExchangeRelease>true</d2p1:ForceExchangeRelease>
    <d2p1:GiftCardNumber>sample string 25</d2p1:GiftCardNumber>
    <d2p1:GiftCardPinNumber>sample string 26</d2p1:GiftCardPinNumber>
    <d2p1:GiftRecipientEmail>sample string 55</d2p1:GiftRecipientEmail>
    <d2p1:GiftRecipientName>sample string 54</d2p1:GiftRecipientName>
    <d2p1:InstockWarehouseID>43</d2p1:InstockWarehouseID>
    <d2p1:IsContinuousStatusChange>true</d2p1:IsContinuousStatusChange>
    <d2p1:IsExpectingPayment>true</d2p1:IsExpectingPayment>
    <d2p1:IsExpectingReturn>true</d2p1:IsExpectingReturn>
    <d2p1:IssueRefundToGiftCard>true</d2p1:IssueRefundToGiftCard>
    <d2p1:ItemIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:ItemIDs>
    <d2p1:NewRoutingID xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:NewRoutingID>
    <d2p1:OrderNote>sample string 31</d2p1:OrderNote>
    <d2p1:PhysicalReturnNotRequired>true</d2p1:PhysicalReturnNotRequired>
    <d2p1:PoDate>sample string 28</d2p1:PoDate>
    <d2p1:PoNumber>sample string 27</d2p1:PoNumber>
    <d2p1:PrintPackingSlip>true</d2p1:PrintPackingSlip>
    <d2p1:PrintReturnShippingLabel>true</d2p1:PrintReturnShippingLabel>
    <d2p1:PrintShippingLabel>true</d2p1:PrintShippingLabel>
    <d2p1:ProcessingFromUi>true</d2p1:ProcessingFromUi>
    <d2p1:ReshipFulfillmentLocationID>12</d2p1:ReshipFulfillmentLocationID>
    <d2p1:ReturnInvoiceNumber>sample string 30</d2p1:ReturnInvoiceNumber>
    <d2p1:ReturnNoCredit>true</d2p1:ReturnNoCredit>
    <d2p1:ReturnPackingSlipWarehouseNumberToPrint>20</d2p1:ReturnPackingSlipWarehouseNumberToPrint>
    <d2p1:ReturnProcessingFee>23</d2p1:ReturnProcessingFee>
    <d2p1:ReturnReasonID>9</d2p1:ReturnReasonID>
    <d2p1:ReturnReasonText>sample string 10</d2p1:ReturnReasonText>
    <d2p1:ReturnRefundTypeId>51</d2p1:ReturnRefundTypeId>
    <d2p1:ReturnShipping>45</d2p1:ReturnShipping>
    <d2p1:ReturnShippingCredit>22</d2p1:ReturnShippingCredit>
    <d2p1:ReturnShippingLabelShipmentNumberToPrint>18</d2p1:ReturnShippingLabelShipmentNumberToPrint>
    <d2p1:ReturnTypeID>8</d2p1:ReturnTypeID>
    <d2p1:ReturnWarehouseID>11</d2p1:ReturnWarehouseID>
    <d2p1:RmaNumber>sample string 57</d2p1:RmaNumber>
    <d2p1:RmaProcessingCharge>58</d2p1:RmaProcessingCharge>
    <d2p1:SendCustomerEmail>true</d2p1:SendCustomerEmail>
    <d2p1:SendReplacement>true</d2p1:SendReplacement>
    <d2p1:ShipmentTrackingNumber xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:ShipmentTrackingNumber>
    <d2p1:ShippingErrorID>7</d2p1:ShippingErrorID>
    <d2p1:ShippingLabelShipmentNumberToPrint>16</d2p1:ShippingLabelShipmentNumberToPrint>
    <d2p1:ShippingMethodID>21</d2p1:ShippingMethodID>
    <d2p1:ShippingProblemID>2</d2p1:ShippingProblemID>
    <d2p1:StatusGroup>Default</d2p1:StatusGroup>
    <d2p1:StatusID>24</d2p1:StatusID>
    <d2p1:TrackingNumber>sample string 1</d2p1:TrackingNumber>
    <d2p1:billingProvince>sample string 40</d2p1:billingProvince>
  </RequestModel>
</OmniProcessItemsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OmniProcessItemsResponse

NameDescriptionTypeAdditional Information
ResponseCode

APIResponseCodes

None.

Message

string

None.

IsValid

boolean

None.

ProcessingMessage

string

None.

CorrelationId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "IsValid": true,
  "ProcessingMessage": "sample string 3",
  "CorrelationId": "sample string 4"
}

application/xml, text/xml

Sample:
<OmniProcessItemsResponse 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 4</CorrelationId>
  <IsValid>true</IsValid>
  <Message>sample string 1</Message>
  <ProcessingMessage>sample string 3</ProcessingMessage>
  <ResponseCode>Success</ResponseCode>
</OmniProcessItemsResponse>