Verificar o inventário de itens de catálogo usando APIs do Partner Center

Como verificar o estoque de um conjunto específico de itens de catálogo.

Importante

Essa API será desativada em 25 de setembro de 2026. Os parceiros devem migrar para a nova API Verificar inventário por tipo de recurso, que fornece filtragem aprimorada por tipo de recurso.

Pré-requisitos

  • Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário dá suporte à autenticação com credenciais autônomas de Aplicativo e Aplicativo+Usuário.

  • Uma ou mais IDs de produto. Opcionalmente, as IDs de SKU também podem ser especificadas.

  • Qualquer contexto adicional necessário para verificar o inventário dos SKUs referenciados pelas IDs de produto/SKU fornecidas. Esses requisitos podem variar de acordo com o tipo de produto/SKU e podem ser determinados a partir da propriedade InventoryVariablesdo SKU.

Solicitação REST

Sintaxe da solicitação

Método URI de solicitação
Publicar {baseURL}/v1/extensions/product/checkInventory?country={country-code} HTTP/1.1

Parâmetro URI

Use o parâmetro de consulta a seguir para verificar o inventário.

Nome Tipo Obrigatório Descrição
código do país cadeia Sim Um ID de país/região.

Cabeçalhos da solicitação

Para mais informações, consulte os cabeçalhos REST do Partner Center.

Corpo da solicitação

Os detalhes da solicitação de inventário, que consistem em um recurso InventoryCheckRequest contendo um ou mais recursos InventoryItem .

Verifique se a Assinatura do Azure especificada no corpo da solicitação está registrada e habilitada para comprar RIs do Azure. Consulte Registrar uma assinatura para obter detalhes sobre o processo de registro.

Exemplo de solicitação

POST https://api.partnercenter.microsoft.com/v1/extensions/product/checkinventory?country=US HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: d1b1981a-e088-4610-870a-eebec96d6bcd
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Content-Type: application/json

{"TargetItems":[{"ProductId":"DZH318Z0BQ3P"}],"InventoryContext":{"customerId":"d6bf25b7-e0a8-4f2d-a31b-97b55cfc774d","azureSubscriptionId":"3A231FBE-37FE-4410-93FD-730D3D5D4C75","armRegionName":"Europe"}}

Resposta REST

Se for bem-sucedido, o corpo da resposta conterá uma coleção de objetos InventoryItem preenchidos com os detalhes de restrição, se houver.

Observação

Se um InventoryItem de entrada representar um item que não pôde ser encontrado no catálogo, ele não será incluído na coleção de saída.

Códigos de erro e êxito de resposta

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

Exemplo de resposta

HTTP/1.1 200 OK
Content-Length: 1021
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: d1b1981a-e088-4610-870a-eebec96d6bcd
X-Locale: en-US
[
    {
        "productId": "DZH318Z0BQ3P",
        "skuId": "0039",
        "isRestricted": true,
        "restrictions": [
            {
                "reasonCode": "NotAvailableForSubscription",
                "description": "Restriction identified of type 'Location' with values 'japanwest'.",
                "properties": {
                    "type": "Location",
                    "values": "japanwest"
                }
            }
        ]
    },
    {
        "productId": "DZH318Z0BQ3P",
        "skuId": "0038",
        "isRestricted": true,
        "restrictions": [
            {
                "reasonCode": "NotAvailableForSubscription",
                "description": "Restriction identified of type 'Location' with values 'japanwest'.",
                "properties": {
                    "type": "Location",
                    "values": "japanwest"
                }
            }
        ]
    },
    {
        "productId": "DZH318Z0BQ3P",
        "skuId": "000S",
        "isRestricted": false,
        "restrictions": []
    },
    {
        "productId": "DZH318Z0BQ3P",
        "skuId": "0011",
        "isRestricted": false,
        "restrictions": []
    }
]