GET api/v1/shipment?trackingNumber={trackingNumber}&freightType={freightType}&masterTrackNumber={masterTrackNumber}

Request Information

URI Parameters

Name	Type	Additional information
trackingNumber	string	Required
freightType	byte	Required
masterTrackNumber	string	None.

Body Parameters

None.

Response Information

Resource Description

TrackingInfoModel

Name	Type	Additional information
TrackingNumber	string	None.
PaymentType	string	None.
NumberOfPackages	integer	None.
ServiceLevel	string	None.
ScannedDocuments	integer	None.
ScannedDocumentsLink	string	None.
TimeInTransit	decimal number	None.
DateOfShipment	date	None.
ShipmentType	string	None.
Reshumon	string	None.
ShipmentWeight	WeightModel	None.
DimensionalWeight	WeightModel	None.
PhysicalWeight	WeightModel	None.
Value	decimal number	None.
ValueCurrency	string	None.
Reference2	string	None.
Reference1	string	None.
LastStatus	string	None.
LastStatusDate	date	None.
PODDetail	string	None.
ShiperAddress	TrackInfoAddressModel	None.
ConsingeeAddress	TrackInfoAddressModel	None.
CodValue	decimal number	None.
DDOFlag	boolean	None.
PodTime	date	None.
CodFlag	boolean	None.
UdrFlag	boolean	None.
BillZone	integer	None.
Fee103	decimal number	None.
Fee2	decimal number	None.
CarrierDescription	string	None.
ForeignPortCode	string	None.
MasterNumber	string	None.
ForeignPortDescription	string	None.
Master_E2k_No	string	None.
Shipment_Description	string	None.
ArrivalDate	date	None.
ConfirmedArrivalDate	date	None.
ReceivedIntoUpsPossessionDate	date	None.
OriginCountryDesc	string	None.
FullContainerLoad	decimal number	None.
CustomsReference	string	None.
DeliveryDate	date	None.
ExportDate	date	None.
CarrierCode	integer	None.
CarrierDescr	string	None.

Response Formats

application/json, text/json

Sample:

{
  "TrackingNumber": "sample string 1",
  "PaymentType": "sample string 2",
  "NumberOfPackages": 1,
  "ServiceLevel": "sample string 3",
  "ScannedDocuments": 4,
  "ScannedDocumentsLink": "sample string 5",
  "TimeInTransit": 1.1,
  "DateOfShipment": "2021-09-09T21:39:33.6639404+03:00",
  "ShipmentType": "sample string 6",
  "Reshumon": "sample string 7",
  "ShipmentWeight": {
    "Weight": 1.1,
    "Unit": "sample string 1"
  },
  "DimensionalWeight": {
    "Weight": 1.1,
    "Unit": "sample string 1"
  },
  "PhysicalWeight": {
    "Weight": 1.1,
    "Unit": "sample string 1"
  },
  "Value": 1.1,
  "ValueCurrency": "sample string 8",
  "Reference2": "sample string 9",
  "Reference1": "sample string 10",
  "LastStatus": "sample string 11",
  "LastStatusDate": "2021-09-09T21:39:33.6639404+03:00",
  "PODDetail": "sample string 12",
  "ShiperAddress": {
    "Zip": "sample string 1",
    "Name": "sample string 2",
    "ContactName": "sample string 3",
    "StreetName": "sample string 4",
    "CityName": "sample string 5",
    "Country": {
      "Name": "sample string 1",
      "Flag": "sample string 2"
    },
    "HouseNo": "sample string 6"
  },
  "ConsingeeAddress": {
    "Zip": "sample string 1",
    "Name": "sample string 2",
    "ContactName": "sample string 3",
    "StreetName": "sample string 4",
    "CityName": "sample string 5",
    "Country": {
      "Name": "sample string 1",
      "Flag": "sample string 2"
    },
    "HouseNo": "sample string 6"
  },
  "CodValue": 13.1,
  "DDOFlag": true,
  "PodTime": "2021-09-09T21:39:33.6639404+03:00",
  "CodFlag": true,
  "UdrFlag": true,
  "BillZone": 1,
  "Fee103": 17.1,
  "Fee2": 18.1,
  "CarrierDescription": "sample string 19",
  "ForeignPortCode": "sample string 20",
  "MasterNumber": "sample string 21",
  "ForeignPortDescription": "sample string 22",
  "Master_E2k_No": "sample string 23",
  "Shipment_Description": "sample string 24",
  "ArrivalDate": "2021-09-09T21:39:33.6639404+03:00",
  "ConfirmedArrivalDate": "2021-09-09T21:39:33.6639404+03:00",
  "ReceivedIntoUpsPossessionDate": "2021-09-09T21:39:33.6639404+03:00",
  "OriginCountryDesc": "sample string 25",
  "FullContainerLoad": 1.1,
  "CustomsReference": "sample string 26",
  "DeliveryDate": "2021-09-09T21:39:33.6639404+03:00",
  "ExportDate": "2021-09-09T21:39:33.6639404+03:00",
  "CarrierCode": 1,
  "CarrierDescr": "sample string 27"
}

