POST api/GetShipmentsTrackingStatus_V1

Get Shipments tracking statuses

Request Information

URI Parameters

None.

Body Parameters

The request is presented below!

WS_Repository.Models.Requests.Shipments.GetShipmentsTrackingStatusRequest

Name	Description	Type	Additional information
WS_Key	Required - Webservice Key provided by 2ship support	string	None.
FindByType	Required - Indicate what field is used in the search for Search value	WS_Repository.Models.Requests.Shipments.FindShipmentByType	None.
SearchValue	Required - Search value	string	None.
DateRange	Required - the time interval of the ShipDate in which you want to search for shipments - restricted to maximum 60 days	WS_Repository.Models.Requests.Shipments.GetShipmentsTrackingStatusDateRange	None.

Request Formats

application/json, text/json

Sample:

{
  "WS_Key": "sample string 1",
  "FindByType": 0,
  "SearchValue": "sample string 2",
  "DateRange": {
    "DateStart": "2024-05-03T16:54:02.5402464-04:00",
    "DateEnd": "2024-05-03T16:54:02.5402464-04:00"
  }
}

application/xml, text/xml

Sample:

<GetShipmentsTrackingStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Shipments">
  <DateRange>
    <DateEnd>2024-05-03T16:54:02.5402464-04:00</DateEnd>
    <DateStart>2024-05-03T16:54:02.5402464-04:00</DateStart>
  </DateRange>
  <FindByType>ByPONumber</FindByType>
  <SearchValue>sample string 2</SearchValue>
  <WS_Key>sample string 1</WS_Key>
</GetShipmentsTrackingStatusRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'WS_Repository.Models.Requests.Shipments.GetShipmentsTrackingStatusRequest'.

Response Information

Resource Description

WS_Repository.Models.Responses.Shipments.GetShipmentsTrackingStatusResponse

Name	Description	Type	Additional information
Success	Indicate if the the response is succeeded	boolean	None.
ErrorMessage	Error message if the response is not succeeded	string	None.
ShipmentsList	List of shipments with their statuses	Collection of WS_Repository.Models.Responses.Shipments.ShipmentSummaryStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "ErrorMessage": "sample string 2",
  "ShipmentsList": [
    {
      "ShipmentID": 1,
      "LabelGenerationDate": "2024-05-03T16:54:02.5482423-04:00",
      "OrderNumber": "sample string 2",
      "MasterTrackingNumber": "sample string 3",
      "TrackingStatus": 0,
      "TrackingStatusDescription": "sample string 4",
      "TrackingStatusDateTime": "2024-05-03T16:54:02.5492449-04:00",
      "PackagesTrackingStatus": [
        {
          "TrackingNumber": "sample string 1",
          "TrackingStatus": 0,
          "TrackingStatusDescription": "sample string 2",
          "TrackingStatusDateTime": "2024-05-03T16:54:02.5492449-04:00"
        },
        {
          "TrackingNumber": "sample string 1",
          "TrackingStatus": 0,
          "TrackingStatusDescription": "sample string 2",
          "TrackingStatusDateTime": "2024-05-03T16:54:02.5492449-04:00"
        }
      ]
    },
    {
      "ShipmentID": 1,
      "LabelGenerationDate": "2024-05-03T16:54:02.5482423-04:00",
      "OrderNumber": "sample string 2",
      "MasterTrackingNumber": "sample string 3",
      "TrackingStatus": 0,
      "TrackingStatusDescription": "sample string 4",
      "TrackingStatusDateTime": "2024-05-03T16:54:02.5492449-04:00",
      "PackagesTrackingStatus": [
        {
          "TrackingNumber": "sample string 1",
          "TrackingStatus": 0,
          "TrackingStatusDescription": "sample string 2",
          "TrackingStatusDateTime": "2024-05-03T16:54:02.5492449-04:00"
        },
        {
          "TrackingNumber": "sample string 1",
          "TrackingStatus": 0,
          "TrackingStatusDescription": "sample string 2",
          "TrackingStatusDateTime": "2024-05-03T16:54:02.5492449-04:00"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<GetShipmentsTrackingStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.Shipments">
  <ErrorMessage>sample string 2</ErrorMessage>
  <ShipmentsList>
    <ShipmentSummaryStatus>
      <LabelGenerationDate>2024-05-03T16:54:02.5482423-04:00</LabelGenerationDate>
      <MasterTrackingNumber>sample string 3</MasterTrackingNumber>
      <OrderNumber>sample string 2</OrderNumber>
      <PackagesTrackingStatus>
        <PackageSummaryStatus>
          <TrackingNumber>sample string 1</TrackingNumber>
          <TrackingStatus>PickedUp</TrackingStatus>
          <TrackingStatusDateTime>2024-05-03T16:54:02.5492449-04:00</TrackingStatusDateTime>
          <TrackingStatusDescription>sample string 2</TrackingStatusDescription>
        </PackageSummaryStatus>
        <PackageSummaryStatus>
          <TrackingNumber>sample string 1</TrackingNumber>
          <TrackingStatus>PickedUp</TrackingStatus>
          <TrackingStatusDateTime>2024-05-03T16:54:02.5492449-04:00</TrackingStatusDateTime>
          <TrackingStatusDescription>sample string 2</TrackingStatusDescription>
        </PackageSummaryStatus>
      </PackagesTrackingStatus>
      <ShipmentID>1</ShipmentID>
      <TrackingStatus>PickedUp</TrackingStatus>
      <TrackingStatusDateTime>2024-05-03T16:54:02.5492449-04:00</TrackingStatusDateTime>
      <TrackingStatusDescription>sample string 4</TrackingStatusDescription>
    </ShipmentSummaryStatus>
    <ShipmentSummaryStatus>
      <LabelGenerationDate>2024-05-03T16:54:02.5482423-04:00</LabelGenerationDate>
      <MasterTrackingNumber>sample string 3</MasterTrackingNumber>
      <OrderNumber>sample string 2</OrderNumber>
      <PackagesTrackingStatus>
        <PackageSummaryStatus>
          <TrackingNumber>sample string 1</TrackingNumber>
          <TrackingStatus>PickedUp</TrackingStatus>
          <TrackingStatusDateTime>2024-05-03T16:54:02.5492449-04:00</TrackingStatusDateTime>
          <TrackingStatusDescription>sample string 2</TrackingStatusDescription>
        </PackageSummaryStatus>
        <PackageSummaryStatus>
          <TrackingNumber>sample string 1</TrackingNumber>
          <TrackingStatus>PickedUp</TrackingStatus>
          <TrackingStatusDateTime>2024-05-03T16:54:02.5492449-04:00</TrackingStatusDateTime>
          <TrackingStatusDescription>sample string 2</TrackingStatusDescription>
        </PackageSummaryStatus>
      </PackagesTrackingStatus>
      <ShipmentID>1</ShipmentID>
      <TrackingStatus>PickedUp</TrackingStatus>
      <TrackingStatusDateTime>2024-05-03T16:54:02.5492449-04:00</TrackingStatusDateTime>
      <TrackingStatusDescription>sample string 4</TrackingStatusDescription>
    </ShipmentSummaryStatus>
  </ShipmentsList>
  <Success>true</Success>
</GetShipmentsTrackingStatusResponse>