Update SendDropShipmentComment

Update-SendDropShipmentComment

SYNOPSIS

Updates the internal comment of a SendDrop shipment.

SYNTAX

Update-SendDropShipmentComment [-ShipmentId] <Guid> [-Comment] <String> 
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Update-SendDropShipmentComment function updates the internal comment of an existing shipment through the SendDrop API. The comment is for internal tracking and organization purposes. It requires a valid connection established via Connect-SendDrop.

EXAMPLES

EXAMPLE 1

Update-SendDropShipmentComment -ShipmentId "550e8400-e29b-41d4-a716-446655440000" `
    -Comment "Delivered to customer, package slightly damaged"

Updates the internal comment for the specified shipment.

EXAMPLE 2

Update-SendDropShipmentComment -ShipmentId "550e8400-e29b-41d4-a716-446655440000" `
    -Comment "Follow up required" -Confirm

Updates the comment with a confirmation prompt.

EXAMPLE 3

Get-SendDropShipment | Update-SendDropShipmentComment -Comment "Important order - fragile contents"

Updates the comment for shipments piped from Get-SendDropShipment.

PARAMETERS

-Comment

The comment text to set for the shipment. This parameter is required.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ShipmentId

The UUID of the shipment to update. This parameter is required.

Type: Guid
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Object

NOTES

Requires a valid connection established via Connect-SendDrop. Uses the API endpoint: PATCH /api/v1/shipments/{id}/comment The comment is for internal use and is not visible to the customer. Supports pipeline input from Get-SendDropShipment for the ShipmentId parameter.

RELATED LINKS