API aberta do inventário de produtos

A API Aberta de inventário de produtos fornece endpoints para criar e recuperar inventários de produtos.

Use esta API para gerenciar informações de inventário de produtos entre sistemas externos e o Now Platform.

Esta API está incluída na aplicação Product Inventory Advanced, que está disponível no ServiceNow Store.

Esta API é fornecida no namespace sn_prd_invt .

O usuário de chamada deve ter a função sn_prd_invt.product_inventory_integrator.

Esta API cria e atualiza dados nas tabelas a seguir.

• Características do produto [sn_prd_invt_product_characteristics]
• Inventário de produtos [sn_prd_invt_product_inventory]
• Modelo do produto [cmdb_model]
• Característica do modelo do produto [sn_prd_pm_product_model_characteristic]

A API Aberta de inventário de produtos é uma ServiceNow® implementação da especificação REST da API de gestão de inventário de produtos do TM Fórum. Esta implementação se baseia na especificação REST da API Gestão de inventário de produtos TMF637 Versão 19, agosto de 2019. A API Aberta do inventário de produtos tem conformidade certificada pelo TM Fórum.

API aberta de inventário de produtos - GET /sn_prd_invt/product

Recupera uma lista de todos os inventários de produtos.

Formato da URL

URL padrão: api/sn_prd_invt/product

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 2. Parâmetros de consulta

Nome	Descrição
cliente	Filtrar inventários de produtos por cliente. Somente ofertas de produto com um sys_id de cliente ou ID externo correspondente ao valor deste parâmetro são retornadas na resposta. Tipo de dados: cadeia de caracteres
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Se este parâmetro não for usado, todos os campos serão retornados. Tipo de dados: cadeia de caracteres
limite	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro offset para paginar a recuperação do registro. Padrão: 20 Máximo: 100 Tipo de dados: número
deslocamento	Índice inicial no qual os registros serão recuperados. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Padrão: 0 Tipo de dados: número
local	Filtrar inventários de produtos por local. Somente ofertas de produto com um sys_id de local ou ID externo correspondente ao valor deste parâmetro são retornadas na resposta. Tipo de dados: cadeia de caracteres
status	Filtrar inventários de produtospor status. Somente inventários de produtos com um status correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: cadeia de caracteres

Tabela 3. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 4. Cabeçalhos da solicitação

Cabeçalho	Descrição
Nenhum(a)

Tabela 5. Cabeçalhos de resposta

Cabeçalho	Descrição
Intervalo de conteúdo	Especifica o intervalo de conteúdo retornado em uma chamada paginada. Por exemplo, se deslocamento=2 e limite=3, o valor do cabeçalho Content-Range será itens 3-5.
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Link	Contém os links a seguir para navegar pelos resultados da consulta. primeiro último avançar anterior
X-Total-Contagem	Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 6. Códigos de status

Código de status	Descrição
200	Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação).
206	Recurso parcial retornado em resposta (com paginação).
400	Solicitação incorreta. Possíveis motivos: Parâmetro de caminho inválido URI inválido
404	Registro não encontrado. Nenhum registro correspondente aos parâmetros de consulta foi encontrado na tabela.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
href	Link relativo ao registro de inventário do produto. Tipo de dados: cadeia de caracteres
ID	Sys_id do inventário de produtos da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
nome	Nome do inventário do produto. Tipo de dados: cadeia de caracteres
local	Local associado ao produto. Tipo de dados: cadeia de caracteres
productCaracterística	Lista de características do produto. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nome da característica. Tipo de dados: cadeia de caracteres
productCaracterística.valor	Valor da característica. Tipo de dados: cadeia de caracteres
productOffering	Oferta de produto à qual o inventário de produtos está associado. Tipo de dados: objeto "productOffering": { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }
productOffering.id	Initial_version ou external_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.internalId	Initial_version da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.internalVersion	Versão da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOferta.versão	External_version da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productPrice	Retorna uma matriz vazia. Tipo de dados: matriz
productRelationship	Lista de produtos relacionados. Tipo de dados: matriz "productRelationship": [ { "productId": "String", "relationshipType": "String" } ]
productRelationship.productId	Sys_id do produto relacionado da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
productRelationship.relationshipType	Tipo de relacionamento. Tipo de dados: cadeia de caracteres
productSpecification	Especificação do produto para o produto. Tipo de dados: objeto "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	Initial_version ou external_id da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
productSpecification.internalId	Initial_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
productSpecification.internalVersion	Versão da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
productSpecification.version	External_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
realizandoRecurso	Recurso que realiza o produto. O recurso de realização é um inventário de produto secundário deste inventário de produto. Tipo de dados: objeto "realizingResource": { "id": "String", "type": "String" }
realizingResource.id	Sys_id do recurso de realização. Localizado na tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoRecurso.tipo	Tipo de recurso de realização. Valor válido: secundário Tipo de dados: cadeia de caracteres
realizandoServiço	Serviço que realiza o produto. O serviço de realização é um inventário de produto secundário deste inventário de produto. Tipo de dados: objeto "realizingService": { "id": "String", "type": "String" }
realizingService.id	Sys_id do serviço de execução. Localizado na tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoServiço.tipo	Tipo de serviço de execução. Valor válido: secundário Tipo de dados: cadeia de caracteres
relatedParty	Lista de partes associadas ao tíquete. Tipo de dados: matriz "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id da conta ou contato do cliente associado ao tíquete. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de cliente. Valores possíveis: Cliente CustomerContact Consumidor Tipo de dados: cadeia de caracteres
estado	Estado atual do produto. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo recupera todos os inventários de produtos.

