Add SendDropShipmentDocument

Add-SendDropShipmentDocument

SYNOPSIS

Uploads a PDF document for a shipment.

SYNTAX

Add-SendDropShipmentDocument [-ShipmentId] <String> [-FilePath] <String> [-DocumentType] <String>
 [[-DocumentName] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Add-SendDropShipmentDocument function uploads a PDF document to an existing shipment through the SendDrop API. It uses the previously configured connection and Bearer Token.

EXAMPLES

EXAMPLE 1

Add-SendDropShipmentDocument -ShipmentId "SHIP123456" -FilePath "C:\Labels\shipping_label.pdf" -DocumentType "label"

Uploads a shipping label PDF to the specified shipment.

EXAMPLE 2

Add-SendDropShipmentDocument -ShipmentId "SHIP123456" -FilePath ".\invoice.pdf" -DocumentType "invoice" -DocumentName "Invoice Q4 2023"

Uploads an invoice PDF with a custom name to the shipment.

PARAMETERS

-DocumentName

Optional name for the document. If not provided, the filename will be used.

Type: String
Parameter Sets: (All)
Aliases:

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

-DocumentType

The type of document being uploaded (e.g., "label", "invoice", "customs", "other").

Type: String
Parameter Sets: (All)
Aliases:

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

-FilePath

The path to the PDF file to upload.

Type: String
Parameter Sets: (All)
Aliases:

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

-ShipmentId

The ID of the shipment to add the document to.

Type: String
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts for confirmation before uploading the document.

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

NOTES

Requires a valid connection established via Connect-SendDrop. Only PDF files are supported.

RELATED LINKS