POST api/Watch

Retrieve a list of items on users watch list

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
auth	Authorization token	string	None.
AccountNumber	(optional) Account number to watch list	string	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountNumber": "sample string 2",
  "auth": "sample string 1"
}

application/xml, text/xml

Sample:

<WatchListParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <AccountNumber>sample string 2</AccountNumber>
  <auth>sample string 1</auth>
</WatchListParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

WatchListResp

Name	Description	Type	Additional information
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.
Items	List of watch list items	Collection of WatchListItem	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorMessage": "sample string 2",
  "IsSuccessful": true,
  "Items": [
    {
      "ActualDepartDateTime": "2024-09-19T11:44:49.513-07:00",
      "ActualPickupDateTime": "2024-09-19T11:44:49.513-07:00",
      "ArriveDateTime": "2024-09-19T11:44:49.512-07:00",
      "Contents": "sample string 1",
      "DeliveryAddress1": "sample string 2",
      "DeliveryAddress2": "sample string 3",
      "DeliveryAddress3": "sample string 4",
      "DeliveryAddressFull": "sample string 39",
      "DeliveryCityName": "sample string 5",
      "DeliveryCompanyName": "sample string 6",
      "DeliveryCountryID": "sample string 7",
      "DeliveryPostalCode": "sample string 8",
      "DeliveryStateProvID": "sample string 9",
      "DisplayDeliveryAddress": "sample string 10",
      "DisplayPickupAddress": "sample string 11",
      "DropAirportID": "sample string 37",
      "EsimatedDeliveryDateTime": "2024-09-19T11:44:49.513-07:00",
      "EstimatedDepartDateTime": "2024-09-19T11:44:49.513-07:00",
      "EstimatedPickupDateTime": "2024-09-19T11:44:49.513-07:00",
      "HasCustomerNotes": true,
      "HasGPSDevice": true,
      "HoldForPickup": true,
      "OrderByName": "sample string 13",
      "OrderDate": "2024-09-19T11:44:49.512-07:00",
      "OrderState": "sample string 15",
      "OrderStatus": 16,
      "OrderStatusDisplay": "sample string 17",
      "PickupAddress1": "sample string 18",
      "PickupAddress2": "sample string 19",
      "PickupAddress3": "sample string 20",
      "PickupAddressFull": "sample string 38",
      "PickupCityName": "sample string 21",
      "PickupCompanyName": "sample string 22",
      "PickupCountryID": "sample string 23",
      "PickupPostalCode": "sample string 24",
      "PickupStateProvID": "sample string 25",
      "PodDateTime": "2024-09-19T11:44:49.513-07:00",
      "PodSignature": "sample string 26",
      "RecoverAirportID": "sample string 27",
      "Reference": "sample string 28",
      "RouteNumber": "sample string 29",
      "ServiceCode": "sample string 35",
      "ServiceName": "sample string 36",
      "ShipmentGUID": "sample string 30",
      "ShipmentNumber": 31,
      "TrackingNumber": "sample string 32",
      "UpdatedDeliveryDateTime": "2024-09-19T11:44:49.513-07:00",
      "UpdatedDeliveryDateTimeUTC": "2024-09-19T11:44:49.513-07:00",
      "WaybillNumber": "sample string 33"
    },
    {
      "ActualDepartDateTime": "2024-09-19T11:44:49.513-07:00",
      "ActualPickupDateTime": "2024-09-19T11:44:49.513-07:00",
      "ArriveDateTime": "2024-09-19T11:44:49.512-07:00",
      "Contents": "sample string 1",
      "DeliveryAddress1": "sample string 2",
      "DeliveryAddress2": "sample string 3",
      "DeliveryAddress3": "sample string 4",
      "DeliveryAddressFull": "sample string 39",
      "DeliveryCityName": "sample string 5",
      "DeliveryCompanyName": "sample string 6",
      "DeliveryCountryID": "sample string 7",
      "DeliveryPostalCode": "sample string 8",
      "DeliveryStateProvID": "sample string 9",
      "DisplayDeliveryAddress": "sample string 10",
      "DisplayPickupAddress": "sample string 11",
      "DropAirportID": "sample string 37",
      "EsimatedDeliveryDateTime": "2024-09-19T11:44:49.513-07:00",
      "EstimatedDepartDateTime": "2024-09-19T11:44:49.513-07:00",
      "EstimatedPickupDateTime": "2024-09-19T11:44:49.513-07:00",
      "HasCustomerNotes": true,
      "HasGPSDevice": true,
      "HoldForPickup": true,
      "OrderByName": "sample string 13",
      "OrderDate": "2024-09-19T11:44:49.512-07:00",
      "OrderState": "sample string 15",
      "OrderStatus": 16,
      "OrderStatusDisplay": "sample string 17",
      "PickupAddress1": "sample string 18",
      "PickupAddress2": "sample string 19",
      "PickupAddress3": "sample string 20",
      "PickupAddressFull": "sample string 38",
      "PickupCityName": "sample string 21",
      "PickupCompanyName": "sample string 22",
      "PickupCountryID": "sample string 23",
      "PickupPostalCode": "sample string 24",
      "PickupStateProvID": "sample string 25",
      "PodDateTime": "2024-09-19T11:44:49.513-07:00",
      "PodSignature": "sample string 26",
      "RecoverAirportID": "sample string 27",
      "Reference": "sample string 28",
      "RouteNumber": "sample string 29",
      "ServiceCode": "sample string 35",
      "ServiceName": "sample string 36",
      "ShipmentGUID": "sample string 30",
      "ShipmentNumber": 31,
      "TrackingNumber": "sample string 32",
      "UpdatedDeliveryDateTime": "2024-09-19T11:44:49.513-07:00",
      "UpdatedDeliveryDateTimeUTC": "2024-09-19T11:44:49.513-07:00",
      "WaybillNumber": "sample string 33"
    }
  ]
}