curl --location --request GET "https://instance.service-now.com/api/sn_prd_invt/product" \
--user 'username':'password'

Corpo da resposta.

[
   {
      "id": "037fd87ec3603010abc8b5183c40ddf2",
      "relatedParty": [
         {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Example Company",
            "@type": "RelatedParty",
            "@referredType": "Customer"
         },
         {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
         }
      ],
      "name": "Routing and Configuration PI0000318",
      "productSpecification": {
         "id": "aec57e981bb420106ba59acf034bcb08",
         "name": "Routing and Configuration",
         "version": "",
         "internalVersion": "1",
         "internalId": "aec57e981bb420106ba59acf034bcb08"
      },
      "status": "Active",
      "productOffering": {
         "id": "69017a0f536520103b6bddeeff7b127d",
         "name": "Premium SD-WAN Offering",
         "version": "",
         "internalVersion": "1",
         "internalId": "69017a0f536520103b6bddeeff7b127d"
      },
      "product": "ce0b52c7532520103b6bddeeff7b12f5",
      "place": {
         "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
         "name": "100 South Charles Street, Baltimore,MD"
      },
      "productCharacteristic": [],
      "productRelationship": [],
      "realizingService": [],
      "realizingResource": [
         {
            "id": "9b2fa60b536520103b6bddeeff7b1233",
            "name": "Route Target"
         }
      ],
      "productPrice": [],
      "href": "/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2",
      "billingAccount": "Not Specified."
   }
]

API aberta do inventário de produtos - GET /sn_prd_invt/product/{id}

Recupera um registro de inventário de produto especificado.

Formato da URL

URL padrão: /api/sn_prd_invt/product/{id}

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho

Nome	Descrição
ID	Sys_id do inventário de produtos a ser recuperado. Localizado na tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres

Tabela 8. Parâmetros de consulta

Nome	Descrição
cliente	Filtrar inventários de produtos por cliente. Somente ofertas de produto com um sys_id de cliente ou ID externo correspondente ao valor deste parâmetro são retornadas na resposta. Tipo de dados: cadeia de caracteres
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Se este parâmetro não for usado, todos os campos serão retornados. Tipo de dados: cadeia de caracteres
local	Filtrar inventários de produtos por local. Somente ofertas de produto com um sys_id de local ou ID externo correspondente ao valor deste parâmetro são retornadas na resposta. Tipo de dados: cadeia de caracteres
status	Filtrar inventários de produtos por status. Somente inventários de produtos com um status correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: cadeia de caracteres

Tabela 9. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 10. Cabeçalhos da solicitação

Cabeçalho	Descrição
Nenhum(a)

Tabela 11. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 12. Códigos de status

