Partilhar via

Manage customer accounts - Get customers

  • Referência
Serviço:
Partner Center Rest
Versão da API:
v1

Recupera um segmento de clientes de um parceiro. A filtragem opcional de clientes também pode ser aplicada. Os clientes só podem ser filtrados por uma cadeia de caracteres com a qual o nome da empresa ou nome de domínio começa. A pesquisa completa não é suportada atualmente. Os clientes podem ser filtrados usando uma operação de filtro {Microsoft.Partner.Core.Query.Filters.FieldFilterOperation.StartsWith} e especificando: DisplayName (nome da empresa) ou DefaultDomainName como o campo de filtro.

GET https://api.partnercenter.microsoft.com/v{version}/customers
Com parâmetros opcionais: 
GET https://api.partnercenter.microsoft.com/v{version}/customers?seekOperation={seekOperation}&size={size}&filter.operator={filter.operator}

Parâmetros do URI

Name Em Necessário Tipo Description
version
 path True

string

filter.operator
 query

integer

int32
seekOperation
 query

integer

int32

A operação de busca.
size
 query

integer

int32

O número máximo de clientes a devolver.

Cabeçalho do Pedido

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Name Necessário Tipo Description
Authorization True

string

Token de portador de autorização
ms-correlationid

string

Usado para rastrear solicitações internamente. Se um ms-correlationid não for fornecido, o servidor gerará um novo para cada solicitação
ms-cv

string

Usado para rastrear solicitações internamente. Se um ms-cv não for fornecido, o servidor gerará um novo para cada solicitação
ms-requestid

string

Usado para idempotência de solicitações. Se um ms-requestid não for fornecido, o servidor gerará um novo para cada solicitação

Respostas

Name Tipo Description
200 OK

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]

O pedido foi bem-sucedido. O corpo da resposta contém uma lista de clientes que correspondem ao filtro. Um token de continuação será incluído se a resposta for paginada pelo tamanho da página. Este token pode ser passado para /customers?seek= para buscar resultados de clientes.

Media Types: "application/json", "text/json"

Definições

Name Description
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Service.Customers.Contracts.V1.Address
Microsoft.Partner.Service.Customers.Contracts.V1.Customer
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile
Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials
System.Collections.Generic.KeyValuePair[System.String,System.String]
System.Security.SecureString
Name Tipo Description
body

string

headers

System.Collections.Generic.KeyValuePair[System.String,System.String][]

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

Name Tipo Description
etag

string

objectType

string

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]

Name Tipo Description
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

items

Microsoft.Partner.Service.Customers.Contracts.V1.Customer[]

links

Microsoft.Partner.Core.Collections.ResourceLinks

totalCount

integer

Name Tipo Description
next

Microsoft.Partner.Core.Collections.Link

previous

Microsoft.Partner.Core.Collections.Link

self

Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Service.Customers.Contracts.V1.Address

Name Tipo Description
addressLine1

string

addressLine2

string

addressLine3

string

city

string

country

string

district

string

emailAddress

string

firstName

string

id

string

lastName

string

middleName

string

phoneNumber

string

postalCode

string

region

string

state

string

Microsoft.Partner.Service.Customers.Contracts.V1.Customer

Name Tipo Description
allowDelegatedAccess

boolean

associatedPartnerId

string

attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

billingProfile

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile

commerceId

string

companyProfile

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile

customDomains

string[]

id

string

links

Microsoft.Partner.Core.Collections.ResourceLinks

relationshipToPartner enum:
  • advisor
  • microsoft_support
  • none
  • reseller
  • syndication
  • unknown
userCredentials

Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile

Name Tipo Description
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

companyName

string

culture

string

defaultAddress

Microsoft.Partner.Service.Customers.Contracts.V1.Address

email

string

firstName

string

id

string

language

string

lastName

string

links

Microsoft.Partner.Core.Collections.ResourceLinks

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile

Name Tipo Description
address

Microsoft.Partner.Service.Customers.Contracts.V1.Address

attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

companyName

string

domain

string

email

string

links

Microsoft.Partner.Core.Collections.ResourceLinks

organizationRegistrationNumber

string

tenantId

string

Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials

Name Tipo Description
password

System.Security.SecureString

userName

string

System.Collections.Generic.KeyValuePair[System.String,System.String]

Name Tipo Description
key

string

value

string

System.Security.SecureString

Name Tipo Description
length

integer