application/xml, text/xml

Sample:

<WatchListResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <Items>
    <WatchListItem>
      <ActualDepartDateTime>2024-09-19T11:44:49.5136119-07:00</ActualDepartDateTime>
      <ActualPickupDateTime>2024-09-19T11:44:49.5136119-07:00</ActualPickupDateTime>
      <ArriveDateTime>2024-09-19T11:44:49.5126127-07:00</ArriveDateTime>
      <Contents>sample string 1</Contents>
      <DeliveryAddress1>sample string 2</DeliveryAddress1>
      <DeliveryAddress2>sample string 3</DeliveryAddress2>
      <DeliveryAddress3>sample string 4</DeliveryAddress3>
      <DeliveryAddressFull>sample string 39</DeliveryAddressFull>
      <DeliveryCityName>sample string 5</DeliveryCityName>
      <DeliveryCompanyName>sample string 6</DeliveryCompanyName>
      <DeliveryCountryID>sample string 7</DeliveryCountryID>
      <DeliveryPostalCode>sample string 8</DeliveryPostalCode>
      <DeliveryStateProvID>sample string 9</DeliveryStateProvID>
      <DisplayDeliveryAddress>sample string 10</DisplayDeliveryAddress>
      <DisplayPickupAddress>sample string 11</DisplayPickupAddress>
      <DropAirportID>sample string 37</DropAirportID>
      <EsimatedDeliveryDateTime>2024-09-19T11:44:49.5136119-07:00</EsimatedDeliveryDateTime>
      <EstimatedDepartDateTime>2024-09-19T11:44:49.5136119-07:00</EstimatedDepartDateTime>
      <EstimatedPickupDateTime>2024-09-19T11:44:49.5136119-07:00</EstimatedPickupDateTime>
      <HasCustomerNotes>true</HasCustomerNotes>
      <HasGPSDevice>true</HasGPSDevice>
      <HoldForPickup>true</HoldForPickup>
      <OrderByName>sample string 13</OrderByName>
      <OrderDate>2024-09-19T11:44:49.5126127-07:00</OrderDate>
      <OrderState>sample string 15</OrderState>
      <OrderStatus>16</OrderStatus>
      <OrderStatusDisplay>sample string 17</OrderStatusDisplay>
      <PickupAddress1>sample string 18</PickupAddress1>
      <PickupAddress2>sample string 19</PickupAddress2>
      <PickupAddress3>sample string 20</PickupAddress3>
      <PickupAddressFull>sample string 38</PickupAddressFull>
      <PickupCityName>sample string 21</PickupCityName>
      <PickupCompanyName>sample string 22</PickupCompanyName>
      <PickupCountryID>sample string 23</PickupCountryID>
      <PickupPostalCode>sample string 24</PickupPostalCode>
      <PickupStateProvID>sample string 25</PickupStateProvID>
      <PodDateTime>2024-09-19T11:44:49.5136119-07:00</PodDateTime>
      <PodSignature>sample string 26</PodSignature>
      <RecoverAirportID>sample string 27</RecoverAirportID>
      <Reference>sample string 28</Reference>
      <RouteNumber>sample string 29</RouteNumber>
      <ServiceCode>sample string 35</ServiceCode>
      <ServiceName>sample string 36</ServiceName>
      <ShipmentGUID>sample string 30</ShipmentGUID>
      <ShipmentNumber>31</ShipmentNumber>
      <TrackingNumber>sample string 32</TrackingNumber>
      <UpdatedDeliveryDateTime>2024-09-19T11:44:49.5136119-07:00</UpdatedDeliveryDateTime>
      <UpdatedDeliveryDateTimeUTC>2024-09-19T11:44:49.5136119-07:00</UpdatedDeliveryDateTimeUTC>
      <WaybillNumber>sample string 33</WaybillNumber>
    </WatchListItem>
    <WatchListItem>
      <ActualDepartDateTime>2024-09-19T11:44:49.5136119-07:00</ActualDepartDateTime>
      <ActualPickupDateTime>2024-09-19T11:44:49.5136119-07:00</ActualPickupDateTime>
      <ArriveDateTime>2024-09-19T11:44:49.5126127-07:00</ArriveDateTime>
      <Contents>sample string 1</Contents>
      <DeliveryAddress1>sample string 2</DeliveryAddress1>
      <DeliveryAddress2>sample string 3</DeliveryAddress2>
      <DeliveryAddress3>sample string 4</DeliveryAddress3>
      <DeliveryAddressFull>sample string 39</DeliveryAddressFull>
      <DeliveryCityName>sample string 5</DeliveryCityName>
      <DeliveryCompanyName>sample string 6</DeliveryCompanyName>
      <DeliveryCountryID>sample string 7</DeliveryCountryID>
      <DeliveryPostalCode>sample string 8</DeliveryPostalCode>
      <DeliveryStateProvID>sample string 9</DeliveryStateProvID>
      <DisplayDeliveryAddress>sample string 10</DisplayDeliveryAddress>
      <DisplayPickupAddress>sample string 11</DisplayPickupAddress>
      <DropAirportID>sample string 37</DropAirportID>
      <EsimatedDeliveryDateTime>2024-09-19T11:44:49.5136119-07:00</EsimatedDeliveryDateTime>
      <EstimatedDepartDateTime>2024-09-19T11:44:49.5136119-07:00</EstimatedDepartDateTime>
      <EstimatedPickupDateTime>2024-09-19T11:44:49.5136119-07:00</EstimatedPickupDateTime>
      <HasCustomerNotes>true</HasCustomerNotes>
      <HasGPSDevice>true</HasGPSDevice>
      <HoldForPickup>true</HoldForPickup>
      <OrderByName>sample string 13</OrderByName>
      <OrderDate>2024-09-19T11:44:49.5126127-07:00</OrderDate>
      <OrderState>sample string 15</OrderState>
      <OrderStatus>16</OrderStatus>
      <OrderStatusDisplay>sample string 17</OrderStatusDisplay>
      <PickupAddress1>sample string 18</PickupAddress1>
      <PickupAddress2>sample string 19</PickupAddress2>
      <PickupAddress3>sample string 20</PickupAddress3>
      <PickupAddressFull>sample string 38</PickupAddressFull>
      <PickupCityName>sample string 21</PickupCityName>
      <PickupCompanyName>sample string 22</PickupCompanyName>
      <PickupCountryID>sample string 23</PickupCountryID>
      <PickupPostalCode>sample string 24</PickupPostalCode>
      <PickupStateProvID>sample string 25</PickupStateProvID>
      <PodDateTime>2024-09-19T11:44:49.5136119-07:00</PodDateTime>
      <PodSignature>sample string 26</PodSignature>
      <RecoverAirportID>sample string 27</RecoverAirportID>
      <Reference>sample string 28</Reference>
      <RouteNumber>sample string 29</RouteNumber>
      <ServiceCode>sample string 35</ServiceCode>
      <ServiceName>sample string 36</ServiceName>
      <ShipmentGUID>sample string 30</ShipmentGUID>
      <ShipmentNumber>31</ShipmentNumber>
      <TrackingNumber>sample string 32</TrackingNumber>
      <UpdatedDeliveryDateTime>2024-09-19T11:44:49.5136119-07:00</UpdatedDeliveryDateTime>
      <UpdatedDeliveryDateTimeUTC>2024-09-19T11:44:49.5136119-07:00</UpdatedDeliveryDateTimeUTC>
      <WaybillNumber>sample string 33</WaybillNumber>
    </WatchListItem>
  </Items>
</WatchListResp>