---
title: "Track a package and update partnership tracking information"
method: POST
path: "/api/package_tracking"
tags: ["Package Tracking"]
---

# Track a package and update partnership tracking information

`POST /api/package_tracking`

## Request

- Base URL: `https://api.kolect.com`
- URL: `https://api.kolect.com/api/package_tracking`
- Auth: HTTP bearer

This endpoint tracks a package using the RapidAPI tracking service and updates
the partnership tracking information in the database. It can track by tracking
number or by partnership ID.

## Request body

- union
  - object
    - `tracking_number` string, required: Package tracking number
    - `partnership_id` string, uuid: Campaign partnership ID to update tracking for
    - `update_database` boolean: Whether to update the database with tracking information
    - `validate_only` boolean: Only validate tracking number format without fetching data
    - `carrier_name` string: Optional carrier name (e.g., "cainiao") to force use of specific tracking API
  - object
    - `tracking_number` string: Package tracking number
    - `partnership_id` string, uuid, required: Campaign partnership ID to update tracking for
    - `update_database` boolean: Whether to update the database with tracking information
    - `validate_only` boolean: Only validate tracking number format without fetching data
    - `carrier_name` string: Optional carrier name (e.g., "cainiao") to force use of specific tracking API

## Response `200`

Tracking information retrieved successfully

- object
  - `success` boolean
  - `data` object
    - `trackingNumber` string
    - `carrier` string
    - `serviceType` string
    - `status` 'shipped' | 'delivered' | 'failed'
    - `delivered` boolean
    - `scheduledDeliveryDate` string, date-time
    - `deliveredDateTime` string, date-time
    - `destinationCity` string
    - `destinationState` string
    - `destinationCountry` string
  - `partnership_updated` boolean: Whether partnership tracking was updated in database
  - `tracking_id` string, uuid: ID of the tracking record in database

## Other responses

- `400`: Bad request - missing or invalid parameters
- `404`: Partnership not found or tracking information not available
- `500`: Server error or tracking API error

---

[API](https://skmtc.dev/kolect/apis/kolect-api.md) · [All operations](https://skmtc.dev/kolect/apis/kolect-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kolect/apis/kolect-api/revisions/fe54528e8f54?raw)