GET api/Delivery/Track?code={code}&lang={lang}

Get Tracking Information

Request Information

URI Parameters

NameDescriptionTypeAdditional information
code

bidparcel code

string

Required

lang

Language Culture name in Format: pt-PT

string

None.

Body Parameters

None.

Response Information

Resource Description

ServiceResultOfAnonymousTrackingModel
NameDescriptionTypeAdditional information
Result

AnonymousTrackingModel

None.

ErrorCode

ServiceErrorCode

None.

ErrorMessage

Collection of string

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "BidParcelId": "sample string 1",
    "DeliveryState": "sample string 2",
    "DeliveryDate": "2024-04-20T00:56:11.5872446+00:00",
    "CollectionDate": "2024-04-20T00:56:11.5872446+00:00",
    "History": [
      {
        "DeliveryState": "sample string 1",
        "Date": "2024-04-20T00:56:11.5872446+00:00",
        "DeliveryFailureType": "sample string 3",
        "FailureReason": "sample string 4"
      },
      {
        "DeliveryState": "sample string 1",
        "Date": "2024-04-20T00:56:11.5872446+00:00",
        "DeliveryFailureType": "sample string 3",
        "FailureReason": "sample string 4"
      }
    ]
  },
  "ErrorCode": 0,
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Success": true
}

application/xml, text/xml

Sample:
<ServiceResultOfAnonymousTrackingModelEJHQiVcc 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>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/BOP.Apps.Web.Areas.Api.Models">
    <d2p1:BidParcelId>sample string 1</d2p1:BidParcelId>
    <d2p1:CollectionDate>2024-04-20T00:56:11.5872446+00:00</d2p1:CollectionDate>
    <d2p1:DeliveryDate>2024-04-20T00:56:11.5872446+00:00</d2p1:DeliveryDate>
    <d2p1:DeliveryState>sample string 2</d2p1:DeliveryState>
    <d2p1:History>
      <d2p1:TrackingStateHistoryModel>
        <d2p1:Date>2024-04-20T00:56:11.5872446+00:00</d2p1:Date>
        <d2p1:DeliveryFailureType>sample string 3</d2p1:DeliveryFailureType>
        <d2p1:DeliveryState>sample string 1</d2p1:DeliveryState>
        <d2p1:FailureReason>sample string 4</d2p1:FailureReason>
      </d2p1:TrackingStateHistoryModel>
      <d2p1:TrackingStateHistoryModel>
        <d2p1:Date>2024-04-20T00:56:11.5872446+00:00</d2p1:Date>
        <d2p1:DeliveryFailureType>sample string 3</d2p1:DeliveryFailureType>
        <d2p1:DeliveryState>sample string 1</d2p1:DeliveryState>
        <d2p1:FailureReason>sample string 4</d2p1:FailureReason>
      </d2p1:TrackingStateHistoryModel>
    </d2p1:History>
  </Result>
</ServiceResultOfAnonymousTrackingModelEJHQiVcc>