Código de status	Descrição
200	Solicitação processada com sucesso.
400	Solicitação Incorreta. Pode ser qualquer um dos seguintes motivos: Parâmetro de caminho inválido URI inválido
404	Registro não encontrado. O registro associado ao ID não foi encontrado na tabela.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
href	Link relativo ao registro de inventário do produto. Tipo de dados: cadeia de caracteres
ID	Sys_id do inventário de produtos da tabela Product Inventory [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
nome	Nome do inventário do produto. Tipo de dados: cadeia de caracteres
local	Local associado ao produto. Tipo de dados: cadeia de caracteres
productCaracterística	Lista de características do produto. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nome da característica. Tipo de dados: cadeia de caracteres
productCaracterística.valor	Valor da característica. Tipo de dados: cadeia de caracteres
productOffering	Oferta de produto à qual o inventário de produtos está associado. Tipo de dados: objeto "productOffering": { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }
productOffering.id	Initial_version ou external_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.internalId	Initial_version da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.internalVersion	Versão da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOferta.versão	External_version da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productPrice	Retorna uma matriz vazia. Tipo de dados: matriz
productRelationship	Lista de produtos relacionados. Tipo de dados: matriz "productRelationship": [ { "productId": "String", "relationshipType": "String" } ]
productRelationship.productId	Sys_id do produto relacionado da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
productRelationship.relationshipType	Tipo de relacionamento. Tipo de dados: cadeia de caracteres
productSpecification	Especificação do produto para o produto. Tipo de dados: objeto "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	Initial_version ou external_id da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
productSpecification.internalId	Initial_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
productSpecification.internalVersion	Versão da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
productSpecification.version	External_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
realizandoRecurso	Recurso que realiza o produto. O recurso de realização é um inventário de produto secundário deste inventário de produto. Tipo de dados: objeto "realizingResource": { "id": "String", "type": "String" }
realizingResource.id	Sys_id do recurso de realização. Localizado na tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoRecurso.tipo	Tipo de recurso de realização. Valor válido: secundário Tipo de dados: cadeia de caracteres
realizandoServiço	Serviço que realiza o produto. O serviço de realização é um inventário de produto secundário deste inventário de produto. Tipo de dados: objeto "realizingService": { "id": "String", "type": "String" }
realizingService.id	Sys_id do serviço de execução. Localizado na tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoServiço.tipo	Tipo de serviço de execução. Valor válido: secundário Tipo de dados: cadeia de caracteres
relatedParty	Lista de partes associadas ao tíquete. Tipo de dados: matriz "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id da conta ou contato do cliente associado ao tíquete. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de cliente. Tipo de dados: cadeia de caracteres
estado	Estado atual do produto. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo recupera um inventário de produto especificado.

curl -X GET 'https://instance.service-now.com/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2' \
--user 'username':'password'

Saída:

{
   "id": "037fd87ec3603010abc8b5183c40ddf2",
   "relatedParty": [
      {
         "id": "ffc68911c35420105252716b7d40dd55",
         "name": "Example Company",
         "@type": "RelatedParty",
         "@referredType": "Customer"
      },
      {
         "id": "eaf68911c35420105252716b7d40ddde",
         "name": "Sally Thomas",
         "@type": "RelatedParty",
         "@referredType": "CustomerContact"
      }
   ],
   "name": "Routing and Configuration PI0000318",
   "productSpecification": {
      "id": "aec57e981bb420106ba59acf034bcb08",
      "name": "Routing and Configuration",
      "version": "",
      "internalVersion": "1",
      "internalId": "aec57e981bb420106ba59acf034bcb08"
   },
   "status": "Active",
   "productOffering": {
      "id": "69017a0f536520103b6bddeeff7b127d",
      "name": "Premium SD-WAN Offering",
      "version": "",
      "internalVersion": "1",
      "internalId": "69017a0f536520103b6bddeeff7b127d"
   },
   "product": "ce0b52c7532520103b6bddeeff7b12f5",
   "place": {
      "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
      "name": "100 South Charles Street, Baltimore,MD"
   },
   "productCharacteristic": [],
   "productRelationship": [],
   "realizingService": [],
   "realizingResource": [
      {
         "id": "9b2fa60b536520103b6bddeeff7b1233",
         "name": "Route Target"
      }
   ],
   "productPrice": [],
   "href": "/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2",
   "billingAccount": "Not Specified."
}

API aberta de inventário de produtos - GET /sn_prd_invt/productinventory

Recupera uma lista de todos os inventários de produtos.

Importante:

A partir da versão Tokyo, este endpoint está obsoleto. A nova versão deste endpoint é API aberta de inventário de produtos - GET /sn_prd_invt/product.

Formato da URL

URL padrão: api/sn_prd_invt/productinventory

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 14. Parâmetros de consulta

Nome	Descrição
cliente	Filtrar inventários de produtos por cliente. Somente ofertas de produto com um sys_id de cliente ou ID externo correspondente ao valor deste parâmetro são retornadas na resposta. Tipo de dados: cadeia de caracteres
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Se este parâmetro não for usado, todos os campos serão retornados. Tipo de dados: cadeia de caracteres
limite	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro offset para paginar a recuperação do registro. Padrão: 20 Máximo: 100 Tipo de dados: número
deslocamento	Índice inicial no qual os registros serão recuperados. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Padrão: 0 Tipo de dados: número
local	Filtrar inventários de produtos por local. Somente ofertas de produto com um sys_id de local ou ID externo correspondente ao valor deste parâmetro são retornadas na resposta. Tipo de dados: cadeia de caracteres
status	Filtrar inventários de produtos por status. Somente inventários de produtos com um status correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: cadeia de caracteres

Tabela 15. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 16. Cabeçalhos da solicitação

Cabeçalho	Descrição
Nenhum(a)

Tabela 17. Cabeçalhos de resposta

Cabeçalho	Descrição
Intervalo de conteúdo	Especifica o intervalo de conteúdo retornado em uma chamada paginada. Por exemplo, se deslocamento=2 e limite=3, o valor do cabeçalho Content-Range será itens 3-5.
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Link	Contém os links a seguir para navegar pelos resultados da consulta. primeiro último avançar anterior
X-Total-Contagem	Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 18. Códigos de status

Código de status	Descrição
200	Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação).
206	Recurso parcial retornado em resposta (com paginação).
400	Solicitação incorreta. Possíveis motivos: Parâmetro de caminho inválido URI inválido
404	Registro não encontrado. Nenhum registro correspondente aos parâmetros de consulta foi encontrado na tabela.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
ID	Sys_id do inventário de produtos da tabela Product Inventory [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
nome	Nome do inventário do produto. Tipo de dados: cadeia de caracteres
local	Local associado ao produto. Tipo de dados: cadeia de caracteres
productCaracterística	Lista de características do produto. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nome da característica. Tipo de dados: cadeia de caracteres
productCaracterística.valor	Valor da característica. Tipo de dados: cadeia de caracteres
productOffering	Oferta de produto à qual o inventário de produtos está associado. Tipo de dados: objeto "productOffering": { "id": "String", "name": "String" }
productOffering.id	Sys_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productRelationship	Lista de produtos relacionados. Tipo de dados: matriz "productRelationship": [ { "productId": "String", "relationshipType": "String" } ]
productRelationship.productId	Sys_id do produto relacionado da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
productRelationship.relationshipType	Tipo de relacionamento. Tipo de dados: cadeia de caracteres
productSpecification	Especificação do produto para o produto. Tipo de dados: objeto "productSpecification": { "id": "String" }
productSpecification.id	Sys_id da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
realizandoRecurso	Realização de recurso. Tipo de dados: objeto "realizingResource": { "id": "String", "type": "String" }
realizingResource.id	Sys_id do recurso de realização da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoRecurso.tipo	Tipo de recurso de realização. Tipo de dados: cadeia de caracteres
realizandoServiço	Realização de serviço. Tipo de dados: objeto "realizingService": { "id": "String", "type": "String" }
realizingService.id	Sys_id do serviço de realização da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoServiço.tipo	Tipo de serviço de realização. Tipo de dados: cadeia de caracteres
relatedParty	Lista de partes associadas ao tíquete. Tipo de dados: matriz "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id da conta ou contato do cliente associado ao tíquete. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de cliente. Valores possíveis: cliente clienteContato cliente Tipo de dados: cadeia de caracteres
estado	Estado atual do produto. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo recupera todos os inventários de produtos.

curl "https://instance.servicenow.com/api/sn_prd_invt/productinventory" \
--request GET \
--user 'username':'password'

Corpo da resposta.

[
   {
      "id": "075072aec3a83010abc8b5183c40dd44",
      "relatedParty": [
         {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
         },
         {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
         }
      ],
      "name": "Firewall Administration PI0000300",
      "productSpecification": {
         "id": "31c5caff07266010a7955b7e0ad3006b",
         "name": "Firewall Administration"
      },
      "status": "Active",
      "productOffering": {
         "id": "",
         "name": ""
      },
      "place": {
         "id": "920cf6ac73d423002728660c4cf6a799",
         "name": "200 South James street,Atlanta, GA"
      },
      "productCharacteristic": [
         {
            "name": "Firewall Administration CPE Type",
            "valueType": "Choice",
            "value": "Physical"
         },
         {
            "name": "Configuration and Policy backup",
            "valueType": "Choice",
            "value": ""
         },
         {
            "name": "Firewall Administration CPE ID",
            "valueType": "Single Line Text",
            "value": "CPE123456789"
         },
         {
            "name": "Remote CLI troubleshoot support",
            "valueType": "Choice",
            "value": ""
         },
         {
            "name": "Firewall Administration CPE Model",
            "valueType": "Choice",
            "value": "9300 series"
         }
      ],
      "productRelationship": [],
      "realizingService": [],
      "realizingResource": [
         {
            "id": "3546463307666010a7955b7e0ad3005d",
            "name": "Cisco Firewall Management system"
         }
      ]
   },
   {
      "id": "0303a8ea74418510f877ca57242ff96d",
      "relatedParty": [
         {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
         },
         {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
         }
      ],
      "name": "SD-WAN Edge Device PI0001114",
      "productSpecification": {
         "id": "39b627aa53702010cd6dddeeff7b1202",
         "name": "SD-WAN Edge Device"
      },
      "status": "Installation Pending",
      "productOffering": {
         "id": "69017a0f536520103b6bddeeff7b127d",
         "name": "Premium SD-WAN Offering"
      },
      "place": "",
      "productCharacteristic": [],
      "productRelationship": [],
      "realizingService": [
         {
            "id": "bf65eadc1b7420106ba59acf034bcb57",
            "name": "SD-WAN Routing"
         },
         {
            "id": "16d79ec3532520103b6bddeeff7b12a6",
            "name": "SD WAN Optimization Service"
         },
         {
            "id": "16d79ec3532520103b6bddeeff7b12a6",
            "name": "SD WAN Optimization Service"
         },
         {
            "id": "bf65eadc1b7420106ba59acf034bcb57",
            "name": "SD-WAN Routing"
         },
         {
            "id": "bf65eadc1b7420106ba59acf034bcb57",
            "name": "SD-WAN Routing"
         },
         {
            "id": "bf65eadc1b7420106ba59acf034bcb57",
            "name": "SD-WAN Routing"
         }
      ],
      "realizingResource": [
         {
            "id": "493fa60b536520103b6bddeeff7b12b6",
            "name": "Customer Premise SD-WAN Router"
         }
      ]
   }
]

API aberta de inventário de produtos - GET /sn_prd_invt/productinventory/{inventoryId}

Recupera um inventário de produtos.

Importante:

A partir da versão Tokyo, este endpoint está obsoleto. A nova versão deste endpoint é API aberta do inventário de produtos - GET /sn_prd_invt/product/{id}.

Formato da URL

URL padrão: /api/sn_prd_invt/productinventory/{inventoryId}

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho

Nome	Descrição
InventárioId	Sys_id do inventário de produtos a ser recuperado. Localizado na tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres

Tabela 20. Parâmetros de consulta

Nome	Descrição
cliente	Filtrar inventários de produtos por cliente. Somente ofertas de produto com um sys_id de cliente ou ID externo correspondente ao valor deste parâmetro são retornadas na resposta. Tipo de dados: cadeia de caracteres
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Se este parâmetro não for usado, todos os campos serão retornados. Tipo de dados: cadeia de caracteres
local	Filtrar inventários de produtos por local. Somente ofertas de produto com um sys_id de local ou ID externo correspondente ao valor deste parâmetro são retornadas na resposta. Tipo de dados: cadeia de caracteres
status	Filtrar inventários de produtos por status. Somente inventários de produtos com um status correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: cadeia de caracteres

Tabela 21. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 22. Cabeçalhos da solicitação

Cabeçalho	Descrição
Nenhum(a)

Tabela 23. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 24. Códigos de status

Código de status	Descrição
200	Solicitação processada com sucesso.
400	Solicitação Incorreta. Pode ser qualquer um dos seguintes motivos: Parâmetro de caminho inválido URI inválido
404	Registro não encontrado. O registro associado ao ID não foi encontrado na tabela.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
ID	Sys_id do inventário de produtos da tabela Product Inventory [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
nome	Nome do inventário do produto. Tipo de dados: cadeia de caracteres
local	Local associado ao produto. Tipo de dados: cadeia de caracteres
productCaracterística	Lista de características do produto. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nome da característica. Tipo de dados: cadeia de caracteres
productCaracterística.valor	Valor da característica. Tipo de dados: cadeia de caracteres
productOffering	Oferta de produto à qual o inventário de produtos está associado. Tipo de dados: objeto "productOffering": { "id": "String", "name": "String" }
productOffering.id	Sys_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productRelationship	Lista de produtos relacionados. Tipo de dados: matriz "productRelationship": [ { "productId": "String", "relationshipType": "String" } ]
productRelationship.productId	Sys_id do produto relacionado da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
productRelationship.relationshipType	Tipo de relacionamento. Tipo de dados: cadeia de caracteres
productSpecification	Especificação do produto para o produto. Tipo de dados: objeto "productSpecification": { "id": "String" }
productSpecification.id	Sys_id da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
realizandoRecurso	Realização de recurso. Tipo de dados: objeto "realizingResource": { "id": "String", "type": "String" }
realizingResource.id	Sys_id do recurso de realização da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoRecurso.tipo	Tipo de recurso de realização. Tipo de dados: cadeia de caracteres
realizandoServiço	Realização de serviço. Tipo de dados: objeto "realizingService": { "id": "String", "type": "String" }
realizingService.id	Sys_id do serviço de realização da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoServiço.tipo	Tipo de serviço de realização. Tipo de dados: cadeia de caracteres
relatedParty	Lista de partes associadas ao tíquete. Tipo de dados: matriz "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id da conta ou contato do cliente associado ao tíquete. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de cliente. Valores possíveis: Cliente CustomerContact Consumidor Tipo de dados: cadeia de caracteres
estado	Estado atual do produto. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo recupera um inventário de produtos para um pacote de serviços de SD-WAN.

curl --location --request GET 'https:// instance.servicenow.com/api/sn_prd_invt/productinventory/074450fc74918d10f877ca57242ff9e3' \
--user 'username':'password'

Saída:

{
   "id": "074450fc74918d10f877ca57242ff9e3",
   "relatedParty": [
      {
         "id": "ffc68911c35420105252716b7d40dd55",
         "name": "Funco Intl",
         "@type": "RelatedParty",
         "@referredType": "Customer"
      },
      {
         "id": "eaf68911c35420105252716b7d40ddde",
         "name": "Sally Thomas",
         "@type": "RelatedParty",
         "@referredType": "CustomerContact"
      }
   ],
   "name": "SD-WAN Service Package PI0001576",
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package"
   },
   "status": "Installation Pending",
   "productOffering": {
      "id": "69017a0f536520103b6bddeeff7b127d",
      "name": "Premium SD-WAN Offering"
   },
   "place": "",
   "productCharacteristic": [],
   "productRelationship": [
      {
         "id": "a74490fc74918d10f877ca57242ff942",
         "name": "SD-WAN Edge Device PI0001582",
         "relationshipType": "Bundles"
      },
      {
         "id": "b85414fc74918d10f877ca57242ff90e",
         "name": "SD-WAN Controller PI0001602",
         "relationshipType": "Bundles"
      },
      {
         "id": "d74490fc74918d10f877ca57242ff907",
         "name": "SD-WAN Security PI0001577",
         "relationshipType": "Bundles"
      }
   ],
   "realizingService": [],
   "realizingResource": []
}

API aberta do inventário de produtos - POST /sn_prd_invt/product

Cria um registro de inventário de produtos.

Formato da URL

URL padrão: /api/sn_prd_invt/product

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 26. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 27. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
nome	Obrigatório. Nome do inventário do produto. Tipo de dados: cadeia de caracteres
PID	Identificador exclusivo do inventário de produtos do sistema externo. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
productCaracterística	Lista de características do produto. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nome da característica. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
productCaracterística.valor	Valor da característica. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
productOffering	Obrigatório. Oferta de produto à qual o inventário de produtos está associado. Tipo de dados: objeto "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }
productOffering.id	Obrigatório. Initial_version ou external_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.internalVersion	Versão da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
productOferta.versão	External_version da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productRelationship	Lista de produtos relacionados. Tipo de dados: matriz "productRelationship": [ { "productId": "String", "relationshipType": "String" } ]
productRelationship.productId	Obrigatório se estiver usando o parâmetro productRelationship. Sys_id do produto relacionado da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
productRelationship.relationshipType	Tipo de relacionamento. O único valor válido é child. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
productSpecification	Obrigatório. Especificação do produto para o produto. Tipo de dados: objeto "productSpecification": { "id": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	Obrigatório. Initial_version ou external_id da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
productSpecification.internalVersion	Versão da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
productSpecification.version	External_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
realizandoRecurso	Recurso que realiza o produto. O recurso de realização é um inventário de produto secundário deste inventário de produto. Tipo de dados: objeto "realizingResource": { "id": "String", "type": "String" }
realizingResource.id	Obrigatório se estiver usando o parâmetro realizingResource. Sys_id do recurso de realização. Localizado na tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoRecurso.tipo	Tipo de recurso de realização. Valor válido: secundário Tipo de dados: cadeia de caracteres
realizandoServiço	Serviço que realiza o produto. O serviço de realização é um inventário de produto secundário deste inventário de produto. Tipo de dados: objeto "realizingService": { "id": "String", "type": "String" }
realizingService.id	Obrigatório se estiver usando o parâmetro realizingService. Sys_id do serviço de execução. Localizado na tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoServiço.tipo	Tipo de serviço de execução. Valor válido: secundário Tipo de dados: cadeia de caracteres
relatedParty	Lista de partes associadas ao tíquete. Tipo de dados: matriz "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	Obrigatório se estiver usando o parâmetro relatedParty. Sys_id da conta ou contato do cliente associado ao tíquete. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de cliente. Valores possíveis: cliente contato_cliente cliente Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
estado	Estado atual do produto. Valores possíveis: ativo mudança_pendente inactivation_pendente inativo instalação_pendente Tipo de dados: cadeia de caracteres Padrão: install_pending

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 28. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

Tabela 29. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 30. Códigos de status

Código de status	Descrição
201	Solicitação processada com sucesso.
400	Solicitação Incorreta. Pode ser qualquer um dos seguintes motivos: Carga vazia. Carga inválida. Campo obrigatório ausente:<field name>

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
href	Link relativo ao registro de inventário do produto. Tipo de dados: cadeia de caracteres
ID	Sys_id do inventário de produtos da tabela Product Inventory [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
nome	Nome do inventário do produto. Tipo de dados: cadeia de caracteres
PID	Identificador exclusivo do inventário de produtos do sistema externo. Tipo de dados: cadeia de caracteres
productCaracterística	Lista de características do produto. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCaracterística.nome	Nome da característica. Tipo de dados: cadeia de caracteres
productCaracterística.valor	Valor da característica. Tipo de dados: cadeia de caracteres
productOffering	Oferta de produto à qual o inventário de produtos está associado. Tipo de dados: objeto "productOffering": { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }
productOffering.id	Initial_version ou external_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.internalId	Initial_version da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.internalVersion	Versão da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOferta.versão	External_version da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productPrice	Retorna uma matriz vazia. Tipo de dados: matriz
productRelationship	Lista de produtos relacionados. Tipo de dados: matriz "productRelationship": [ { "productId": "String", "relationshipType": "String" } ]
productRelationship.productId	Sys_id do produto relacionado da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
productRelationship.relationshipType	Tipo de relacionamento. Tipo de dados: cadeia de caracteres
productSpecification	Especificação do produto para o produto. Tipo de dados: objeto "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	Initial_version ou external_id da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
productSpecification.internalId	Initial_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
productSpecification.internalVersion	Versão da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
productSpecification.version	External_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
realizandoRecurso	Recurso que realiza o produto. O recurso de realização é um inventário de produto secundário deste inventário de produto. Tipo de dados: objeto "realizingResource": { "id": "String", "type": "String" }
realizingResource.id	Sys_id do recurso de realização. Localizado na tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoRecurso.tipo	Tipo de recurso de realização. Valor válido: secundário Tipo de dados: cadeia de caracteres
realizandoServiço	Serviço que realiza o produto. O serviço de realização é um inventário de produto secundário deste inventário de produto. Tipo de dados: objeto "realizingService": { "id": "String", "type": "String" }
realizingService.id	Sys_id do serviço de execução. Localizado na tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoServiço.tipo	Tipo de serviço de execução. Valor válido: secundário Tipo de dados: cadeia de caracteres
relatedParty	Lista de partes associadas ao tíquete. Tipo de dados: matriz "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id da conta ou contato do cliente associado ao tíquete. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de cliente. Valores possíveis: Cliente CustomerContact Consumidor Tipo de dados: cadeia de caracteres
estado	Estado atual do produto. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo cria um inventário de produtos para uma solução de voz sobre IP para um usuário.

curl -X POST "https://instance.service-now.com/api/sn_prd_invt/product" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password" \
--data "[
   {
      "pid": "PO-456",
      "description": "inventory description",
      "isBundle": false,
      "name": "Voice Over IP Basic instance for Jean",
      "productOffering": {
         "@referredType": "ProductOffering",
         "name": "Premium SD-WAN Offering",
         "id": "69017a0f536520103b6bddeeff7b127d"
      },
      "productCharacteristic": [],
      "productRelationship": [
         {
            "productId": "fa6d13f45b5620102dff5e92dc81c77f",
            "relationshipType": "child"
         }
      ],
      "realizingService": {
         "id": "fe6d13f45b5620102dff5e92dc81c786",
         "relationshipType": "child"
      },
      "realizingResource": {
         "id": "326d13f45b5620102dff5e92dc81c78c",
         "relationshipType": "child"
      },
      "relatedParty": [
         {
            "@referredType": "CustomerContact",
            "@type": "RelatedParty",
            "name": "Sally Thomas",
            "id": "eaf68911c35420105252716b7d40ddde"
         },
         {
            "@referredType": "Customer",
            "@type": "RelatedParty",
            "name": "Funco Intl",
            "id": "ffc68911c35420105252716b7d40dd55"
         }
      ],
      "productSpecification": {
         "@referredType": "ProductSpecification",
         "@type": null,
         "name": null,
         "id": "3ee1fdb1c3331010d216b5183c40dd81",
         "internalVersion": "1"
      },
      "bundle": false
   }
]"

Corpo da resposta.

{
   "pid": "PO-456",
   "description": "inventory description",
   "isBundle": false,
   "name": "Voice Over IP Basic instance for Jean",
   "productOffering": {
      "@referredType": "ProductOffering",
      "name": "Premium SD-WAN Offering",
      "id": "69017a0f536520103b6bddeeff7b127d",
      "internalVersion": "1",
      "version": null,
      "status": "published",
      "internalId": "69017a0f536520103b6bddeeff7b127d"
   },
   "productCharacteristic": [],
   "productRelationship": [
      {
         "productId": "fa6d13f45b5620102dff5e92dc81c77f",
         "relationshipType": "child"
      }
   ],
   "realizingService": {
      "id": "fe6d13f45b5620102dff5e92dc81c786",
      "relationshipType": "child"
   },
   "realizingResource": {
      "id": "326d13f45b5620102dff5e92dc81c78c",
      "relationshipType": "child"
   },
   "relatedParty": [
      {
         "@referredType": "CustomerContact",
         "@type": "RelatedParty",
         "name": "Sally Thomas",
         "id": "eaf68911c35420105252716b7d40ddde"
      },
      {
         "@referredType": "Customer",
         "@type": "RelatedParty",
         "name": "Example Company",
         "id": "ffc68911c35420105252716b7d40dd55"
      }
   ],
   "productSpecification": {
      "@referredType": "ProductSpecification",
      "@type": null,
      "name": null,
      "id": "3ee1fdb1c3331010d216b5183c40dd81",
      "internalVersion": "1",
      "version": null,
      "status": "published",
      "internalId": "3ee1fdb1c3331010d216b5183c40dd81"
   },
   "bundle": false,
   "productPrice": [],
   "id": "25b07475471789108761b955d36d439d",
   "href": "/api/sn_prd_invt/product/25b07475471789108761b955d36d439d"
}

API aberta de inventário de produtos - POST /sn_prd_invt/productinventory

Cria um inventário de produtos.

Importante:

A partir da versão Tokyo, este endpoint está obsoleto. A nova versão deste endpoint é API aberta do inventário de produtos - POST /sn_prd_invt/product.

Formato da URL

URL padrão: /api/sn_prd_invt/productinventory

Parâmetros de solicitação compatíveis

Tabela 31. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 32. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 33. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
nome	Obrigatório. Nome do inventário do produto. Tipo de dados: cadeia de caracteres
PID	Identificador exclusivo do inventário de produtos do sistema externo. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
productCaracterística	Lista de características do produto. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nome da característica. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
productCaracterística.valor	Valor da característica. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
productOffering	Obrigatório. Oferta de produto à qual o inventário de produtos está associado. Tipo de dados: objeto "productOffering": { "id": "String", "name": "String" }
productOffering.id	Obrigatório. Sys_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
productRelationship	Lista de produtos relacionados. Tipo de dados: matriz "productRelationship": [ { "productId": "String", "relationshipType": "String" } ]
productRelationship.productId	Obrigatório se estiver usando o parâmetro productRelationship. Sys_id do produto relacionado da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
productRelationship.relationshipType	Tipo de relacionamento. O único valor válido é child. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
productSpecification	Obrigatório. Especificação do produto para o produto. Tipo de dados: objeto "productSpecification": { "id": "String" }
productSpecification.id	Obrigatório. Sys_id da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
realizandoRecurso	Realização de recurso. Tipo de dados: objeto "realizingResource": { "id": "String", "type": "String" }
realizingResource.id	Obrigatório se estiver usando o parâmetro realizingResource. Sys_id do recurso de realização da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoRecurso.tipo	Tipo de recurso de realização. O único valor válido é child. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
realizandoServiço	Realização de serviço. Tipo de dados: objeto "realizingService": { "id": "String", "type": "String" }
realizingService.id	Obrigatório se estiver usando o parâmetro realizingService. Sys_id do serviço de realização da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoServiço.tipo	Tipo de serviço de realização. O único valor válido é child. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
relatedParty	Lista de partes associadas ao tíquete. Tipo de dados: matriz "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	Obrigatório se estiver usando o parâmetro relatedParty. Sys_id da conta ou contato do cliente associado ao tíquete. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_Consumer]. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de cliente. Valores possíveis: cliente contato_cliente cliente Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
estado	Estado atual do produto. Valores possíveis: ativo mudança_pendente inactivation_pendente inativo instalação_pendente Tipo de dados: cadeia de caracteres Padrão: install_pending

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 34. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

Tabela 35. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 36. Códigos de status

Código de status	Descrição
201	Solicitação processada com sucesso.
400	Solicitação Incorreta. Pode ser qualquer um dos seguintes motivos: Carga vazia. Carga inválida. Campo obrigatório ausente:<field name>

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
ID	Sys_id do inventário de produtos da tabela Product Inventory [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
nome	Nome do inventário do produto. Tipo de dados: cadeia de caracteres
PID	Identificador exclusivo do inventário de produtos do sistema externo. Tipo de dados: cadeia de caracteres
productCaracterística	Lista de características do produto. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCaracterística.nome	Nome da característica. Tipo de dados: cadeia de caracteres
productCaracterística.valor	Valor da característica. Tipo de dados: cadeia de caracteres
productOffering	Oferta de produto à qual o inventário de produtos está associado. Tipo de dados: objeto "productOffering": { "id": "String", "name": "String" }
productOffering.id	Sys_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productRelationship	Lista de produtos relacionados. Tipo de dados: matriz "productRelationship": [ { "productId": "String", "relationshipType": "String" } ]
productRelationship.productId	Sys_id do produto relacionado da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
productRelationship.relationshipType	Tipo de relacionamento. Tipo de dados: cadeia de caracteres
productSpecification	Especificação do produto para o produto. Tipo de dados: objeto "productSpecification": { "id": "String" }
productSpecification.id	Sys_id da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
realizandoRecurso	Realização de recurso. Tipo de dados: objeto "realizingResource": { "id": "String", "type": "String" }
realizandoResource.id	Sys_id do recurso de realização da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoRecurso.tipo	Tipo de recurso de realização. Tipo de dados: cadeia de caracteres
realizandoServiço	Realização de serviço. Tipo de dados: objeto "realizingService": { "id": "String", "type": "String" }
realizandoServiço.id	Sys_id do serviço de realização da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoServiço.tipo	Tipo de serviço de realização. Tipo de dados: cadeia de caracteres
relatedParty	Lista de partes associadas ao tíquete. Tipo de dados: matriz "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id da conta ou contato do cliente associado ao tíquete. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de cliente. Valores possíveis: Cliente CustomerContact Consumidor Tipo de dados: cadeia de caracteres
estado	Estado atual do produto. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo cria um inventário de produtos para uma solução de voz sobre IP para um usuário.

curl --location --request POST “https://instance.servicenow.com/api/sn_prd_invt/productinventory” \
--header “Content-Type: application/json” \
--data-raw '[
    {
        "pid": "demoInventory",
        "description": "inventory description",
        "isBundle": false,
        "name": "Voice Over IP Basic instance for Jean",
        "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "@referredType": "ProductOffering"
        },
        "productCharacteristic": [
            {
                "name": "CPE Type",
                "valueType": "choice",
                "value": "Virtual"
            },
            {
                "name":"Routing",
                "valueType": "choice",
                "value": "Premium"
            }
        ],
        "productRelationship": [
            {
                "productId": "7e6d13f45b5620102dff5e92dc81c787",
                "relationshipType": "child"
            }
        ],
        "relatedParty": [
            {
                "id": "eaf68911c35420105252716b7d40ddde",
                "name": "Sally Thomas",
                "role": "User",
                "@type": "RelatedParty",
                "@referredType": "CustomerContact"
            },
            {
                "id": "ffc68911c35420105252716b7d40dd55",
                "name": "Funco Intl",
                "@type": "RelatedParty",
                "@referredType": "Customer"
            }
        ],
        "productSpecification": {
            "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
            "@referredType": "ProductSpecification",
            "version": "1"
        }
    }
]'
--user 'username':'password'

Corpo da resposta.

{
   "pid": "demoInventory",
   "description": "inventory description",
   "isBundle": false,
   "name": "Voice Over IP Basic instance for Jean",
   "productOffering": {
      "id": "69017a0f536520103b6bddeeff7b127d",
      "name": "Premium SD-WAN Offering",
      "@referredType": "ProductOffering"
   },
   "productCharacteristic": [
      {
         "name": "CPE Type",
         "valueType": "choice",
         "value": "Virtual"
      },
      {
         "name": "Routing",
         "valueType": "choice",
         "value": "Premium"
      }
   ],
   "productRelationship": [
      {
         "productId": "7e6d13f45b5620102dff5e92dc81c787",
         "relationshipType": "child"
      }
   ],
   "relatedParty": [
      {
         "id": "eaf68911c35420105252716b7d40ddde",
         "name": "Sally Thomas",
         "role": "User",
         "@type": "RelatedParty",
         "@referredType": "CustomerContact"
      },
      {
         "id": "ffc68911c35420105252716b7d40dd55",
         "name": "Funco Intl",
         "@type": "RelatedParty",
         "@referredType": "Customer"
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "@referredType": "ProductSpecification",
      "version": "1"
   },
   "id": "3ac715c6745d8150f877ca57242ff97a"
}