Workflow - Brand Actions

Create a new shipment with tracking information

Creates a new shipment for a partnership by validating the tracking number, saving tracking information to the database, and notifying the creator via webhook. This endpoint replaces the legacy update-shipment workflow by using the new partnership_tracking table and automatic tracking validation.

post/api/v1/workflow/agent/brand-actions/create-shipment

Request

  • Base URL: https://api.kolect.com
  • URL: https://api.kolect.com/api/v1/workflow/agent/brand-actions/create-shipment
  • Auth: HTTP bearer

Request body

partnership_idstring uuid required

The ID of the campaign partnership

tracking_numberstring required

Package tracking number from shipping carrier

carrier_namestring

Optional carrier name to force use of specific tracking API (e.g., "cainiao")

Example request

{
  "partnership_id": "123e4567-e89b-12d3-a456-426614174000",
  "tracking_number": "1Z8339V50327625354",
  "carrier_name": "cainiao"
}

Response

Shipment created successfully

successboolean

Example response

{
  "success": true,
  "data": {
    "partnership_id": "123e4567-e89b-12d3-a456-426614174000",
    "tracking_number": "1Z8339V50327625354",
    "carrier_name": "UPS",
    "tracking_status": "shipped",
    "shipment_status": "in transit",
    "partnership_tracking_updated": true,
    "tracking_id": "987fcdeb-51a2-43d1-b123-426614174789"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.