application/xml, text/xml

Sample:

<TrackingInfoModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UPS.Ship.API.Models.Ship">
  <ArrivalDate>2021-09-09T21:39:33.6639404+03:00</ArrivalDate>
  <BillZone>1</BillZone>
  <CarrierCode>1</CarrierCode>
  <CarrierDescr>sample string 27</CarrierDescr>
  <CarrierDescription>sample string 19</CarrierDescription>
  <CodFlag>true</CodFlag>
  <CodValue>13.1</CodValue>
  <ConfirmedArrivalDate>2021-09-09T21:39:33.6639404+03:00</ConfirmedArrivalDate>
  <ConsingeeAddress>
    <CityName>sample string 5</CityName>
    <ContactName>sample string 3</ContactName>
    <Country>
      <Flag>sample string 2</Flag>
      <Name>sample string 1</Name>
    </Country>
    <HouseNo>sample string 6</HouseNo>
    <Name>sample string 2</Name>
    <StreetName>sample string 4</StreetName>
    <Zip>sample string 1</Zip>
  </ConsingeeAddress>
  <CustomsReference>sample string 26</CustomsReference>
  <DDOFlag>true</DDOFlag>
  <DateOfShipment>2021-09-09T21:39:33.6639404+03:00</DateOfShipment>
  <DeliveryDate>2021-09-09T21:39:33.6639404+03:00</DeliveryDate>
  <DimensionalWeight>
    <Unit>sample string 1</Unit>
    <Weight>1.1</Weight>
  </DimensionalWeight>
  <ExportDate>2021-09-09T21:39:33.6639404+03:00</ExportDate>
  <Fee103>17.1</Fee103>
  <Fee2>18.1</Fee2>
  <ForeignPortCode>sample string 20</ForeignPortCode>
  <ForeignPortDescription>sample string 22</ForeignPortDescription>
  <FullContainerLoad>1.1</FullContainerLoad>
  <LastStatus>sample string 11</LastStatus>
  <LastStatusDate>2021-09-09T21:39:33.6639404+03:00</LastStatusDate>
  <MasterNumber>sample string 21</MasterNumber>
  <Master_E2k_No>sample string 23</Master_E2k_No>
  <NumberOfPackages>1</NumberOfPackages>
  <OriginCountryDesc>sample string 25</OriginCountryDesc>
  <PODDetail>sample string 12</PODDetail>
  <PaymentType>sample string 2</PaymentType>
  <PhysicalWeight>
    <Unit>sample string 1</Unit>
    <Weight>1.1</Weight>
  </PhysicalWeight>
  <PodTime>2021-09-09T21:39:33.6639404+03:00</PodTime>
  <ReceivedIntoUpsPossessionDate>2021-09-09T21:39:33.6639404+03:00</ReceivedIntoUpsPossessionDate>
  <Reference1>sample string 10</Reference1>
  <Reference2>sample string 9</Reference2>
  <Reshumon>sample string 7</Reshumon>
  <ScannedDocuments>4</ScannedDocuments>
  <ScannedDocumentsLink>sample string 5</ScannedDocumentsLink>
  <ServiceLevel>sample string 3</ServiceLevel>
  <ShiperAddress>
    <CityName>sample string 5</CityName>
    <ContactName>sample string 3</ContactName>
    <Country>
      <Flag>sample string 2</Flag>
      <Name>sample string 1</Name>
    </Country>
    <HouseNo>sample string 6</HouseNo>
    <Name>sample string 2</Name>
    <StreetName>sample string 4</StreetName>
    <Zip>sample string 1</Zip>
  </ShiperAddress>
  <ShipmentType>sample string 6</ShipmentType>
  <ShipmentWeight>
    <Unit>sample string 1</Unit>
    <Weight>1.1</Weight>
  </ShipmentWeight>
  <Shipment_Description>sample string 24</Shipment_Description>
  <TimeInTransit>1.1</TimeInTransit>
  <TrackingNumber>sample string 1</TrackingNumber>
  <UdrFlag>true</UdrFlag>
  <Value>1.1</Value>
  <ValueCurrency>sample string 8</ValueCurrency>
</TrackingInfoModel>