POST api/OmsDeliveredDate

Updates the delivered dates for one or more order items

Request Information

URI Parameters

None.

Body Parameters

Request containing order number and items with delivered dates

DeliveredDateRequest

NameDescriptionTypeAdditional Information
Items

Collection of DeliveredDateRequestItem

None.

OrderNumber

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Items": [
    {
      "OrderItemID": 1,
      "DeliveredDate": "sample string 2"
    },
    {
      "OrderItemID": 1,
      "DeliveredDate": "sample string 2"
    }
  ],
  "OrderNumber": "sample string 1"
}

application/xml, text/xml

Sample:
<DeliveredDateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <Items>
    <DeliveredDateRequestItem>
      <DeliveredDate>sample string 2</DeliveredDate>
      <OrderItemID>1</OrderItemID>
    </DeliveredDateRequestItem>
    <DeliveredDateRequestItem>
      <DeliveredDate>sample string 2</DeliveredDate>
      <OrderItemID>1</OrderItemID>
    </DeliveredDateRequestItem>
  </Items>
  <OrderNumber>sample string 1</OrderNumber>
</DeliveredDateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Response indicating success or failure with appropriate messages

UpdateDeliveredDatesResponse

NameDescriptionTypeAdditional Information
IsSuccess

boolean

None.

SuccessMessage

string

None.

ErrorMessage

string

None.

Errors

Collection of string

None.

ResponseCode

APIResponseCodes

None.

Message

string

None.

CorrelationId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccess": true,
  "SuccessMessage": "sample string 2",
  "ErrorMessage": "sample string 3",
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "ResponseCode": 0,
  "Message": "sample string 4",
  "CorrelationId": "sample string 5"
}

application/xml, text/xml

Sample:
<UpdateDeliveredDatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <CorrelationId>sample string 5</CorrelationId>
  <ErrorMessage>sample string 3</ErrorMessage>
  <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>
  <Message>sample string 4</Message>
  <ResponseCode>Success</ResponseCode>
  <SuccessMessage>sample string 2</SuccessMessage>
</UpdateDeliveredDatesResponse>