Logistics API: Tracking

Logistics API: Tracking



The tracking resource allows the merchant to view real-time tracking information about a parcel. Instead of having to query different APIs for USPS, UPS, and FedEx tracking numbers, the merchant can use a single Shipvine Logistics API that abstracts away the carrier method systems.



URL Template

The {identificationNo} in the URL template should be replaced with the appropriate tracking number.

Example Request URL


Query Parameters

No query parameters may be included in the request.

Entity Body

No entity body may be includedin the request.


If successful, the API will return 200 OK as well as a <Tracking /> element in the entity body. See the XML schema for details about that element.

If any error occurs, the HTTP status code will not be 200 OK. An <Errors /> element may be present in the entity body.

A 404 Not Found response is typical for carriers that do not support real-time tracking or for requests that are made soon after the outbound shipment has been created. (Some carriers, such as USPS, take up to one day for information to be available in their systems.)

Example Response Entity Body

<?xml version="1.0" encoding="utf-8"?>
<Tracking xmlns="urn:WarehouseFS-1.0">
  <Status>EnRoute</Status> < -- (1) -- >
  <Waypoints> < -- (2) -- >
      <Location>ENGLEWOOD, CO  80110</Location>
      <Note>Arrival at Unit</Note>
      <Location>DENVER, CO  80217</Location>
      <Note>Processed through Sort Facility</Note>
      <Location>BOULDER, CO  80302</Location>
      <Note>Electronic Shipping Info Received</Note>
  1. The current status of the shipment. The current possible values are Unknown (which indicates an exceptional status code), Pending (which indicates a newly-created outbound shipment), EnRoute, Delivered, and Problem (which indicates a delivery exception.
  2. Each <Waypoint /> element, if any, provides a textual description and location that details the parcel's progress. While Shipvine Logistics prefers to use universal coordinated time (UTC) for all date and time fields, it has been Shipvine's experience that the vast majority of carriers return tracking data in time relative to the location of the tracking event. Therefore, all times returned in this resource are local time. Not all carriers record timestamps, and the <TransactedAtLocal /> element may be missing or empty.

    • Related Articles

    • Logistics API: Fulfillment Requests

      Resource #1 https://api.warehousefs.com/public/v1/fulfillment-requests The fulfillment requests resource allows the merchant to search for the Shipvine identifier assigned to requests for a given merchant identifier. GET Request Query Parameters The ...
    • Logistics API: Inbound Shipments

      Resource #1 https://api.warehousefs.com/public/v1/inbound-shipments/{merchantCode} This version of the inbound shipments resource allows the merchant to query for a listing of inbound shipments that may have been recently completed. GET Request URL ...
    • Logistics API: Item Groups

      Resource https://api.warehousefs.com/public/v1/item-groups/{merchantCode}/{merchantIdentifier} The item groups resource allows the merchant to programmatically enter catalog information into the Shipvine Logistics system. In Shipvine's vocabulary, an ...
    • Logistics API: Items

      Resource https://api.warehousefs.com/public/v1/item-groups/{merchantCode}/{groupMerchantIdentifier}/items/{itemMerchantIdentifier} The items resource allows the merchant to programmatically enter catalog information into the Shipvine Logistics ...
    • Logistics API: Stock Reservations

      Resource https://api.warehousefs.com/public/v1/stock-reservations/{merchantCode}/{merchantIdentifier} The stock reservations resource allows the merchant to create, update, and delete reservations of stock in the system. A stock reservation increased ...