DOCSEARCHbyAlgolia
Submit Docs

Delivery Tracker API Documentation

website·Indexed 31 days ago

https://tracker.delivery

Documentation for the Delivery Tracker API, a GraphQL-based service for shipment tracking and shipping requests. Includes API schema details for TrackEvent and TrackInfo, authentication guides, i18n support, and client library integration for JVM (Apollo Kotlin) and Node.js (graphql-request).

Tokens
44.3K
Snippets
147
Records
440
Agent score
59%

What's inside Delivery Tracker

  1. Interact with Delivery Tracker API via Raw HTTP

    The Delivery Tracker API is based on GraphQL Over HTTP. Developers can interact with the API by sending raw HTTP requests to the server using any standard GraphQL client ecosystem.

  2. Retrieve full tracking history and sender information

    The TrackInfo object provides comprehensive details about a waybill, including sender information and a list of tracking events. By default, you can retrieve the last 10 events; for larger datasets, use the API's pagination features.

  3. Compare Delivery Tracker Cloud vs Self-Hosted versions

    Delivery Tracker is available as both a Managed Cloud service and a Self-Hosted version based on the open-source Delivery Tracker Core.

    Key Differences:

    • Management: Cloud is a managed service requiring no infrastructure setup. Self-Hosted requires manual management of scrapers, infrastructure, and incident response.
    • Stability: Cloud includes internal systems to ensure high service stability.
    • API Capabilities:
      • Both support the Query.track API (Self-Hosted via Docker within license limits).
      • Only Cloud supports the Tracking Webhook API for status change notifications.
      • Only Cloud supports Tracking API extensions such as searchText in Query.carriers.
    • Quotas: Cloud follows specific project-based quota policies. Self-Hosted quotas depend on the user's infrastructure and the target carrier's server limits.
    • Customization: Self-Hosted allows full modification of the open-source code to add or change API behavior. Cloud provides a standardized, user-friendly interface.

    Core Source Code: The Self-Hosted version is based on the Delivery Tracker Core GitHub repository.

  4. Understand Delivery Tracker service limitations and warranties

    Delivery Tracker is provided on an "as-is" and "as-available" basis. The service does not provide actual delivery services; it is a tracking tool. Users are responsible for complying with the terms of service of the third-party delivery carriers whose information is accessed via the platform. Delivery Tracker disclaims all warranties regarding merchantability, fitness for a particular purpose, accuracy, completeness, or authenticity of delivery information.

  5. Understand Delivery Tracker payment and billing terms

    Delivery Tracker paid services and products are sold via Paddle, which acts as the Merchant of Record and authorized reseller. Payments are processed through Paddle using credit or debit cards. Prices are displayed in the specified currency and typically exclude taxes (VAT, GST, etc.), which are automatically calculated by Paddle based on the customer's location.

  6. Compare Delivery Tracker Cloud vs Self-Hosted deployment

    Delivery Tracker is available as both a Managed Cloud service and a Self-Hosted version. Both are based on the Delivery Tracker Core code available on GitHub, but they differ in operational overhead and feature set:

    • Management & Reliability: The Cloud version is a managed service handling infrastructure, scraper updates, and stability. Self-hosted users must manage their own infrastructure, failure responses, and scraper code changes.
    • API Availability:
      • Query.track API: Available in both. Cloud provides built-in stability measures; Self-hosted requires Docker configuration and potential additional development.
      • Tracking Webhook API: Available only in the Cloud version for detecting waybill status changes.
      • Extended API Features: Cloud provides additional features (e.g., searchText in Query.carriers) not available in the core self-hosted version.
    • Customization: Self-hosted allows full modification of the published code to adapt the API to specific contexts. Cloud offers a more standardized, user-friendly interface.
    • Quotas: Cloud is subject to project-specific quota policies. Self-hosted quotas depend on the user's own infrastructure and the carrier's server-side limits.

  7. Understand Delivery Tracker data collection and usage

    Delivery Tracker collects personal information through three primary channels: information provided directly by the user, automatically collected information during service interaction, and information from third-party sources (service providers, partners, and public sources). This data is used for providing services (registration, subscription, payments), measuring and improving service performance, personalization, legal compliance, communication, marketing, and fraud prevention.

  8. Use Delivery Tracker Core (Self-hosted)

    For users who prefer not to use the managed cloud service, Delivery Tracker Core is available as a self-hosted version. It is free to use under its specific license available on GitHub.
    # View the self-hosted core on GitHub
https://github.com/shlee322/delivery-tracker

  9. Choose between Delivery Tracker Cloud and Self-Hosted deployment

    Delivery Tracker offers two deployment options: a Managed Cloud service for ease of use, or a Self-Hosted option for users who prefer to manage their own infrastructure. The core source code is open-source and available on GitHub for community contribution.
    # Access the core source code on GitHub
https://github.com/shlee322/delivery-tracker

  10. Choose between Delivery Tracker Cloud and Self-Hosted deployment

    Delivery Tracker offers two deployment models: a Managed-Service (Cloud) and a Self-Hosted configuration. The core service is open-source and available on GitHub for those who wish to contribute or manage their own instance.
    # Delivery Tracker Core source code
https://github.com/shlee322/delivery-tracker

  11. Understand how Delivery Tracker collects and uses personal data

    Delivery Tracker collects personal information through three primary channels: information provided directly by the user, automatically collected information during service interaction, and information from third-party sources (service providers, partners, and public sources).

    This data is used for the following purposes:

    • Providing services (registration, subscriptions, payments).
    • Measuring, supporting, and improving service performance and fixing errors.
    • Personalization and recommendations based on user preferences.
    • Compliance with legal obligations.
    • Communication via phone, email, or chat.
    • Marketing and promotional activities.
    • Fraud prevention, abuse detection, and credit risk management.

  12. Integrate shipment tracking into a service

    Depending on your technical resources, you can add tracking functionality to your service using one of two methods: use the Tracking API for custom development or use Tracking Links for a simpler implementation without requiring deep technical expertise.