New Endpoints for Visibility Public API

Release Date: November 11, 2024

What’s New?

1. Visibility Public API Endpoints:

   • Introduces endpoints for tracking asset locations and receiving real-time event updates.

2. Endpoints Overview:

   • Inbound Visibility:

     • GET /api/p/v{version}/visibility/inbound/{loadNumber}/history: Retrieve location update history for a specific load number.

   • Outbound Visibility:

     • GET /api/p/v{version}/visibility/outbound/{loadNumber}/history: Retrieve event update history sent for a specific load number.
     • POST /api/p/v{version}/visibility/outbound/errors: Search for and manually resend failed updates using a time range filter.

Usage

Inbound Visibility Example

GET /api/p/v{version}/visibility/inbound/{{loadNumber}}/history

Outbound Visibility Examples

GET /api/p/v{version}/visibility/outbound/{{loadNumber}}/history

Search Failed Updates:

POST /api/p/v{version}/visibility/outbound/errors
{
  "page": 0,
  "pageSize": 10,
  "timeRange": {
    "start": "2024-11-05T16:58:54.450Z",
    "end": "2024-11-11T16:58:54.450Z"
  }
}

Additional Resources

• API Documentation
• Postman Collection

Important Notes

⚠️ Settings for EDI Integration:

• All EDI-related configurations must be done within the platform. Contact the support team if assistance is required.