Retrieve Trade Tracking Details

GET /api/v1/trade-trackings/{trackingId}

Description

Retrieves detailed information about a specific trade tracking entry. This endpoint is used to access comprehensive details about the shipment's itinerary, delivery status, and associated logistics details, which is crucial for monitoring and managing trade logistics.

URL Parameters:

• trackingId (required): The unique identifier of the trade tracking entry to be retrieved. This must be included in the URL path.

Headers:

• tenantId (required): The tenant ID under which the trade tracking is registered. This header identifies the specific tenant environment and should be included.
• userId (required): The user ID of the individual querying the trade tracking. This header is used for authentication and authorization.

Example Request:

curl -G "http://[base_url]/api/v1/trade-trackings/{trackingId}" \
     -H "Authorization: Bearer [access_token]" \
     -H "tenantId: TEN123" \
     -H "userId: USR456"

Responses:

• 200 OK: Successfully retrieved the details of the trade tracking. The response includes comprehensive information such as itinerary details, delivery status, and links to associated documents.

Example Response:

{
  "trackingId": "TRACK123",
  "tradeId": "TRADE789",
  "itenary": [
    {
      "origin": "Berlin, Germany",
      "destination": "Paris, France",
      "shippingDate": "2023-04-05",
      "deliveryDate": "2023-04-07",
      "trackingProvider": "Global Express",
      "deliveryMode": "Air",
      "finalDestination": true,
      "qualityChecked": true,
      "labellingDetails": "Handle with care",
      "docLinks": [
        {
          "name": "Delivery Receipt",
          "link": "http://example.com/delivery-receipt.pdf"
        }
      ]
    }
  ],
  "deliveredQuantity": 100,
  "userId": "USR456",
  "tenantId": "TEN123",
  "countryCode": "DE"
}

Error Responses:

• 400 Bad Request: Incorrect parameters provided.
• 404 Not Found: No tracking found with the provided trackingId.
• 403 Forbidden: The user does not have permission to view the tracking details.