Obter uma folha de preços

  • Artigo

Este artigo explica como obter uma folha de preços para um determinado mercado e visualização. Este método suporta filtros para obter histórico por mês.

Pré-requisitos

  • Credenciais conforme descrito na autenticação da API do parceiro. Este cenário suporta apenas a autenticação do usuário do aplicativo. Somente aplicativo ainda não é suportado. Os parceiros que apresentam erro http:400 devem consultar a documentação de autenticação da API do parceiro.
  • Atualmente, essa API suporta apenas o acesso de usuários em que os parceiros devem estar em uma das seguintes funções: Administrador Global, Agente de Administração ou Agente de Vendas.

Detalhes

  • Atual retorna dados apenas para consumo e reservas do plano do Azure, Licenciado com base (nova experiência comercial) e produtos do Marketplace.
  • O preço atual inclui todos os medidores e produtos disponíveis durante o mês atual até a data em que a API é chamada. Os meses anteriores incluem todos os contadores e produtos disponíveis para o mês em questão.
  • Os preços dos medidores de consumo são apenas em USD, os parceiros devem usar a API de taxas de câmbio para calcular os custos em moeda local.
  • Os preços dos contadores de consumo são preços de retalho estimados. Os descontos para parceiros estão disponíveis através do crédito ganho pelo parceiro.
  • Os preços dos medidores de reservas incluem os descontos de parceiros CSP. Os preços de varejo estimados para reservas podem ser encontrados nos serviços compartilhados de reservas que podem ser baixados na página "Preços e ofertas" do Partner Center.
  • Mais informações sobre os preços do plano do Azure podem ser encontradas na documentação de preços do plano do Azure.
  • As APIs de preços de parceiros e taxas de câmbio não fazem parte do SDK do Partner Center.
  • Esse método retorna a lista de preços como um fluxo de arquivo. O fluxo de arquivos é um arquivo .csv ou uma versão compactada zip do .csv. Detalhes sobre como solicitar arquivos compactados estão incluídos abaixo.

Pedido REST

Sintaxe da solicitação

Método URI do pedido
GET https://api.partner.microsoft.com/v1.0/sales/pricesheets(Market='{market}',PricesheetView='{view}')/$value

Parâmetros necessários de URI

Use os seguintes parâmetros de caminho para solicitar o mercado e o tipo de planilha de preços desejado.

Nome Type Obrigatório Description
Comercializar string Sim Código de país/região de duas letras para o mercado solicitado
Folha de PreçosVer string Sim O tipo de planilha de preços que está sendo solicitada, que pode ser azure_consumption, azure_reservations, atualizada, baseada em licença, mercado ou software.

Nota

Atualmente, o PriceSheetView atualizado baseado em licenças está disponível apenas para parceiros que fazem parte da visualização técnica da nova experiência de comércio do Microsoft 365/Microsoft Dynamics 365.

Nota

A lista de preços do software estará disponível via API a partir de 1º de abril de 2022.

Parâmetros do filtro URI

Use os seguintes parâmetros de filtro.

Nome Type Obrigatório Description
Linha Cronológica string Não O padrão é atual se não for aprovado. Os valores possíveis são histórico, atual e futuro.
Month string Não Apenas necessário se o histórico for solicitado, deve aderir a AAAAMM para a folha de preços que está sendo solicitada.

Nota

Os preços futuros não são suportados pelo Marketplace. A partir de 1º de abril de 2022, os parceiros poderão visualizar o histórico da lista de preços do software via API, a partir do histórico de março de 2022.

Cabeçalhos do pedido

  • Para obter mais informações, consulte Cabeçalhos REST de parceiros.

Além dos cabeçalhos acima, os arquivos de preços podem ser recuperados como compactados, reduzindo a largura de banda e os tempos de download. Por padrão, os arquivos não são compactados. Para obter versões compactadas dos arquivos, você pode incluir o valor de cabeçalho abaixo. Perceba que as folhas compactadas só estão disponíveis a partir de abril de 2020, todas as folhas anteriores a abril de 2020 só estão disponíveis como não compactadas.

Cabeçalho Tipo de valor valor Description
Accept-Encoding string deflacionar Opcional. Se o fluxo de arquivos omitido não for compactado.

Exemplo de solicitação

GET https://api.partner.microsoft.com/v1.0/sales/pricesheets(Market='ad',PricesheetView='azure_consumption')/$value?timeline=history&month=201909 HTTP/1.1
Authorization: Bearer
Host: api.partner.microsoft.com

Exemplo de pedido para novo comércio

Nota

Atualmente, o PriceSheetView atualizado baseado em licenças está disponível apenas para parceiros que fazem parte da visualização técnica da nova experiência de comércio do Microsoft 365/Microsoft Dynamics 365.

GET https://api.partner.microsoft.com/v1.0/sales/pricesheets(Market='US',PricesheetView='updatedlicensebased')/$value?timeline=history&month=202101 HTTP/1.1
Authorization: Bearer
Accept-Encoding: deflate
Host: api.partner.microsoft.com

Resposta do REST

Se for bem-sucedido, esse método retorna a lista de preços como um fluxo de arquivos. O fluxo de arquivos é um arquivo .csv ou uma versão compactada zip do .csv.

Exemplo de resposta para novo comércio

Nota

Atualmente, o PriceSheetView atualizado baseado em licenças está disponível apenas para parceiros que fazem parte da visualização técnica da nova experiência de comércio do Microsoft 365/Microsoft Dynamics 365.

HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 42180180
Content-Type: application/octet-stream
Content-Disposition: attachment; filename=sheets.csv
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731
Date: Wed, 02 Feb 2021 03:41:20 GMT

"ProductTitle","ProductId","SkuId","SkuTitle","Publisher","SkuDescription","UnitOfMeasure","TermDuration","BillingPlan","Market","Currency","UnitPrice","PricingTierRangeMin","PricingTierRangeMax","EffectiveStartDate","EffectiveEndDate","Tags","ERP Price"
"Advanced Communications","CFQ7TTC0HDK0","0001","Advanced Communications","Microsoft Corporation","Advanced meetings, calling, workflow integration, and management tools for IT.","","P1Y","Annual","US","USD","115.2","","","2/1/2019 12:00:00 AM","2/4/2021 8:35:31 PM","License","144"
======= Truncated ==============

Códigos de sucesso e erro de resposta

Cada resposta vem com um código de status HTTP que indica sucesso ou falha e outras informações de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e outros parâmetros. Para obter a lista completa, consulte Códigos de erro.

Se não houver alterações esperadas para a nova lista de preços futura baseada em licenças de comércio, não haverá nenhuma lista de preços futura retornada. Ao passar o futuro para a Linha do tempo solicitada para o PriceSheetView atualizado, os parceiros verão o seguinte código de resposta da API: 404 Não encontrado.

Próximos passos