BObotbrains-io
📦 Trackers

Create a tracker

Changed on

This endpoint allows you to create a new Tracker, based on the specified information. Once a Tracker is created, you will be able to receive webhook notifications and/or fetch its tracking result.

This endpoint is idempotent, any subsequent calls with the same parameters won't duplicate Tracker. However, providing different information in any of the fields will create a new Tracker, as it will be considered as a new shipment.

post/public/v1/trackers

Request

Request body

trackingNumberstring required

Tracking number of the shipment.

shipmentReferencestring

Your reference for this shipment. Will be provided in our webhooks or API responses for this tracker.

clientTrackerIdstring

Your unique identifier for this shipment. Will be provided in our webhooks or API responses for this tracker.

originCountryCodestring ISO 3166-1 alpha-2/alpha-3

Sender country code.

destinationCountryCodestring ISO 3166-1 alpha-2/alpha-3

Recipient country code - 📌 Recommended to improve tracking accuracy

destinationPostCodestring

Recipient Post code (or ZIP code) - 📌 Recommended to improve tracking accuracy

shippingDatestring date-time

Date at which the shipment has been shipped - 📌 Recommended to improve tracking accuracy: providing the shipping date helps us accurately identify the shipment and improves our ability to retrieve the correct data. However, an inaccurate shipping date could cause our system to exclude the right shipment. Therefore, please ensure the provided shipping date aligns closely with the actual shipment date, give or take a few days. Format

courierNamestring

Courier name and/or service.

trackingUrlstring

Tracking URL of the courier.

orderNumberstring

Order number in case of an eCommerce order.

titlestring

Title for this shipment, visible on the Tracking Dashboard.

Response

Created

Changes

  • 49b1d626be36Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      added the pattern ^[a-zA-Z0-9- ._/]*$ to the request property

    • warning

      deleted the header request parameter Authorization

    • warning

      deleted the header request parameter Content-Type

    • warning

      the request property's maxLength was set to 32

    • info

      the endpoint scheme security Authorization was added to the API

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status