POST api/Auction/UpdateParcelDeliveryState?authToken={authToken}

Updates the Parcel Delivery State

Request Information

URI Parameters

Name	Description	Type	Additional information
authToken	The Authentication Token	string	Required

Body Parameters

ParcelDeliveryStateModel

Name	Type	Additional information
AuctionParcelId	globally unique identifier	Required
DeliveryState	DeliveryState	Required
RescheduledDate	date	None.
FailureReason	string	None.
FailureType	DeliveryFailureType	None.
PickupRescheduledDate	date	None.
PickupFailureType	PickupFailureType	None.

Request Formats

application/json, text/json

Sample:

{
  "AuctionParcelId": "c68b4d5a-c83c-4142-a5c5-6527ae80fae9",
  "DeliveryState": 1,
  "RescheduledDate": "2024-04-19T14:30:02.5956214+00:00",
  "FailureReason": "sample string 2",
  "FailureType": 1,
  "PickupRescheduledDate": "2024-04-19T14:30:02.5956214+00:00",
  "PickupFailureType": 103
}

application/xml, text/xml

Sample:

<ParcelDeliveryStateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Apps.Web.Areas.Api.Models">
  <AuctionParcelId>c68b4d5a-c83c-4142-a5c5-6527ae80fae9</AuctionParcelId>
  <DeliveryState>AwaitingPickup</DeliveryState>
  <FailureReason>sample string 2</FailureReason>
  <FailureType>Absent</FailureType>
  <PickupFailureType>UnknownMerchandise</PickupFailureType>
  <PickupRescheduledDate>2024-04-19T14:30:02.5956214+00:00</PickupRescheduledDate>
  <RescheduledDate>2024-04-19T14:30:02.5956214+00:00</RescheduledDate>
</ParcelDeliveryStateModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ServiceResult

Name	Type	Additional information
ErrorCode	ServiceErrorCode	None.
ErrorMessage	Collection of string	None.
Success	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorCode": 0,
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Success": true
}

application/xml, text/xml

Sample:

<ServiceResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Common.Infrastructure.ApiObjects.Results">
  <ErrorCode>None</ErrorCode>
  <ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorMessage>
  <Success>true</Success>
</ServiceResult>