LateShipment.com API Documentation

Welcome to the LateShipment.com API! This documentation provides all the information you need to interact with our API to pull shipping analytics, delivery reports, and dashboard summaries.

The base URL for all API endpoints is: https://api.lateshipment.com

Authentication

Authentication is handled via request headers. You will need two pieces of information from your LateShipment.com account:

• Admin Email ID: The email address of an administrator on your account.

• x-auth-key: Your unique API key.

You can find your x-auth-key in your account under the My Profile section.

You must include these in the headers of every API request:

• x-auth-email: Your account admin email ID.

• x-auth-key: Your API key.

Example Authentication Header

curl --location --request GET 'https://api.lateshipment.com/v1/...' \
--header 'x-auth-email: admin@yourcompany.com' \
--header 'x-auth-key: YOUR_X_AUTH_KEY'

Error Responses

If a request fails, the API will return an appropriate HTTP status code along with a JSON body containing error details.

Common Status Codes

• 401 Unauthorized: Your API key or email is invalid or missing.

• 400 Bad Request: The request was malformed, such as having an invalid date range.

• 404 Not Found: The requested resource could not be found.

• 500 Internal Server Error: Something went wrong on our end.

Example Error Payload (401 Unauthorized)

{
  "status": "error",
  "message": "Authentication failed. Please check your credentials."
}

API Endpoints

Shipping Analytics & Delivery Reports

These endpoints provide detailed reports on various aspects of your shipping operations. All endpoints in this section require a start_date and end_date query parameter in YYYY-MM-DD format to define the reporting period.

1. Comprehensive Report

Downloads or views the comprehensive shipping report.

• Method: GET

• Endpoint: /v1/reports/comprehensive

• Parameters:

  • start_date (string, required): The start date for the report (e.g., 2024-06-01).

  • end_date (string, required): The end date for the report (e.g., 2024-06-30).

Example Request:

curl --location --request GET 'https://api.lateshipment.com/v1/reports/comprehensive?start_date=2024-06-01&end_date=2024-06-30' \
--header 'x-auth-email: admin@yourcompany.com' \
--header 'x-auth-key: YOUR_X_AUTH_KEY'

Successful Response (200 OK):

{
  "status": "success",
  "report_name": "Comprehensive Report",
  "date_range": "2024-06-01 to 2024-06-30",
  "data": [
    {
      "tracking_number": "1Z999AA10123456784",
      "carrier": "UPS",
      "service_type": "Ground",
      "ship_date": "2024-06-15",
      "delivery_date": "2024-06-18",
      "cost": 12.50,
      "status": "Delivered"
    }
    // ... more records
  ]
}

Failed Response (400 Bad Request):

{
    "status": "error",
    "message": "Invalid date format. Please use YYYY-MM-DD."
}

2. Carrier Performance

View analytics on carrier performance.

• Method: GET

• Endpoint: /v1/reports/carrier-performance

Example Request:

curl --location --request GET 'https://api.lateshipment.com/v1/reports/carrier-performance?start_date=2024-06-01&end_date=2024-06-30' \
--header 'x-auth-email: admin@yourcompany.com' \
--header 'x-auth-key: YOUR_X_AUTH_KEY'

Successful Response (200 OK):

{
  "status": "success",
  "report_name": "Carrier Performance",
  "date_range": "2024-06-01 to 2024-06-30",
  "data": [
    {
      "carrier": "UPS",
      "total_shipments": 520,
      "on_time_percentage": 95.5,
      "average_transit_days": 2.8
    },
    {
      "carrier": "FedEx",
      "total_shipments": 450,
      "on_time_percentage": 97.1,
      "average_transit_days": 2.5
    }
    // ... more carriers
  ]
}

Other reports like Carrier Spend, Geographical, Chronological, and Custom Reports (by-sku) follow the same structure as above, requiring start_date and end_date parameters and returning relevant data structures.

Product Dashboard Summaries

These endpoints provide a high-level summary digest for each of your subscribed products over the last 30 days. No date range parameters are needed.

1. Delivery Experience Management (DEM)

Get the DEM dashboard summary.

• Method: GET

• Endpoint: /v1/dem/dashboard/digest

Example Request:

curl --location --request GET 'https://api.lateshipment.com/v1/dem/dashboard/digest' \
--header 'x-auth-email: admin@yourcompany.com' \
--header 'x-auth-key: YOUR_X_AUTH_KEY'

Successful Response (200 OK):

{
  "status": "success",
  "product_name": "Delivery Experience Management",
  "summary_period": "Last 30 Days",
  "data": {
    "total_shipments_tracked": 1204,
    "delivery_exceptions": 45,
    "customer_satisfaction_score": 4.8,
    "proactive_notifications_sent": 890
  }
}

Failed Response (404 Not Found):

{
    "status": "error",
    "message": "DEM dashboard data not found for this account."
}

2. Returns Experience Management (REM)

Get the REM dashboard summary.

• Method: GET

• Endpoint: /v1/rem/dashboard/digest

Example Request:

curl --location --request GET 'https://api.lateshipment.com/v1/rem/dashboard/digest' \
--header 'x-auth-email: admin@yourcompany.com' \
--header 'x-auth-key: YOUR_X_AUTH_KEY'

Successful Response (200 OK):

{
  "status": "success",
  "product_name": "Returns Experience Management",
  "summary_period": "Last 30 Days",
  "data": {
    "returns_initiated": 78,
    "average_return_processing_time_days": 3.2,
    "returns_rate": "6.5%"
  }
}

3. Shipping Insurance

Get the Insurance dashboard summary.

• Method: GET

• Endpoint: /v1/insurance/dashboard/digest

Example Request:

curl --location --request GET 'https://api.lateshipment.com/v1/insurance/dashboard/digest' \
--header 'x-auth-email: admin@yourcompany.com' \
--header 'x-auth-key: YOUR_X_AUTH_KEY'

Successful Response (200 OK):

{
  "status": "success",
  "product_name": "Shipping Insurance",
  "summary_period": "Last 30 Days",
  "data": {
    "shipments_insured": 1500,
    "total_insured_value": 75000.00,
    "claims_filed": 5,
    "claims_approved_value": 1250.50
  }
}

4. Parcel Audit & Shipping Refunds

Get the Audit/Refunds dashboard summary.

• Method: GET

• Endpoint: /v1/audit/dashboard/digest

Example Request:

curl --location --request GET 'https://api.lateshipment.com/v1/audit/dashboard/digest' \
--header 'x-auth-email: admin@yourcompany.com' \
--header 'x-auth-key: YOUR_X_AUTH_KEY'

Successful Response (200 OK):

{
  "status": "success",
  "product_name": "Parcel Audit & Shipping Refunds",
  "summary_period": "Last 30 Days",
  "data": {
    "total_refunds_claimed": 1245.78,
    "late_delivery_refunds": 850.22,
    "billing_error_refunds": 395.56,
    "audited_invoices": 35
  }
}