POST api/Tracking_V1

Track your shipment with 2ship

Request Information

URI Parameters

None.

Body Parameters

The request is presented below!

WS_Repository.Models.Requests.Tracking.TrackingRequest

Name	Description	Type	Additional information
WS_Key	(Mandatory) Webservice Key provided by 2ship support	string	None.
FindBy	Find Shipment by type	WS_Repository.Models.Requests.Tracking.FindShipmentByType	None.
TrackingNumber	(Optional) The tracking Number to Track - Required if FindBy = ByTrackingNumber	string	None.
ShipmentID	(Optional) ShipmentID - to identify the shipment - Required if FindBy = ByShipmentID	integer	None.
OrderNumber	(Optional) Shipment Order Number - to identify the shipment - Required if FindBy = ByOrderNumber	string	None.
CarrierId	(Optiona) Carrier ID defines the carrier associated to the tracking number. - to be suere it find the right shipment use the carrier id	integer	None.
StartDate	(Optional) The start date period to search for the tracking number - by default it is set to 45 days before current date time	date	None.
EndDate	(Optional) The end date period to search for the tracking number - by default it is to current date time	date	None.

Request Formats

application/json, text/json

Sample:

{
  "WS_Key": "sample string 1",
  "FindBy": 0,
  "TrackingNumber": "sample string 2",
  "ShipmentID": 3,
  "OrderNumber": "sample string 4",
  "CarrierId": 5,
  "StartDate": "2024-04-23T22:45:35.7414756-04:00",
  "EndDate": "2024-04-23T22:45:35.7424751-04:00"
}

application/xml, text/xml

Sample:

<TrackingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Tracking">
  <CarrierId>5</CarrierId>
  <EndDate>2024-04-23T22:45:35.7424751-04:00</EndDate>
  <FindBy>ByTrackingNumber</FindBy>
  <OrderNumber>sample string 4</OrderNumber>
  <ShipmentID>3</ShipmentID>
  <StartDate>2024-04-23T22:45:35.7414756-04:00</StartDate>
  <TrackingNumber>sample string 2</TrackingNumber>
  <WS_Key>sample string 1</WS_Key>
</TrackingRequest>

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.Tracking.TrackingRequest'.

Response Information

Resource Description

WS_Repository.Models.Responses.Tracking.TrackingResponse

Name	Description	Type	Additional information
TrackingStatusCode	The Status Code of your shipment	string	None.
TrackingStatusDescription	The status Description of your shipment	string	None.
EstimatedDeliveryDate	Estimated delivery date if not delivered alrready	date	None.
DeliveryDate	Delivery date, if the shipment was delivered	date	None.
TrackingStatus	The status of your shipment (ex: Delivered, In Transit etc)	string	None.
SignatureBase64String	if is not empty it contains the base64 string of the signature image	string	None.
SignedBy	Signed By	string	None.
Events	List Of Tracking Events	Collection of WS_Repository.Models.Responses.Tracking.TrackingEvents	None.
ShipmentId	Shipment Id	integer	None.
OrderNo	Shipment Order Number	string	None.
TrackingNumber	Shipment Master Tracking Number	string	None.
ShipmentReference	Shipment Reference	string	None.
ShipmentPONumber	Shipment PO #	string	None.
WebhookType	Webhook Type	string	None.

Response Formats

application/json, text/json

Sample:

{
  "TrackingStatusCode": "sample string 1",
  "TrackingStatusDescription": "sample string 2",
  "EstimatedDeliveryDate": "2024-04-23T22:45:35.7445434-04:00",
  "DeliveryDate": "2024-04-23T22:45:35.7445434-04:00",
  "TrackingStatus": "sample string 5",
  "SignatureBase64String": "sample string 6",
  "SignedBy": "sample string 7",
  "Events": [
    {
      "ScanDate": "2024-04-23T22:45:35.7445434-04:00",
      "Status": 0,
      "Description": "sample string 2",
      "ScanLocationInfo": {
        "Country": "sample string 1",
        "Province": "sample string 2",
        "City": "sample string 3",
        "PostalCode": "sample string 4"
      }
    },
    {
      "ScanDate": "2024-04-23T22:45:35.7445434-04:00",
      "Status": 0,
      "Description": "sample string 2",
      "ScanLocationInfo": {
        "Country": "sample string 1",
        "Province": "sample string 2",
        "City": "sample string 3",
        "PostalCode": "sample string 4"
      }
    }
  ],
  "ShipmentId": 8,
  "OrderNo": "sample string 9",
  "TrackingNumber": "sample string 10",
  "ShipmentReference": "sample string 11",
  "ShipmentPONumber": "sample string 12",
  "WebhookType": "sample string 13"
}

application/xml, text/xml

Sample:

<TrackingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.Tracking">
  <DeliveryDate>2024-04-23T22:45:35.7445434-04:00</DeliveryDate>
  <EstimatedDeliveryDate>2024-04-23T22:45:35.7445434-04:00</EstimatedDeliveryDate>
  <Events>
    <TrackingEvents>
      <Description>sample string 2</Description>
      <ScanDate>2024-04-23T22:45:35.7445434-04:00</ScanDate>
      <ScanLocationInfo>
        <City>sample string 3</City>
        <Country>sample string 1</Country>
        <PostalCode>sample string 4</PostalCode>
        <Province>sample string 2</Province>
      </ScanLocationInfo>
      <Status>PickedUp</Status>
    </TrackingEvents>
    <TrackingEvents>
      <Description>sample string 2</Description>
      <ScanDate>2024-04-23T22:45:35.7445434-04:00</ScanDate>
      <ScanLocationInfo>
        <City>sample string 3</City>
        <Country>sample string 1</Country>
        <PostalCode>sample string 4</PostalCode>
        <Province>sample string 2</Province>
      </ScanLocationInfo>
      <Status>PickedUp</Status>
    </TrackingEvents>
  </Events>
  <OrderNo>sample string 9</OrderNo>
  <ShipmentId>8</ShipmentId>
  <ShipmentPONumber>sample string 12</ShipmentPONumber>
  <ShipmentReference>sample string 11</ShipmentReference>
  <SignatureBase64String>sample string 6</SignatureBase64String>
  <SignedBy>sample string 7</SignedBy>
  <TrackingNumber>sample string 10</TrackingNumber>
  <TrackingStatus>sample string 5</TrackingStatus>
  <TrackingStatusCode>sample string 1</TrackingStatusCode>
  <TrackingStatusDescription>sample string 2</TrackingStatusDescription>
  <WebhookType>sample string 13</WebhookType>
</TrackingResponse>