< Back

Get-TechDataCustomer

Sun Jan 12, 2020 3:18 pm

NAME Get-TechDataCustomer



SYNOPSIS

This function retrieves all TechData customers which match the provided criteria.





SYNTAX

Get-TechDataCustomer [[-apiHeaders] <Object>] [[-customerID] <String>] [[-companyName] <String>] [[-firstName]

<String>] [[-lastName] <String>] [[-title] <String>] [[-email] <String>] [[-phone1] <String>] [[-phone2] <String>]

[[-addressLine1] <String>] [[-addressLine2] <String>] [[-city] <String>] [[-state] <String>] [[-zip] <String>]

[[-country] <String>] [[-environment] <String>] [<CommonParameters>]





DESCRIPTION

This function retrieves all TechData customers which match the provided criteria.

The customers returned from this function do not contain all their details.

For retrieving customers with their full details, use the Get-TechDataCustomerDetails function.





PARAMETERS

-apiHeaders <Object>

The TechData API headers generated by Get-TechDataRestApiHeaders.



Required? false

Position? 1

Default value $Global:TechDataApiHeaders

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-customerID <String>

The ID of the customer.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-companyName <String>

The name of the company of the customer.



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-firstName <String>

The first name of the customer.



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-lastName <String>

The last name of the customer.



Required? false

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-title <String>

The title of the customer (eg. Mr, Mrs).



Required? false

Position? 6

Default value

Accept pipeline input? false

Accept wildcard characters? false



-email <String>

The email address of the customer.



Required? false

Position? 7

Default value

Accept pipeline input? false

Accept wildcard characters? false



-phone1 <String>

The primary phone number of the customer.



Required? false

Position? 8

Default value

Accept pipeline input? false

Accept wildcard characters? false



-phone2 <String>

The secondary phone number of the customer.



Required? false

Position? 9

Default value

Accept pipeline input? false

Accept wildcard characters? false



-addressLine1 <String>

The first line of the postal address of the customer.



Required? false

Position? 10

Default value

Accept pipeline input? false

Accept wildcard characters? false



-addressLine2 <String>

The second line of the postal address of the customer.



Required? false

Position? 11

Default value

Accept pipeline input? false

Accept wildcard characters? false



-city <String>

The name of the city of the customer.



Required? false

Position? 12

Default value

Accept pipeline input? false

Accept wildcard characters? false



-state <String>

The name of the state of the customer.



Required? false

Position? 13

Default value

Accept pipeline input? false

Accept wildcard characters? false



-zip <String>

The zip or postal code of the customer.



Required? false

Position? 14

Default value

Accept pipeline input? false

Accept wildcard characters? false



-country <String>

The name of the country of the customer.



Required? false

Position? 15

Default value

Accept pipeline input? false

Accept wildcard characters? false



-environment <String>

The environment to which the call will be made, either production or test.



Required? false

Position? 16

Default value test

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS





RELATED LINKS