Skip to main content

trackAndTraceCreate

Create new tracking information for a shipment with carrier details and tracking codes.

Establishes a new tracking record for monitoring shipment progress through the delivery network. This operation is essential for providing customers with tracking capabilities and maintaining visibility into shipment status throughout the delivery process.

The tracking creation process includes:

  • Tracking record initialization with unique identifier
  • Carrier association and tracking code assignment
  • Shipment linkage for order context

Validation requirements:

  • Shipment ID must reference an existing, accessible shipment
  • Tracking code must be provided and unique within the carrier system
  • Carrier ID must reference a valid carrier if provided
  • All required tracking information must be complete

Possible errors:

  • TRACK_AND_TRACE_CREATE_ERROR: Failed to create tracking record due to system error
  • SHIPMENT_NOT_FOUND_ERROR: Referenced shipment does not exist or is not accessible
  • VALIDATION_ERROR: Input validation failed (missing required fields, invalid format, duplicate tracking code)
  • FORBIDDEN: Insufficient permissions to create tracking information

AUTH: Role=[order.OWNER,order.EDITOR]

trackAndTraceCreate(
  input: TrackAndTraceCreateInput!
): TrackAndTrace!

Arguments​

trackAndTraceCreate.input ● TrackAndTraceCreateInput! non-null input​

Complete tracking information for creating a new tracking record.

Required components:

  • Shipment ID: Valid shipment identifier that this tracking information relates to
  • Tracking code: Carrier-provided tracking number or reference code

Optional components:

  • Carrier ID: Identifier of the shipping carrier handling the package
  • Status information: Initial tracking status and location data
  • Delivery details: Expected delivery dates and recipient information

All tracking codes must be unique within the carrier system to prevent conflicts.

Type​

TrackAndTrace object​

Package tracking and shipment monitoring record.

Represents a tracking entry for shipments handled by carriers, providing linkage between tracking information and carrier services for comprehensive shipment visibility.