API de Gestão de cotações

Versão de lançamento: Zurich

Atualizado 31 de jul. de 2025

45 min. de leitura

. Gestão de cotações A API fornece endpoints para criar, atualizar e recuperar dados de cotação do cliente.

. Gestão de cotações aberta A API é um ServiceNow Implementação da especificação REST da API de Gestão de cotações do TM Forum. Esta implementação é baseada em https://www.tmforum.org/resources/standard/tmf648-quote-management-api-rest-specification-r19-0-0/ .

Esta API pode ser estendida para fazer personalizações em relação aos parâmetros necessários, solicitar validação de corpo, operações REST adicionais e mapeamentos de campo.

. Gestão de cotações A API requer o plug-in Gestão de cotações (com.sn_quote_mgmt) e a função quote_integrator. Esta API pertence ao namespace sn_tmf_api. Consulte Quote Management.

. Gestão de cotações A API cria ou atualiza dados nas seguintes tabelas:

Cotação [sn_quote_mgmt_core_quote]
Acordo de vendas [sn_sales_agmt_core_sales_agreement]
Item de linha de cotação [sn_quote_mgmt_core_quote_line_item]
Característica da linha de cotação [sn_quote_mgmt_core_quote_line_characteric]
Ajuste de preço de cotação [sn_quote_mgmt_core_pricing_adjustment]

API de gestão de cotações - EXCLUA /sn_tmf_api/quote_management_api/quote/

Exclui a cotação especificada.

Formato de URL

URL com controle de versão: /api/sn_tmf_api//quote_management_api/quote/

URL padrão: /api/sn_tmf_api/quote_management_api/quote/

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho
Nome	Descrição
id	Sys_id da cotação a ser excluída. Tipo de dados: Cadeia de caracteres Tabela: Quote [sn_quote_mgmt_core_quote]

Tabela 2. Parâmetros de consulta
Nome	Descrição
Nenhum(a)

Tabela 3. Solicitar parâmetros do corpo (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
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

Tabela 5. Cabeçalhos de resposta
Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 6. Códigos de status
Código do status	Descrição
204	Bem-sucedido. Solicitação concluída com sucesso e a cotação especificada foi excluída. Não há conteúdo.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.

Parâmetros do corpo da resposta (JSON)


Cabeçalho	Descrição
Nenhum(a)

Solicitação de curl

Este exemplo mostra como excluir uma cotação.

curl "http://instance.servicenow.com/api/sn_tmf_api/quote_management_api/quote/cb15734fd5692a10f8774663edf0ac19" \ 
--request DELETE\ 
--header "Accept:application/json" \ 
--user 'username':'password'

API de gestão de cotações - OBTENHA /sn_tmf_api/quote_management_api/quote

Recupera todas as cotações.

Esta API recupera informações de cotação das seguintes tabelas relacionadas:

Cotação [sn_quote_mgmt_core_quote]
Acordo de vendas [sn_sales_agmt_core_sales_agreement]
Item de linha de cotação [sn_quote_mgmt_core_quote_line_item]
Característica da linha de cotação [sn_quote_mgmt_core_quote_line_characteric]
Ajuste de preço de cotação [sn_quote_mgmt_core_pricing_adjustment]

Formato de URL

URL com controle de versão: /api/sn_tmf_api//quote_management_api/quote

URL padrão: /api/sn_tmf_api/quote_management_api/quote

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho
Nome	Descrição
Nenhum(a)

Tabela 8. Parâmetros de consulta
Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Campos válidos: QuoteNumber href id descrição externalId ExpectedQuoteCompleDate versão . Tipo de dados: Cadeia de caracteres Padrão: Todos os campos retornados.
id	Filtrar resultados por sys_id de cotação. Tabela: Quote [sn_quote_mgmt_core_quote] Tipo de dados: Cadeia de caracteres Vazio
limite	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use offsetparâmetro para paginar a recuperação de registro. Tipo de dados: Número Padrão: 20 Máximo: 100
deslocamento	Índice inicial no qual começar a recuperar registros. Use este valor para paginar a recuperação de registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Tipo de dados: Número Padrão: 0

Tabela 9. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
Nenhum(a)

Cabeçalhos

Tabela 10. Cabeçalhos da solicitação
Cabeçalho	Descrição
Nenhum(a)

Tabela 11. Cabeçalhos de resposta
Cabeçalho	Descrição
Intervalo de conteúdo	Intervalo de conteúdo retornado em uma chamada paginada. Por exemplo, se `deslocamento: 2` e. `limite: 3` , o valor de Content-Rangeo cabeçalho é `itens 3-5` .
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Link	Contém os seguintes links para navegar pelos resultados da consulta. primeiro último avançar anterior
X-Total-Count	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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 12. Códigos de status
Código do status	Descrição
200	Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação).
206	Recurso parcial retornado na 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
ContactMedium	Lista de meios de contato. Informações de contato relacionadas ao solicitante da cotação. `"contactMedium": [ { "city": "String", "country": "String", "locationId": "String", "mediumType": "String", "postCode": "String", "stateOrProvince": "String", "street": "String", "@type": "String" } ]`
ContactMedium.city	Cidade na qual o solicitante da cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.country	País no qual o solicitante da cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.locationId	Sys_id do local listado na tabela Local [cmn_location] ou endereço personalizado. Tipo de dados: Cadeia de caracteres
ContactMedium.mediumType	Tipo de meio de contato, como endereço de e-mail, número de telefone ou endereço postal. Tipo de dados: Cadeia de caracteres
ContactMedium.CEP	CEP do solicitante da cotação. Tipo de dados: Cadeia de caracteres
ContactMedium.stateOrProvince	Estado ou província no qual o solicitante de cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.street	Endereço do solicitante da cotação. Tipo de dados: Cadeia de caracteres
ContactMedium. Em tipo	Tipo de mídia de acordo com o padrão de API aberta do TMF. Por exemplo, `EndereçoGeographicalContactMedium` . Tipo de dados: Cadeia de caracteres
descrição	Descrição da cotação. Tipo de dados: Cadeia de caracteres
ExpectedQuoteCompleDate	A data esperada do fornecedor da cotação para poder enviar de volta uma resposta para esta cotação. Tipo de dados: Cadeia de caracteres
externalId	ID exclusivo fornecido pelo consumidor para a cotação. Tipo de dados: Cadeia de caracteres
href	Link relativo para acessar a cotação. Tipo de dados: Cadeia de caracteres Cadeia de caracteres vazia
id	Sys_id da cotação solicitada. Tabela: Quote [sn_quote_mgmt_core_quote] Tipo de dados: Cadeia de caracteres
nota	Lista de anotações associadas à cotação. Tipo de dados: Matriz `"note": [ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]`
note.author	Nome de usuário da pessoa que criou a anotação associada. Tipo de dados: Cadeia de caracteres
note.date	Data em que a anotação foi criada. Tipo de dados: Cadeia de caracteres
note.text	Conteúdo da anotação. Tipo de dados: Cadeia de caracteres
tipo. em	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
QuoteDate	Data e hora em que a cotação foi criada. Tipo de dados: Cadeia de caracteres
QuoteItem	Uma lista de itens de cotação. Cada item de cotação descreve uma ação para um produto a ser cotado. `"quoteItem": [ { "action": "String", "id": "String", "product": {Object}, "productOffering": {Object}, "quantity": Number, "state": "String", "@type": "String" } ]` Tipo de dados: Matriz de objetos
QuoteItem.action	Ação a ser realizada neste item de cotação (adicionar, modificar, remover etc.). Tipo de dados: Cadeia de caracteres
quoteItem.id	Sys_id do item de cotação. Tabela: Item de linha de cotação [sn_quote_mgmt_core_quote_line_item] Tipo de dados: Cadeia de caracteres
quoteItem.product	Lista de produtos incluídos na cotação. `"product": { "characteristic": "String", "specification": "String", "@type": "String" }` Tipo de dados: Objeto
quoteItem.product. Característica	Lista de características do produto. Tipo de dados: Matriz de objetos `"characteristic": [ { "id": "String", "name": "String", "@type": "String", "value": "String" } ]` Consulte Create product characteristics and characteristic options.
quoteItem.product. Característica.ID	Sys_id da característica do produto. Tabela: Característica da linha de cotação [sn_quote_mgmt_core_quote_line_characteric] Tipo de dados: Cadeia de caracteres
quoteItem.product. characteristic.name	Nome da característica do produto. Tipo de dados: Cadeia de caracteres
quoteItem.product. Característica. No tipo	Este valor é sempre `StringCharacterística` . Tipo de dados: Cadeia de caracteres
quoteItem.product. Característica.Valor	Valor da característica. Tipo de dados: Cadeia de caracteres
quoteItem.product. Especificação	Descrição detalhada de um objeto tangível ou incorpóreo disponibilizado externamente na forma de um ProductOffering para clientes ou outras partes que desempenham um papel de parte. Tipo de dados: Cadeia de caracteres
quoteItem.product.@type	Este valor é sempre `Produto` . Tipo de dados: Cadeia de caracteres
quoteItem.productOffering	Uma referência de oferta de produto (ProductOfferingRef). Uma oferta de produto representa entidades que podem ser solicitadas do provedor do catálogo. `"productOffering": { "href": "String", "name": "String", "name": "String", "@type": "String" }` Tipo de dados: Objeto
QuoteItem. ProductOffering.href	Referência da entidade relacionada. Tipo de dados: Cadeia de caracteres
QuoteItem. ProductOffering.id	Sys_id da oferta de produto. Tabela: Oferta de produto [sn_prd_pm_product_offering] Tipo de dados: Cadeia de caracteres
QuoteItem. productOffering.name	Nome da entidade relacionada. Tipo de dados: Cadeia de caracteres
QuoteItem. ProductOffering. No tipo	Este valor é sempre `OfertaProdutoRef` . Tipo de dados: Cadeia de caracteres
QuoteItem.Quantidade	Quantidade solicitada para este item de cotação. Tipo de dados: Número
QuoteItem.state	Um tipo de estado de cotação (QuoteStateType). Estado da cotação. Tipo de dados: Cadeia de caracteres
QuoteItem. No tipo	Este valor é sempre `QuoteItem` . Tipo de dados: Cadeia de caracteres
QuoteNumber	Número de registro do item de linha de cotação atribuído à cotação. Tabela: Item de linha de cotação [sn_quote_mgmt_core_quote_line_item] Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String", "@type": "String" } ]`
relatedParty.id	Sys_id da tabela de cotação para obter a conta, o contato ou o cliente. Tabela: Quote [sn_quote_mgmt_core_quote] Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
RelatedParty.role	A função da parte no contexto da cotação (por exemplo, Conta, Contato ou Cliente). Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Este valor é sempre `OfertaProdutoRef` . Tipo de dados: Cadeia de caracteres
QuoteCompleDate solicitada	Uma data e hora (DateTime). Este valor representa a data especificada pelo solicitante da cotação para receber uma resposta completa para esta cotação. Tipo de dados: Cadeia de caracteres
estado	Estado do item de cotação. Tipo de dados: Cadeia de caracteres
.	Tipo de recurso. Este valor é sempre `Cotação` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo recupera todas as aspas.

curl "https://instance.service-now.com/api/sn_tmf_api/quote_management_api/quote" \
--request GET \
--header "Accept:application/json" \
--user 'userName':'password'

Corpo da resposta.

{
  "id": "47e562bad565a610f8774663edf0ac10",
  "quoteNumber": "QT0001001",
  "href": "api/sn_tmf_api/quote_management_api/quote/47e562bad565a610f8774663edf0ac10",
  "@type": "Quote",
  "description": "Testing Quote",
  "expectedQuoteCompletionDate": "2025-05-23 11:12:08",
  "externalId": "Test_1234",
  "quoteDate": "2025-05-20 11:11:13",
  "requestedQuoteCompletionDate": "2025-05-23 11:12:08",
  "version": "3",
  "agreement": [],
  "contactMedium": [
    {
      "@type": "GeographicalAddressContactMedium",
      "mediumType": "ShippingAddressRef",
      "locationId": "6774fee611383110f877366201dea64f",
      "city": "Santa Clara",
      "country": "USA",
      "postCode": "94560",
      "stateOrProvince": "CA",
      "street": "222 Star St"
    }
  ],
  "note": [],
  "quoteItem": [
    {
      "id": "8be562bad565a610f8774663edf0ac16",
      "@type": "QuoteItem",
      "action": "add",
      "quantity": "1",
      "state": "Draft",
      "product": {
        "@type": "Product",
        "productCharacteristic": [
          {
            "id": "0fe562bad565a610f8774663edf0ac17",
            "name": "Voice Pack",
            "value": "1500 Minutes/Month"
          },
          {
            "id": "4be562bad565a610f8774663edf0ac17",
            "name": "SMS Pack",
            "value": "700 /Month"
          },
          {
            "id": "83e562bad565a610f8774663edf0ac18",
            "name": "Data Pack",
            "value": "20 GB/Month"
          },
          {
            "id": "87e562bad565a610f8774663edf0ac17",
            "name": "Mobile Number",
            "value": ""
          },
          {
            "id": "cfe562bad565a610f8774663edf0ac17",
            "name": "Shipping Address",
            "value": ""
          }
        ],
        "productSpecification": {
          "id": "3ee1fdb1c3331010d216b5183c40dd81",
          "href": "api/sn_tmf_api/catalogmanagement/productSpecification/3ee1fdb1c3331010d216b5183c40dd81",
          "name": "Mobile Plan",
          "@type": "ProductSpecificationRef"
        }
      },
      "productOffering": {
        "id": "2cb5588fc30020105252716b7d40dddd",
        "href": "api/sn_tmf_api/catalogmanagement/productOffering/2cb5588fc30020105252716b7d40dddd",
        "name": "All in one mobile plan starting from $49/month",
        "@type": "ProductOfferingRef"
      },
      "quoteItemPrice": [
        {
          "description": "Standard Price List",
          "name": "Standard Price List",
          "priceType": "Recurring",
          "recurringChargePeriod": "",
          "unitOfMeasure": "",
          "unitMarginPercentage": "",
          "price": {
            "totalOneTimePrice": {
              "unit": "USD",
              "value": 0
            },
            "monthlyRecurringPrice": {
              "unit": "USD",
              "value": 0
            },
            "annualRecurringPrice": {
              "unit": "USD",
              "value": 0
            },
            "cumulativeRecurringPrice": {
              "unit": "USD",
              "value": 0
            },
            "cumulativeAnnualRecurringPrice": {
              "unit": "USD",
              "value": 0
            },
            "cumulativeNetPrice": {
              "unit": "USD",
              "value": 0
            },
            "unitMarginAmount": {
              "unit": "USD",
              "value": 0
            },
            "unitMarginBasePrice": {
              "unit": "USD",
              "value": 0
            },
            "listPrice": {
              "unit": "USD",
              "value": 0
            },
            "unitCost": {
              "unit": "USD",
              "value": 0
            },
            "unitPrice": {
              "unit": "USD",
              "value": 0
            },
            "dutyFreeAmount": {
              "unit": "USD",
              "value": 0
            },
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 0
            }
          },
          "priceAlteration": []
        }
      ]
    }
  ],
  "relatedParty": [
    {
      "role": "Customer",
      "id": "9e2fd2ee11b43110f877366201dea674",
      "name": "Startech svcs",
      "@type": "RelatedPartyRef",
      "@referredType": "Organization"
    },
    {
      "role": "CustomerContact",
      "id": "dca96eaa11f43110f877366201dea6c1",
      "name": "Alex Star",
      "@type": "RelatedPartyRef",
      "@referredType": "Individual"
    }
  ],
  "state": "Draft"
}

API de Gestão de cotações - OBTER /sn_tmf_api/quote_management_api/quote/

Recupera uma cotação especificada.

Esta API recupera informações de cotação das seguintes tabelas relacionadas:

Cotação [sn_quote_mgmt_core_quote]
Acordo de vendas [sn_sales_agmt_core_sales_agreement]
Item de linha de cotação [sn_quote_mgmt_core_quote_line_item]
Característica da linha de cotação [sn_quote_mgmt_core_quote_line_characteric]
Ajuste de preço de cotação [sn_quote_mgmt_core_pricing_adjustment]

Formato de URL

URL com controle de versão: /api/sn_tmf_api//quote_management_api/quote/

URL padrão: /api/sn_tmf_api/quote_management_api/quote/

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho
Nome	Descrição
id	Sys_id da cotação a ser recuperada. Tipo de dados: Cadeia de caracteres Tabela: Quote [sn_quote_mgmt_core_quote]

Tabela 14. Parâmetros de consulta
Nome	Descrição
Nenhum(a)

Tabela 15. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
Nenhum(a)

Cabeçalhos

Tabela 16. Cabeçalhos da solicitação
Cabeçalho	Descrição
Nenhum(a)

Tabela 17. 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 18. Códigos de status
Código do status	Descrição
200	Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação).
206	Recurso parcial retornado na 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
ContactMedium	Lista de meios de contato. Informações de contato relacionadas ao solicitante da cotação. `"contactMedium": [ { "city": "String", "country": "String", "locationId": "String", "mediumType": "String", "postCode": "String", "stateOrProvince": "String", "street": "String", "@type": "String" } ]`
ContactMedium.city	Cidade na qual o solicitante da cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.country	País no qual o solicitante da cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.locationId	Sys_id do local listado na tabela Local [cmn_location] ou endereço personalizado. Tipo de dados: Cadeia de caracteres
ContactMedium.mediumType	Tipo de meio de contato, como endereço de e-mail, número de telefone ou endereço postal. Tipo de dados: Cadeia de caracteres
ContactMedium.CEP	CEP do solicitante da cotação. Tipo de dados: Cadeia de caracteres
ContactMedium.stateOrProvince	Estado ou província no qual o solicitante de cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.street	Endereço do solicitante da cotação. Tipo de dados: Cadeia de caracteres
ContactMedium. Em tipo	Tipo de mídia de acordo com o padrão de API aberta do TMF. Por exemplo, `EndereçoGeographicalContactMedium` . Tipo de dados: Cadeia de caracteres
descrição	Descrição da cotação. Tipo de dados: Cadeia de caracteres
ExpectedQuoteCompleDate	A data esperada do fornecedor da cotação para poder enviar de volta uma resposta para esta cotação. Tipo de dados: Cadeia de caracteres
externalId	ID exclusivo fornecido pelo consumidor para a cotação. Tipo de dados: Cadeia de caracteres
href	Link relativo para acessar a cotação. Tipo de dados: Cadeia de caracteres Cadeia de caracteres vazia
id	Sys_id da cotação solicitada. Tabela: Quote [sn_quote_mgmt_core_quote] Tipo de dados: Cadeia de caracteres
nota	Lista de anotações associadas à cotação. Tipo de dados: Matriz `"note": [ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]`
note.author	Nome de usuário da pessoa que criou a anotação associada. Tipo de dados: Cadeia de caracteres
note.date	Data em que a anotação foi criada. Tipo de dados: Cadeia de caracteres
note.text	Conteúdo da anotação. Tipo de dados: Cadeia de caracteres
tipo. em	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
QuoteDate	Data e hora em que a cotação foi criada. Tipo de dados: Cadeia de caracteres
QuoteItem	Uma lista de itens de cotação. Cada item de cotação descreve uma ação para um produto a ser cotado. `"quoteItem": [ { "action": "String", "id": "String", "product": {Object}, "productOffering": {Object}, "quantity": Number, "state": "String", "@type": "String" } ]` Tipo de dados: Matriz de objetos
QuoteItem.action	Ação a ser realizada neste item de cotação (adicionar, modificar, remover etc.). Tipo de dados: Cadeia de caracteres
quoteItem.id	Sys_id do item de cotação. Tabela: Item de linha de cotação [sn_quote_mgmt_core_quote_line_item] Tipo de dados: Cadeia de caracteres
quoteItem.product	Lista de produtos incluídos na cotação. `"product": { "characteristic": "String", "specification": "String", "@type": "String" }` Tipo de dados: Objeto
quoteItem.product. Característica	Lista de características do produto. Tipo de dados: Matriz de objetos `"characteristic": [ { "id": "String", "name": "String", "@type": "String", "value": "String" } ]` Consulte Create product characteristics and characteristic options.
quoteItem.product. Característica.ID	Sys_id da característica do produto. Tabela: Característica da linha de cotação [sn_quote_mgmt_core_quote_line_characteric] Tipo de dados: Cadeia de caracteres
quoteItem.product. characteristic.name	Nome da característica do produto. Tipo de dados: Cadeia de caracteres
quoteItem.product. Característica. No tipo	Este valor é sempre `StringCharacterística` . Tipo de dados: Cadeia de caracteres
quoteItem.product. Característica.Valor	Valor da característica. Tipo de dados: Cadeia de caracteres
quoteItem.product. Especificação	Descrição detalhada de um objeto tangível ou incorpóreo disponibilizado externamente na forma de um ProductOffering para clientes ou outras partes que desempenham um papel de parte. Tipo de dados: Cadeia de caracteres
quoteItem.product.@type	Este valor é sempre `Produto` . Tipo de dados: Cadeia de caracteres
quoteItem.productOffering	Uma referência de oferta de produto (ProductOfferingRef). Uma oferta de produto representa entidades que podem ser solicitadas do provedor do catálogo. `"productOffering": { "href": "String", "name": "String", "name": "String", "@type": "String" }` Tipo de dados: Objeto
QuoteItem. ProductOffering.href	Referência da entidade relacionada. Tipo de dados: Cadeia de caracteres
QuoteItem. ProductOffering.id	Sys_id da oferta de produto. Tabela: Oferta de produto [sn_prd_pm_product_offering] Tipo de dados: Cadeia de caracteres
QuoteItem. productOffering.name	Nome da entidade relacionada. Tipo de dados: Cadeia de caracteres
QuoteItem. ProductOffering. No tipo	Este valor é sempre `OfertaProdutoRef` . Tipo de dados: Cadeia de caracteres
QuoteItem.Quantidade	Quantidade solicitada para este item de cotação. Tipo de dados: Número
QuoteItem.state	Um tipo de estado de cotação (QuoteStateType). Estado da cotação. Tipo de dados: Cadeia de caracteres
QuoteItem. No tipo	Este valor é sempre `QuoteItem` . Tipo de dados: Cadeia de caracteres
QuoteNumber	Número de registro do item de linha de cotação atribuído à cotação. Tabela: Item de linha de cotação [sn_quote_mgmt_core_quote_line_item] Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String", "@type": "String" } ]`
relatedParty.id	Sys_id da tabela de cotação para obter a conta, o contato ou o cliente. Tabela: Quote [sn_quote_mgmt_core_quote] Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
RelatedParty.role	A função da parte no contexto da cotação (por exemplo, Conta, Contato ou Cliente). Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Este valor é sempre `OfertaProdutoRef` . Tipo de dados: Cadeia de caracteres
QuoteCompleDate solicitada	Uma data e hora (DateTime). Este valor representa a data especificada pelo solicitante da cotação para receber uma resposta completa para esta cotação. Tipo de dados: Cadeia de caracteres
estado	Estado do item de cotação. Tipo de dados: Cadeia de caracteres
.	Tipo de recurso. Este valor é sempre `Cotação` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo a seguir recupera uma cotação especificada.

curl "https://instance.service-now.com/api/sn_tmf_api/quote_management_api/quote/04ba9004f11f3110f8777d7194f166f6" \
--request GET \
--header "Accept:application/json" \
--user 'userName':'password'

Corpo da resposta.

{
  "id": "47e562bad565a610f8774663edf0ac10",
  "quoteNumber": "QT0001001",
  "href": "api/sn_tmf_api/quote_management_api/quote/47e562bad565a610f8774663edf0ac10",
  "@type": "Quote",
  "description": "Testing Quote",
  "expectedQuoteCompletionDate": "2025-05-23 11:12:08",
  "externalId": "Test_1234",
  "quoteDate": "2025-05-20 11:11:13",
  "requestedQuoteCompletionDate": "2025-05-23 11:12:08",
  "version": "3",
  "agreement": [],
  "contactMedium": [
    {
      "@type": "GeographicalAddressContactMedium",
      "mediumType": "ShippingAddressRef",
      "locationId": "6774fee611383110f877366201dea64f",
      "city": "Santa Clara",
      "country": "USA",
      "postCode": "94560",
      "stateOrProvince": "CA",
      "street": "222 Star St"
    }
  ],
  "note": [],
  "quoteItem": [
    {
      "id": "8be562bad565a610f8774663edf0ac16",
      "@type": "QuoteItem",
      "action": "add",
      "quantity": "1",
      "state": "Draft",
      "product": {
        "@type": "Product",
        "productCharacteristic": [
          {
            "id": "0fe562bad565a610f8774663edf0ac17",
            "name": "Voice Pack",
            "value": "1500 Minutes/Month"
          },
          {
            "id": "4be562bad565a610f8774663edf0ac17",
            "name": "SMS Pack",
            "value": "700 /Month"
          },
          {
            "id": "83e562bad565a610f8774663edf0ac18",
            "name": "Data Pack",
            "value": "20 GB/Month"
          },
          {
            "id": "87e562bad565a610f8774663edf0ac17",
            "name": "Mobile Number",
            "value": ""
          },
          {
            "id": "cfe562bad565a610f8774663edf0ac17",
            "name": "Shipping Address",
            "value": ""
          }
        ],
        "productSpecification": {
          "id": "3ee1fdb1c3331010d216b5183c40dd81",
          "href": "api/sn_tmf_api/catalogmanagement/productSpecification/3ee1fdb1c3331010d216b5183c40dd81",
          "name": "Mobile Plan",
          "@type": "ProductSpecificationRef"
        }
      },
      "productOffering": {
        "id": "2cb5588fc30020105252716b7d40dddd",
        "href": "api/sn_tmf_api/catalogmanagement/productOffering/2cb5588fc30020105252716b7d40dddd",
        "name": "All in one mobile plan starting from $49/month",
        "@type": "ProductOfferingRef"
      },
      "quoteItemPrice": [
        {
          "description": "Standard Price List",
          "name": "Standard Price List",
          "priceType": "Recurring",
          "recurringChargePeriod": "",
          "unitOfMeasure": "",
          "unitMarginPercentage": "",
          "price": {
            "totalOneTimePrice": {
              "unit": "USD",
              "value": 0
            },
            "monthlyRecurringPrice": {
              "unit": "USD",
              "value": 0
            },
            "annualRecurringPrice": {
              "unit": "USD",
              "value": 0
            },
            "cumulativeRecurringPrice": {
              "unit": "USD",
              "value": 0
            },
            "cumulativeAnnualRecurringPrice": {
              "unit": "USD",
              "value": 0
            },
            "cumulativeNetPrice": {
              "unit": "USD",
              "value": 0
            },
            "unitMarginAmount": {
              "unit": "USD",
              "value": 0
            },
            "unitMarginBasePrice": {
              "unit": "USD",
              "value": 0
            },
            "listPrice": {
              "unit": "USD",
              "value": 0
            },
            "unitCost": {
              "unit": "USD",
              "value": 0
            },
            "unitPrice": {
              "unit": "USD",
              "value": 0
            },
            "dutyFreeAmount": {
              "unit": "USD",
              "value": 0
            },
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 0
            }
          },
          "priceAlteration": []
        }
      ]
    }
  ],
  "relatedParty": [
    {
      "role": "Customer",
      "id": "9e2fd2ee11b43110f877366201dea674",
      "name": "Startech svcs",
      "@type": "RelatedPartyRef",
      "@referredType": "Organization"
    },
    {
      "role": "CustomerContact",
      "id": "dca96eaa11f43110f877366201dea6c1",
      "name": "Alex Star",
      "@type": "RelatedPartyRef",
      "@referredType": "Individual"
    }
  ],
  "state": "Draft"
}

API de Gestão de cotações - PATCH /sn_tmf_api/quote_management_api/quote/

Atualiza a cotação especificada.

Formato de URL

URL com controle de versão: /api/sn_tmf_api//quote_management_api/quote/

URL padrão: /api/sn_tmf_api/quote_management_api/quote/

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho
Nome	Descrição
id	Sys_id da cotação a ser atualizada. Tipo de dados: Cadeia de caracteres Tabela: Quote [sn_quote_mgmt_core_quote]

Tabela 20. Parâmetros de consulta
Nome	Descrição
Nenhum(a)

Tabela 21. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
ContactMedium	Lista de meios de contato. Informações de contato relacionadas ao solicitante da cotação. `"contactMedium": [ { "city": "String", "country": "String", "locationId": "String", "mediumType": "String", "postCode": "String", "stateOrProvince": "String", "street": "String", "@type": "String" } ]`
ContactMedium.city	Cidade na qual o solicitante da cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.country	País no qual o solicitante da cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.locationId	Sys_id do local listado na tabela Local [cmn_location] ou endereço personalizado. Tipo de dados: Cadeia de caracteres
ContactMedium.mediumType	Tipo de meio de contato, como endereço de e-mail, número de telefone ou endereço postal. Tipo de dados: Cadeia de caracteres
ContactMedium.CEP	CEP do solicitante da cotação. Tipo de dados: Cadeia de caracteres
ContactMedium.stateOrProvince	Estado ou província no qual o solicitante de cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.street	Endereço do solicitante da cotação. Tipo de dados: Cadeia de caracteres
ContactMedium. Em tipo	Tipo de mídia de acordo com o padrão de API aberta do TMF. Por exemplo, `EndereçoGeographicalContactMedium` . Tipo de dados: Cadeia de caracteres
descrição	Descrição da cotação. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações associadas à cotação. Tipo de dados: Matriz `"note": [ { "text": "String", "@type": "String" } ]`
note.text	Conteúdo da anotação. Tipo de dados: Cadeia de caracteres
tipo. em	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
QuoteDate	Data e hora em que a cotação foi criada. Tipo de dados: Cadeia de caracteres
QuoteItem	Uma lista de itens de cotação. Cada item de cotação descreve uma ação para um produto a ser cotado. `"quoteItem": [ { "action": "String", "id": "String", "product": {Object}, "productOffering": {Object}, "productRelationship": {Object}, "quantity": Number, "state": "String", "@type": "String" } ]` Tipo de dados: Matriz de objetos
QuoteItem.action	Ação a ser realizada neste item de cotação (adicionar, modificar, remover etc.). Tipo de dados: Cadeia de caracteres
quoteItem.id	Sys_id do item de cotação. Tabela: Item de linha de cotação [sn_quote_mgmt_core_quote_line_item] Tipo de dados: Cadeia de caracteres
quoteItem.product	Lista de produtos incluídos na cotação. `"product": { "characteristic": "String", "specification": "String", "@type": "String" }` Tipo de dados: Objeto
quoteItem.product. Característica	Lista de características do produto. Tipo de dados: Matriz de objetos `"characteristic": [ { "id": "String", "name": "String", "@type": "String", "value": "String" } ]` Consulte Create product characteristics and characteristic options.
quoteItem.product. Característica.ID	Sys_id da característica do produto. Tabela: Característica da linha de cotação [sn_quote_mgmt_core_quote_line_characteric] Tipo de dados: Cadeia de caracteres
quoteItem.product. characteristic.name	Nome da característica do produto. Tipo de dados: Cadeia de caracteres
quoteItem.product. Característica. No tipo	Este valor é sempre `StringCharacterística` . Tipo de dados: Cadeia de caracteres
quoteItem.product. Característica.Valor	Valor da característica. Tipo de dados: Cadeia de caracteres
quoteItem.product. Especificação	Descrição detalhada de um objeto tangível ou incorpóreo disponibilizado externamente na forma de um ProductOffering para clientes ou outras partes que desempenham um papel de parte. Tipo de dados: Cadeia de caracteres
quoteItem.product.@type	Este valor é sempre `Produto` . Tipo de dados: Cadeia de caracteres
quoteItem.productOffering	Uma referência de oferta de produto (ProductOfferingRef). Uma oferta de produto representa entidades que podem ser solicitadas do provedor do catálogo. `"productOffering": { "href": "String", "name": "String", "name": "String", "@type": "String" }` Tipo de dados: Objeto
QuoteItem. ProductOffering.href	Referência da entidade relacionada. Tipo de dados: Cadeia de caracteres
QuoteItem. ProductOffering.id	Sys_id da oferta de produto. Tabela: Oferta de produto [sn_prd_pm_product_offering] Tipo de dados: Cadeia de caracteres
QuoteItem. productOffering.name	Nome da entidade relacionada. Tipo de dados: Cadeia de caracteres
QuoteItem. ProductOffering. No tipo	Este valor é sempre `OfertaProdutoRef` . Tipo de dados: Cadeia de caracteres
quoteItem.productRelationship	Uma lista de itens de cotação. Cada item de cotação descreve uma ação para um produto a ser cotado. `"productRelationship": [ { "product": "String", "relationshipType": "String" } ]` Tipo de dados: Matriz de objetos
quoteItem.productRelationship. Produto	Uma referência ou valor de produto (ProductRefOrValue). Um produto a ser criado definido por valor ou existente definido por referência. O produto atende a um dos seguintes critérios: Criação de produto pendente definida pelo valor. Produto existente definido por referência. Tipo de dados: Cadeia de caracteres
quoteItem.productRelationship. RelationshipType	Tipo de relacionamento do produto, como `pacote` se o produto for um pacote e você quiser descrever os produtos agrupados em. Tipo de dados: Cadeia de caracteres
QuoteItem.Quantidade	Quantidade solicitada para este item de cotação. Tipo de dados: Número
QuoteItem.state	Um tipo de estado de cotação (QuoteStateType). Estado da cotação. Tipo de dados: Cadeia de caracteres
QuoteItem. No tipo	Este valor é sempre `QuoteItem` . Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String", "@type": "String" } ]`
relatedParty.id	Sys_id da tabela de cotação para obter a conta, o contato ou o cliente. Tabela: Quote [sn_quote_mgmt_core_quote] Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
RelatedParty.role	A função da parte no contexto da cotação (por exemplo, Conta, Contato ou Cliente). Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Este valor é sempre `OfertaProdutoRef` . Tipo de dados: Cadeia de caracteres
estado	Estado do item de cotação. Tipo de dados: Cadeia de caracteres
.	Tipo de recurso. Este valor é sempre `Cotação` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Cabeçalhos

Tabela 22. 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 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 24. Códigos de status
Código do status	Descrição
200	Solicitação processada com sucesso. Recurso completo retornado na resposta (sem 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
ContactMedium	Lista de meios de contato. Informações de contato relacionadas ao solicitante da cotação. `"contactMedium": [ { "city": "String", "country": "String", "locationId": "String", "mediumType": "String", "postCode": "String", "stateOrProvince": "String", "street": "String", "@type": "String" } ]`
ContactMedium.city	Cidade na qual o solicitante da cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.country	País no qual o solicitante da cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.locationId	Sys_id do local listado na tabela Local [cmn_location] ou endereço personalizado. Tipo de dados: Cadeia de caracteres
ContactMedium.mediumType	Tipo de meio de contato, como endereço de e-mail, número de telefone ou endereço postal. Tipo de dados: Cadeia de caracteres
ContactMedium.CEP	CEP do solicitante da cotação. Tipo de dados: Cadeia de caracteres
ContactMedium.stateOrProvince	Estado ou província no qual o solicitante de cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.street	Endereço do solicitante da cotação. Tipo de dados: Cadeia de caracteres
ContactMedium. Em tipo	Tipo de mídia de acordo com o padrão de API aberta do TMF. Por exemplo, `EndereçoGeographicalContactMedium` . Tipo de dados: Cadeia de caracteres
descrição	Descrição da cotação. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações associadas à cotação. Tipo de dados: Matriz `"note": [ { "text": "String", "@type": "String" } ]`
note.text	Conteúdo da anotação. Tipo de dados: Cadeia de caracteres
tipo. em	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
QuoteDate	Data e hora em que a cotação foi criada. Tipo de dados: Cadeia de caracteres
QuoteItem	Uma lista de itens de cotação. Cada item de cotação descreve uma ação para um produto a ser cotado. `"quoteItem": [ { "action": "String", "id": "String", "product": {Object}, "productOffering": {Object}, "productRelationship": {Object}, "quantity": Number, "state": "String", "@type": "String" } ]` Tipo de dados: Matriz de objetos
QuoteItem.action	Ação a ser realizada neste item de cotação (adicionar, modificar, remover etc.). Tipo de dados: Cadeia de caracteres
QuoteItem.id	Sys_id do item de cotação. Tabela: Item de linha de cotação [sn_quote_mgmt_core_quote_line_item] Tipo de dados: Cadeia de caracteres
quoteItem.product	Lista de produtos incluídos na cotação. `"product": { "characteristic": "String", "specification": "String", "@type": "String" }` Tipo de dados: Objeto
quoteItem.product. Característica	Lista de características do produto. Tipo de dados: Matriz de objetos `"characteristic": [ { "id": "String", "name": "String", "@type": "String", "value": "String" } ]` Consulte Create product characteristics and characteristic options.
quoteItem.product. Característica.ID	Sys_id da característica do produto. Tabela: Característica da linha de cotação [sn_quote_mgmt_core_quote_line_characteric] Tipo de dados: Cadeia de caracteres
quoteItem.product. characteristic.name	Nome da característica do produto. Tipo de dados: Cadeia de caracteres
quoteItem.product. Característica. No tipo	Este valor é sempre `StringCharacterística` . Tipo de dados: Cadeia de caracteres
quoteItem.product. Característica.Valor	Valor da característica. Tipo de dados: Cadeia de caracteres
quoteItem.product. Especificação	Descrição detalhada de um objeto tangível ou incorpóreo disponibilizado externamente na forma de um ProductOffering para clientes ou outras partes que desempenham um papel de parte. Tipo de dados: Cadeia de caracteres
quoteItem.product.@type	Este valor é sempre `Produto` . Tipo de dados: Cadeia de caracteres
quoteItem.productOffering	Uma referência de oferta de produto (ProductOfferingRef). Uma oferta de produto representa entidades que podem ser solicitadas do provedor do catálogo. `"productOffering": { "href": "String", "name": "String", "name": "String", "@type": "String" }` Tipo de dados: Objeto
QuoteItem. ProductOffering.href	Referência da entidade relacionada. Tipo de dados: Cadeia de caracteres
QuoteItem. ProductOffering.id	Sys_id da oferta de produto. Tabela: Oferta de produto [sn_prd_pm_product_offering] Tipo de dados: Cadeia de caracteres
QuoteItem. productOffering.name	Nome da entidade relacionada. Tipo de dados: Cadeia de caracteres
QuoteItem. ProductOffering. No tipo	Este valor é sempre `OfertaProdutoRef` . Tipo de dados: Cadeia de caracteres
quoteItem.productRelationship	Uma lista de itens de cotação. Cada item de cotação descreve uma ação para um produto a ser cotado. `"productRelationship": [ { "product": "String", "relationshipType": "String" } ]` Tipo de dados: Matriz de objetos
quoteItem.productRelationship. Produto	Uma referência ou valor de produto (ProductRefOrValue). Um produto a ser criado definido por valor ou existente definido por referência. O produto atende a um dos seguintes critérios: Criação de produto pendente definida pelo valor. Produto existente definido por referência. Tipo de dados: Cadeia de caracteres
quoteItem.productRelationship. RelationshipType	Tipo de relacionamento do produto, como `pacote` se o produto for um pacote e você quiser descrever os produtos agrupados em. Tipo de dados: Cadeia de caracteres
QuoteItem.Quantidade	Quantidade solicitada para este item de cotação. Tipo de dados: Número
QuoteItem.state	Um tipo de estado de cotação (QuoteStateType). Estado da cotação. Tipo de dados: Cadeia de caracteres
QuoteItem. No tipo	Este valor é sempre `QuoteItem` . Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String", "@type": "String" } ]`
IdentidadeRelatedParty.id	Sys_id da tabela de cotação para obter a conta, o contato ou o cliente. Tabela: Quote [sn_quote_mgmt_core_quote] Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
RelatedParty.role	A função da parte no contexto da cotação (por exemplo, Conta, Contato ou Cliente). Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Este valor é sempre `OfertaProdutoRef` . Tipo de dados: Cadeia de caracteres
estado	Estado do item de cotação. Tipo de dados: Cadeia de caracteres
.	Tipo de recurso. Este valor é sempre `Cotação` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo mostra como atualizar uma cotação.

curl "https://k8s0747687-node1.thunder.devsnc.com/api/sn_tmf_api/quote_management_api/quote/cb15734fd5692a10f8774663edf0ac19" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"@type\": \"Quote\",
  \"description\": \"Quote for Internet and OTT Bundle\",
  \"contactMedium\": [
    {
      \"@type\": \"GeographicalAddressContactMedium\",
      \"mediumType\": \"ShippingAddressRef\",
      \"locationId\": \"25ab96060a0a0bb300a6d66ce72095f2\",
      \"city\": \"Santa Clara\",
      \"country\": \"USA\",
      \"postCode\": \"95050\",
      \"stateOrProvince\": \"CA\",
      \"street\": \"2866 Stevens Creek Blvd\"
    }
  ],
  \"note\": [
    {
      \"@type\": \"Note\",
      \"text\": \"This is a quote request following today call\"
    }
  ],
  \"quoteItem\": [
    {
      \"id\": \"086be79bd5e1aa10f8774663edf0acba\",
      \"@type\": \"QuoteItem\",
      \"action\": \"add\",
      \"quantity\": \"1\",
      \"state\": \"Draft\",
      \"product\": {
        \"@type\": \"Product\"
      },
      \"productOffering\": {
        \"id\": \"ffeb447211bc3110f877366201dea6df\",
        \"name\": \"Internet and OTT Bundle\",
        \"@type\": \"ProductOfferingRef\"
      },
      \"productRelationship\": [
        {
          \"product\": \"597bab9bd5e1aa10f8774663edf0ac1b\",
          \"relationshipType\": \"HasChild\"
        },
        {
          \"product\": \"d57bab9bd5e1aa10f8774663edf0ac1a\",
          \"relationshipType\": \"HasChild\"
        },
        {
          \"product\": \"d57bab9bd5e1aa10f8774663edf0ac1c\",
          \"relationshipType\": \"HasChild\"
        }
      ]
    },
    {
      \"id\": \"d57bab9bd5e1aa10f8774663edf0ac1a\",
      \"@type\": \"QuoteItem\",
      \"action\": \"add\",
      \"quantity\": \"1\",
      \"state\": \"Draft\",
      \"product\": {
        \"@type\": \"Product\"
      },
      \"productOffering\": {
        \"id\": \"0761dd9fd0a63110f8770dbf976be173\",
        \"name\": \"Solana Modem N Series\",
        \"@type\": \"ProductOfferingRef\"
      },
      \"productRelationship\": [
        {
          \"product\": \"086be79bd5e1aa10f8774663edf0acba\",
          \"relationshipType\": \"HasParent\"
        }
      ]
    },
    {
      \"id\": \"597bab9bd5e1aa10f8774663edf0ac1b\",
      \"@type\": \"QuoteItem\",
      \"action\": \"add\",
      \"quantity\": \"1\",
      \"state\": \"Draft\",
      \"product\": {
        \"@type\": \"Product\"
      },
      \"productOffering\": {
        \"id\": \"8b61dd9fd0a63110f8770dbf976be140\",
        \"name\": \"Basic internet - 100 Mbps Plan\",
        \"@type\": \"ProductOfferingRef\"
      },
      \"productRelationship\": [
        {
          \"product\": \"086be79bd5e1aa10f8774663edf0acba\",
          \"relationshipType\": \"HasParent\"
        }
      ]
    },
    {
      \"id\": \"d57bab9bd5e1aa10f8774663edf0ac1c\",
      \"@type\": \"QuoteItem\",
      \"action\": \"add\",
      \"quantity\": \"1\",
      \"state\": \"Draft\",
      \"product\": {
        \"@type\": \"Product\"
      },
      \"productOffering\": {
        \"id\": \"62619d9fd0a63110f8770dbf976be180\",
        \"name\": \"Solana Movie streaming channel\",
        \"@type\": \"ProductOfferingRef\"
      },
      \"productRelationship\": [
        {
          \"product\": \"086be79bd5e1aa10f8774663edf0acba\",
          \"relationshipType\": \"HasParent\"
        }
      ]
    },
    {
      \"id\": \"797ca71fd5e1aa10f8774663edf0ac2b\",
      \"@type\": \"QuoteItem\",
      \"action\": \"add\",
      \"quantity\": \"1\",
      \"state\": \"Draft\",
      \"product\": {
        \"@type\": \"Product\",
        \"productCharacteristic\": [
          {
            \"name\": \"Internet breakout\",
            \"value\": \"No\"
          },
          {
            \"name\": \"Quality of Service\",
            \"value\": \"Basic\"
          },
          {
            \"name\": \"Speed\",
            \"value\": \"High\"
          }
        ],
        \"productSpecification\": {
          \"id\": \"cd81594e74ae4a10f877468e695efa81\",
          \"name\": \"VPN Site PS\",
          \"@type\": \"ProductSpecificationRef\"
        }
      },
      \"productOffering\": {
        \"id\": \"6c3d1e86a5e20210f8774c9b4be6ce42\",
        \"name\": \"VPN Site\",
        \"@type\": \"ProductOfferingRef\"
      },
      \"productRelationship\": [
        {
          \"product\": \"7f8c6b1fd5e1aa10f8774663edf0ac71\",
          \"relationshipType\": \"HasChild\"
        },
        {
          \"product\": \"bb8c6b1fd5e1aa10f8774663edf0ac73\",
          \"relationshipType\": \"HasChild\"
        },
        {
          \"product\": \"bf8c6b1fd5e1aa10f8774663edf0ac70\",
          \"relationshipType\": \"HasChild\"
        },
        {
          \"product\": \"fb8c6b1fd5e1aa10f8774663edf0ac72\",
          \"relationshipType\": \"HasChild\"
        }
      ]
    },
    {
      \"id\": \"bf8c6b1fd5e1aa10f8774663edf0ac70\",
      \"@type\": \"QuoteItem\",
      \"action\": \"add\",
      \"quantity\": \"1\",
      \"state\": \"Draft\",
      \"product\": {
        \"@type\": \"Product\"
      },
      \"productOffering\": {
        \"id\": \"2c265d4274ee4a10f877468e695efa45\",
        \"name\": \"Maintenance Fee\",
        \"@type\": \"ProductOfferingRef\"
      },
      \"productRelationship\": [
        {
          \"product\": \"797ca71fd5e1aa10f8774663edf0ac2b\",
          \"relationshipType\": \"HasParent\"
        }
      ]
    },
    {
      \"id\": \"7f8c6b1fd5e1aa10f8774663edf0ac71\",
      \"@type\": \"QuoteItem\",
      \"action\": \"add\",
      \"quantity\": \"1\",
      \"state\": \"Draft\",
      \"product\": {
        \"@type\": \"Product\"
      },
      \"productOffering\": {
        \"id\": \"4466d50674ee4a10f877468e695efa0d\",
        \"name\": \"Security Fee\",
        \"@type\": \"ProductOfferingRef\"
      },
      \"productRelationship\": [
        {
          \"product\": \"797ca71fd5e1aa10f8774663edf0ac2b\",
          \"relationshipType\": \"HasParent\"
        }
      ]
    },
    {
      \"id\": \"fb8c6b1fd5e1aa10f8774663edf0ac72\",
      \"@type\": \"QuoteItem\",
      \"action\": \"add\",
      \"quantity\": \"1\",
      \"state\": \"Draft\",
      \"product\": {
        \"@type\": \"Product\",
        \"productCharacteristic\": [
          {
            \"name\": \"Speed\",
            \"value\": \"High\"
          },
          {
            \"name\": \"Internet breakout\",
            \"value\": \"No\"
          }
        ],
        \"productSpecification\": {
          \"id\": \"ee4f8d8a74ae4a10f877468e695efa3f\",
          \"name\": \"VPN Endpoint PS\",
          \"@type\": \"ProductSpecificationRef\"
        }
      },
      \"productOffering\": {
        \"id\": \"7acc9e46a5e20210f8774c9b4be6ce9e\",
        \"name\": \"VPN Endpoint\",
        \"@type\": \"ProductOfferingRef\"
      },
      \"productRelationship\": [
        {
          \"product\": \"797ca71fd5e1aa10f8774663edf0ac2b\",
          \"relationshipType\": \"HasParent\"
        }
      ]
    },
    {
      \"id\": \"bb8c6b1fd5e1aa10f8774663edf0ac73\",
      \"@type\": \"QuoteItem\",
      \"action\": \"add\",
      \"quantity\": \"1\",
      \"state\": \"Draft\",
      \"product\": {
        \"@type\": \"Product\",
        \"productCharacteristic\": [
          {
            \"name\": \"Quality of Service\",
            \"value\": \"Basic\"
          }
        ],
        \"productSpecification\": {
          \"id\": \"3ba0914e74ae4a10f877468e695efa6e\",
          \"name\": \"VPN Firewall PS\",
          \"@type\": \"ProductSpecificationRef\"
        }
      },
      \"productOffering\": {
        \"id\": \"4407d90674ee4a10f877468e695efaab\",
        \"name\": \"VPN Firewall\",
        \"@type\": \"ProductOfferingRef\"
      },
      \"productRelationship\": [
        {
          \"product\": \"797ca71fd5e1aa10f8774663edf0ac2b\",
          \"relationshipType\": \"HasParent\"
        }
      ]
    }
  ],
  \"relatedParty\": [
    {
      \"role\": \"Customer\",
      \"id\": \"9e2fd2ee11b43110f877366201dea674\",
      \"name\": \"Startech svcs\",
      \"@type\": \"RelatedPartyRef\",
      \"@referredType\": \"Organization\"
    }
  ],
  \"state\": \"Draft\"
}" \
--user 'userName':'password'

Corpo da resposta.

{
  "@type": "Quote",
  "description": "Quote for Internet and OTT Bundle",
  "contactMedium": [
    {
      "@type": "GeographicalAddressContactMedium",
      "mediumType": "ShippingAddressRef",
      "locationId": "25ab96060a0a0bb300a6d66ce72095f2",
      "city": "Santa Clara",
      "country": "USA",
      "postCode": "95050",
      "stateOrProvince": "CA",
      "street": "2866 Stevens Creek Blvd"
    }
  ],
  "note": [
    {
      "@type": "Note",
      "text": "This is a quote request following today call"
    }
  ],
  "quoteItem": [
    {
      "id": "086be79bd5e1aa10f8774663edf0acba",
      "@type": "QuoteItem",
      "action": "add",
      "quantity": "1",
      "state": "Draft",
      "product": {
        "@type": "Product"
      },
      "productOffering": {
        "id": "ffeb447211bc3110f877366201dea6df",
        "name": "Internet and OTT Bundle",
        "@type": "ProductOfferingRef"
      },
      "productRelationship": [
        {
          "product": "597bab9bd5e1aa10f8774663edf0ac1b",
          "relationshipType": "HasChild"
        },
        {
          "product": "d57bab9bd5e1aa10f8774663edf0ac1a",
          "relationshipType": "HasChild"
        },
        {
          "product": "d57bab9bd5e1aa10f8774663edf0ac1c",
          "relationshipType": "HasChild"
        }
      ]
    },
    {
      "id": "d57bab9bd5e1aa10f8774663edf0ac1a",
      "@type": "QuoteItem",
      "action": "add",
      "quantity": "1",
      "state": "Draft",
      "product": {
        "@type": "Product"
      },
      "productOffering": {
        "id": "0761dd9fd0a63110f8770dbf976be173",
        "name": "Solana Modem N Series",
        "@type": "ProductOfferingRef"
      },
      "productRelationship": [
        {
          "product": "086be79bd5e1aa10f8774663edf0acba",
          "relationshipType": "HasParent"
        }
      ]
    },
    {
      "id": "597bab9bd5e1aa10f8774663edf0ac1b",
      "@type": "QuoteItem",
      "action": "add",
      "quantity": "1",
      "state": "Draft",
      "product": {
        "@type": "Product"
      },
      "productOffering": {
        "id": "8b61dd9fd0a63110f8770dbf976be140",
        "name": "Basic internet - 100 Mbps Plan",
        "@type": "ProductOfferingRef"
      },
      "productRelationship": [
        {
          "product": "086be79bd5e1aa10f8774663edf0acba",
          "relationshipType": "HasParent"
        }
      ]
    },
    {
      "id": "d57bab9bd5e1aa10f8774663edf0ac1c",
      "@type": "QuoteItem",
      "action": "add",
      "quantity": "1",
      "state": "Draft",
      "product": {
        "@type": "Product"
      },
      "productOffering": {
        "id": "62619d9fd0a63110f8770dbf976be180",
        "name": "Solana Movie streaming channel",
        "@type": "ProductOfferingRef"
      },
      "productRelationship": [
        {
          "product": "086be79bd5e1aa10f8774663edf0acba",
          "relationshipType": "HasParent"
        }
      ]
    },
    {
      "id": "797ca71fd5e1aa10f8774663edf0ac2b",
      "@type": "QuoteItem",
      "action": "add",
      "quantity": "1",
      "state": "Draft",
      "product": {
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "Internet breakout",
            "value": "No"
          },
          {
            "name": "Quality of Service",
            "value": "Basic"
          },
          {
            "name": "Speed",
            "value": "High"
          }
        ],
        "productSpecification": {
          "id": "cd81594e74ae4a10f877468e695efa81",
          "name": "VPN Site PS",
          "@type": "ProductSpecificationRef"
        }
      },
      "productOffering": {
        "id": "6c3d1e86a5e20210f8774c9b4be6ce42",
        "name": "VPN Site",
        "@type": "ProductOfferingRef"
      },
      "productRelationship": [
        {
          "product": "7f8c6b1fd5e1aa10f8774663edf0ac71",
          "relationshipType": "HasChild"
        },
        {
          "product": "bb8c6b1fd5e1aa10f8774663edf0ac73",
          "relationshipType": "HasChild"
        },
        {
          "product": "bf8c6b1fd5e1aa10f8774663edf0ac70",
          "relationshipType": "HasChild"
        },
        {
          "product": "fb8c6b1fd5e1aa10f8774663edf0ac72",
          "relationshipType": "HasChild"
        }
      ]
    },
    {
      "id": "bf8c6b1fd5e1aa10f8774663edf0ac70",
      "@type": "QuoteItem",
      "action": "add",
      "quantity": "1",
      "state": "Draft",
      "product": {
        "@type": "Product"
      },
      "productOffering": {
        "id": "2c265d4274ee4a10f877468e695efa45",
        "name": "Maintenance Fee",
        "@type": "ProductOfferingRef"
      },
      "productRelationship": [
        {
          "product": "797ca71fd5e1aa10f8774663edf0ac2b",
          "relationshipType": "HasParent"
        }
      ]
    },
    {
      "id": "7f8c6b1fd5e1aa10f8774663edf0ac71",
      "@type": "QuoteItem",
      "action": "add",
      "quantity": "1",
      "state": "Draft",
      "product": {
        "@type": "Product"
      },
      "productOffering": {
        "id": "4466d50674ee4a10f877468e695efa0d",
        "name": "Security Fee",
        "@type": "ProductOfferingRef"
      },
      "productRelationship": [
        {
          "product": "797ca71fd5e1aa10f8774663edf0ac2b",
          "relationshipType": "HasParent"
        }
      ]
    },
    {
      "id": "fb8c6b1fd5e1aa10f8774663edf0ac72",
      "@type": "QuoteItem",
      "action": "add",
      "quantity": "1",
      "state": "Draft",
      "product": {
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "Speed",
            "value": "High"
          },
          {
            "name": "Internet breakout",
            "value": "No"
          }
        ],
        "productSpecification": {
          "id": "ee4f8d8a74ae4a10f877468e695efa3f",
          "name": "VPN Endpoint PS",
          "@type": "ProductSpecificationRef"
        }
      },
      "productOffering": {
        "id": "7acc9e46a5e20210f8774c9b4be6ce9e",
        "name": "VPN Endpoint",
        "@type": "ProductOfferingRef"
      },
      "productRelationship": [
        {
          "product": "797ca71fd5e1aa10f8774663edf0ac2b",
          "relationshipType": "HasParent"
        }
      ]
    },
    {
      "id": "bb8c6b1fd5e1aa10f8774663edf0ac73",
      "@type": "QuoteItem",
      "action": "add",
      "quantity": "1",
      "state": "Draft",
      "product": {
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "Quality of Service",
            "value": "Basic"
          }
        ],
        "productSpecification": {
          "id": "3ba0914e74ae4a10f877468e695efa6e",
          "name": "VPN Firewall PS",
          "@type": "ProductSpecificationRef"
        }
      },
      "productOffering": {
        "id": "4407d90674ee4a10f877468e695efaab",
        "name": "VPN Firewall",
        "@type": "ProductOfferingRef"
      },
      "productRelationship": [
        {
          "product": "797ca71fd5e1aa10f8774663edf0ac2b",
          "relationshipType": "HasParent"
        }
      ]
    }
  ],
  "relatedParty": [
    {
      "role": "Customer",
      "id": "9e2fd2ee11b43110f877366201dea674",
      "name": "Startech svcs",
      "@type": "RelatedPartyRef",
      "@referredType": "Organization"
    }
  ],
  "state": "Draft",
  "id": "cb15734fd5692a10f8774663edf0ac19",
  "version": "2",
  "quoteDate": "2025-05-21 04:56:50",
  "href": "api/sn_tmf_api/quote_management_api/quote/cb15734fd5692a10f8774663edf0ac19"
}

API de gestão de cotações - POST /sn_tmf_api/quote_management_api/quote

Cria uma cotação.

Novos registros de cotação são criados nas seguintes tabelas:

Cotação [sn_quote_mgmt_core_quote]
Acordo de vendas [sn_sales_agmt_core_sales_agreement]
Item de linha de cotação [sn_quote_mgmt_core_quote_line_item]
Característica da linha de cotação [sn_quote_mgmt_core_quote_line_characteric]
Ajuste de preço de cotação [sn_quote_mgmt_core_pricing_adjustment]

Formato de URL

URL com controle de versão: /api/sn_tmf_api//quote_management_api/quote

URL padrão: /api/sn_tmf_api/quote_management_api/quote

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. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
ContactMedium	Lista de meios de contato. Informações de contato relacionadas ao solicitante da cotação. `"contactMedium": [ { "city": "String", "country": "String", "locationId": "String", "mediumType": "String", "postCode": "String", "stateOrProvince": "String", "street": "String", "@type": "String" } ]`
ContactMedium.city	Cidade na qual o solicitante da cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.country	País no qual o solicitante da cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.locationId	Sys_id do local listado na tabela Local [cmn_location] ou endereço personalizado. Tipo de dados: Cadeia de caracteres
ContactMedium.mediumType	Tipo de meio de contato, como endereço de e-mail, número de telefone ou endereço postal. Tipo de dados: Cadeia de caracteres
ContactMedium.CEP	CEP do solicitante da cotação. Tipo de dados: Cadeia de caracteres
ContactMedium.stateOrProvince	Estado ou província no qual o solicitante de cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.street	Endereço do solicitante da cotação. Tipo de dados: Cadeia de caracteres
ContactMedium. Em tipo	Tipo de mídia de acordo com o padrão de API aberta do TMF. Por exemplo, `EndereçoGeographicalContactMedium` . Tipo de dados: Cadeia de caracteres
descrição	Descrição da cotação. Tipo de dados: Cadeia de caracteres
externalId	ID exclusivo fornecido pelo consumidor para a cotação. Tipo de dados: Cadeia de caracteres
href	Link relativo para acessar a cotação. Tipo de dados: Cadeia de caracteres Cadeia de caracteres vazia
observação	Lista de anotações associadas à cotação. Tipo de dados: Matriz `"note": [ { "text": "String", "@type": "String" } ]`
note.text	Conteúdo da anotação. Tipo de dados: Cadeia de caracteres
tipo. em	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
QuoteDate	Data e hora em que a cotação foi criada. Tipo de dados: Cadeia de caracteres
QuoteItem	Uma lista de itens de cotação. Cada item de cotação descreve uma ação para um produto a ser cotado. `"quoteItem": [ { "action": "String", "id": "String", "product": {Object}, "productOffering": {Object}, "productRelationship": {Object}, "quantity": Number, "state": "String", "@type": "String" } ]` Tipo de dados: Matriz de objetos
QuoteItem.action	Ação a ser realizada neste item de cotação (adicionar, modificar, remover etc.). Tipo de dados: Cadeia de caracteres
quoteItem.id	Sys_id do item de cotação. Tabela: Item de linha de cotação [sn_quote_mgmt_core_quote_line_item] Tipo de dados: Cadeia de caracteres
quoteItem.product	Lista de produtos incluídos na cotação. `"product": { "characteristic": "String", "specification": "String", "@type": "String" }` Tipo de dados: Objeto
quoteItem.product. Característica	Lista de características do produto. Tipo de dados: Matriz de objetos `"characteristic": [ { "id": "String", "name": "String", "@type": "String", "value": "String" } ]` Consulte Create product characteristics and characteristic options.
quoteItem.product. Característica.ID	Sys_id da característica do produto. Tabela: Característica da linha de cotação [sn_quote_mgmt_core_quote_line_characteric] Tipo de dados: Cadeia de caracteres
quoteItem.product. characteristic.name	Nome da característica do produto. Tipo de dados: Cadeia de caracteres
quoteItem.product. Característica. No tipo	Este valor é sempre `StringCharacterística` . Tipo de dados: Cadeia de caracteres
quoteItem.product. Característica.Valor	Valor da característica. Tipo de dados: Cadeia de caracteres
quoteItem.product. Especificação	Descrição detalhada de um objeto tangível ou incorpóreo disponibilizado externamente na forma de um ProductOffering para clientes ou outras partes que desempenham um papel de parte. Tipo de dados: Cadeia de caracteres
quoteItem.product.@type	Este valor é sempre `Produto` . Tipo de dados: Cadeia de caracteres
quoteItem.productOffering	Uma referência de oferta de produto (ProductOfferingRef). Uma oferta de produto representa entidades que podem ser solicitadas do provedor do catálogo. `"productOffering": { "href": "String", "name": "String", "name": "String", "@type": "String" }` Tipo de dados: Objeto
QuoteItem. ProductOffering.href	Referência da entidade relacionada. Tipo de dados: Cadeia de caracteres
QuoteItem. ProductOffering.id	Sys_id da oferta de produto. Tabela: Oferta de produto [sn_prd_pm_product_offering] Tipo de dados: Cadeia de caracteres
QuoteItem. productOffering.name	Nome da entidade relacionada. Tipo de dados: Cadeia de caracteres
QuoteItem. ProductOffering. No tipo	Este valor é sempre `OfertaProdutoRef` . Tipo de dados: Cadeia de caracteres
quoteItem.productRelationship	Uma lista de itens de cotação. Cada item de cotação descreve uma ação para um produto a ser cotado. `"productRelationship": [ { "product": "String", "relationshipType": "String" } ]` Tipo de dados: Matriz de objetos
quoteItem.productRelationship. Produto	Uma referência ou valor de produto (ProductRefOrValue). Um produto a ser criado definido por valor ou existente definido por referência. O produto atende a um dos seguintes critérios: Criação de produto pendente definida pelo valor. Produto existente definido por referência. Tipo de dados: Cadeia de caracteres
quoteItem.productRelationship. RelationshipType	Tipo de relacionamento do produto, como `pacote` se o produto for um pacote e você quiser descrever os produtos agrupados em. Tipo de dados: Cadeia de caracteres
QuoteItem.Quantidade	Quantidade solicitada para este item de cotação. Tipo de dados: Número
QuoteItem.state	Um tipo de estado de cotação (QuoteStateType). Estado da cotação. Tipo de dados: Cadeia de caracteres
QuoteItem. No tipo	Este valor é sempre `QuoteItem` . Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String", "@type": "String" } ]`
relatedParty.id	Sys_id da tabela de cotação para obter a conta, o contato ou o cliente. Tabela: Quote [sn_quote_mgmt_core_quote] Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
RelatedParty.role	A função da parte no contexto da cotação (por exemplo, Conta, Contato ou Cliente). Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Este valor é sempre `OfertaProdutoRef` . Tipo de dados: Cadeia de caracteres
estado	Estado do item de cotação. Tipo de dados: Cadeia de caracteres
.	Tipo de recurso. Este valor é sempre `Cotação` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Cabeçalhos

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.

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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 30. Códigos de status
Código do status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Possíveis motivos: Carga vazia. Carga inválida. Campo obrigatório ausente: <field name>.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
ContactMedium	Lista de meios de contato. Informações de contato relacionadas ao solicitante da cotação. `"contactMedium": [ { "city": "String", "country": "String", "locationId": "String", "mediumType": "String", "postCode": "String", "stateOrProvince": "String", "street": "String", "@type": "String" } ]`
ContactMedium.city	Cidade na qual o solicitante da cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.country	País no qual o solicitante da cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.locationId	Sys_id do local listado na tabela Local [cmn_location] ou endereço personalizado. Tipo de dados: Cadeia de caracteres
ContactMedium.mediumType	Tipo de meio de contato, como endereço de e-mail, número de telefone ou endereço postal. Tipo de dados: Cadeia de caracteres
ContactMedium.CEP	CEP do solicitante da cotação. Tipo de dados: Cadeia de caracteres
ContactMedium.stateOrProvince	Estado ou província no qual o solicitante de cotação reside. Tipo de dados: Cadeia de caracteres
ContactMedium.street	Endereço do solicitante da cotação. Tipo de dados: Cadeia de caracteres
ContactMedium. Em tipo	Tipo de mídia de acordo com o padrão de API aberta do TMF. Por exemplo, `EndereçoGeographicalContactMedium` . Tipo de dados: Cadeia de caracteres
descrição	Descrição da cotação. Tipo de dados: Cadeia de caracteres
externalId	ID exclusivo fornecido pelo consumidor para a cotação. Tipo de dados: Cadeia de caracteres
href	Link relativo para acessar a cotação. Tipo de dados: Cadeia de caracteres Cadeia de caracteres vazia
observação	Lista de anotações associadas à cotação. Tipo de dados: Matriz `"note": [ { "text": "String", "@type": "String" } ]`
note.text	Conteúdo da anotação. Tipo de dados: Cadeia de caracteres
tipo. em	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
QuoteDate	Data e hora em que a cotação foi criada. Tipo de dados: Cadeia de caracteres
QuoteItem	Uma lista de itens de cotação. Cada item de cotação descreve uma ação para um produto a ser cotado. `"quoteItem": [ { "action": "String", "id": "String", "product": {Object}, "productOffering": {Object}, "productRelationship": {Object}, "quantity": Number, "state": "String", "@type": "String" } ]` Tipo de dados: Matriz de objetos
QuoteItem.action	Ação a ser realizada neste item de cotação (adicionar, modificar, remover etc.). Tipo de dados: Cadeia de caracteres
QuoteItem.id	Sys_id do item de cotação. Tabela: Item de linha de cotação [sn_quote_mgmt_core_quote_line_item] Tipo de dados: Cadeia de caracteres
quoteItem.product	Lista de produtos incluídos na cotação. `"product": { "characteristic": "String", "specification": "String", "@type": "String" }` Tipo de dados: Objeto
quoteItem.product. Característica	Lista de características do produto. Tipo de dados: Matriz de objetos `"characteristic": [ { "id": "String", "name": "String", "@type": "String", "value": "String" } ]` Consulte Create product characteristics and characteristic options.
quoteItem.product. Característica.ID	Sys_id da característica do produto. Tabela: Característica da linha de cotação [sn_quote_mgmt_core_quote_line_characteric] Tipo de dados: Cadeia de caracteres
quoteItem.product. characteristic.name	Nome da característica do produto. Tipo de dados: Cadeia de caracteres
quoteItem.product. Característica. No tipo	Este valor é sempre `StringCharacterística` . Tipo de dados: Cadeia de caracteres
quoteItem.product. Característica.Valor	Valor da característica. Tipo de dados: Cadeia de caracteres
quoteItem.product. Especificação	Descrição detalhada de um objeto tangível ou incorpóreo disponibilizado externamente na forma de um ProductOffering para clientes ou outras partes que desempenham um papel de parte. Tipo de dados: Cadeia de caracteres
quoteItem.product.@type	Este valor é sempre `Produto` . Tipo de dados: Cadeia de caracteres
quoteItem.productOffering	Uma referência de oferta de produto (ProductOfferingRef). Uma oferta de produto representa entidades que podem ser solicitadas do provedor do catálogo. `"productOffering": { "href": "String", "name": "String", "name": "String", "@type": "String" }` Tipo de dados: Objeto
QuoteItem. ProductOffering.href	Referência da entidade relacionada. Tipo de dados: Cadeia de caracteres
QuoteItem. ProductOffering.id	Sys_id da oferta de produto. Tabela: Oferta de produto [sn_prd_pm_product_offering] Tipo de dados: Cadeia de caracteres
QuoteItem. productOffering.name	Nome da entidade relacionada. Tipo de dados: Cadeia de caracteres
QuoteItem. ProductOffering. No tipo	Este valor é sempre `OfertaProdutoRef` . Tipo de dados: Cadeia de caracteres
quoteItem.productRelationship	Uma lista de itens de cotação. Cada item de cotação descreve uma ação para um produto a ser cotado. `"productRelationship": [ { "product": "String", "relationshipType": "String" } ]` Tipo de dados: Matriz de objetos
quoteItem.productRelationship. Produto	Uma referência ou valor de produto (ProductRefOrValue). Um produto a ser criado definido por valor ou existente definido por referência. O produto atende a um dos seguintes critérios: Criação de produto pendente definida pelo valor. Produto existente definido por referência. Tipo de dados: Cadeia de caracteres
quoteItem.productRelationship. RelationshipType	Tipo de relacionamento do produto, como `pacote` se o produto for um pacote e você quiser descrever os produtos agrupados em. Tipo de dados: Cadeia de caracteres
QuoteItem.Quantidade	Quantidade solicitada para este item de cotação. Tipo de dados: Número
QuoteItem.state	Um tipo de estado de cotação (QuoteStateType). Estado da cotação. Tipo de dados: Cadeia de caracteres
QuoteItem. No tipo	Este valor é sempre `QuoteItem` . Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String", "@type": "String" } ]`
IdentidadeRelatedParty.id	Sys_id da tabela de cotação para obter a conta, o contato ou o cliente. Tabela: Quote [sn_quote_mgmt_core_quote] Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
RelatedParty.role	A função da parte no contexto da cotação (por exemplo, Conta, Contato ou Cliente). Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Este valor é sempre `OfertaProdutoRef` . Tipo de dados: Cadeia de caracteres
estado	Estado do item de cotação. Tipo de dados: Cadeia de caracteres
.	Tipo de recurso. Este valor é sempre `Cotação` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

O exemplo a seguir mostra como criar uma cotação.

curl "http://localhost:8080/api/sn_tmf_api/quote_management_api/quote" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"@type\": \"Quote\",
  \"description\": \"Quote for Internet and OTT Bundle\",
  \"state\": \"Draft\",
  \"externalId\": \"12233\",
  \"contactMedium\": [
    {
      \"@type\": \"GeographicalAddressContactMedium\",
      \"mediumType\": \"ShippingAddressRef\",
      \"locationId\": \"6774fee611383110f877366201dea64f\",
      \"city\": \"Santa Clara\",
      \"country\": \"USA\",
      \"postCode\": \"95050\",
      \"stateOrProvince\": \"CA\",
      \"street\": \"2866 Stevens Creek Blvd\"
    }
  ],
  \"note\": [
    {
      \"@type\": \"Note\",
      \"text\": \"This is a quote request for the Internet and OTT Bundle\"
    }
  ],
  \"quoteItem\": [
    {
      \"id\": \"ea88d77c4165ae10f8776348db5f9196\",
      \"@type\": \"QuoteItem\",
      \"action\": \"add\",
      \"quantity\": \"1\",
      \"state\": \"Draft\",
      \"product\": {
        \"@type\": \"Product\"
      },
      \"productOffering\": {
        \"id\": \"ffeb447211bc3110f877366201dea6df\",
        \"href\": \"api/sn_tmf_api/catalogmanagement/productOffering/ffeb447211bc3110f877366201dea6df\",
        \"name\": \"Internet and OTT Bundle\",
        \"@type\": \"ProductOfferingRef\"
      },
      \"productRelationship\": [
        {
          \"product\": \"3688d77c4165ae10f8776348db5f91cf\",
          \"relationshipType\": \"HasChild\"
        },
        {
          \"product\": \"3a881b7c4165ae10f8776348db5f911b\",
          \"relationshipType\": \"HasChild\"
        },
        {
          \"product\": \"7e88d77c4165ae10f8776348db5f91fb\",
          \"relationshipType\": \"HasChild\"
        }
      ]
    },
    {
      \"id\": \"3688d77c4165ae10f8776348db5f91cf\",
      \"@type\": \"QuoteItem\",
      \"action\": \"add\",
      \"quantity\": \"1\",
      \"state\": \"Draft\",
      \"product\": {
        \"@type\": \"Product\"
      },
      \"productOffering\": {
        \"id\": \"0761dd9fd0a63110f8770dbf976be173\",
        \"href\": \"api/sn_tmf_api/catalogmanagement/productOffering/0761dd9fd0a63110f8770dbf976be173\",
        \"name\": \"Solana Modem N Series\",
        \"@type\": \"ProductOfferingRef\"
      },
      \"productRelationship\": [
        {
          \"product\": \"ea88d77c4165ae10f8776348db5f9196\",
          \"relationshipType\": \"HasParent\"
        }
      ]
    },
    {
      \"id\": \"7e88d77c4165ae10f8776348db5f91fb\",
      \"@type\": \"QuoteItem\",
      \"action\": \"add\",
      \"quantity\": \"1\",
      \"state\": \"Draft\",
      \"product\": {
        \"@type\": \"Product\"
      },
      \"productOffering\": {
        \"id\": \"8b61dd9fd0a63110f8770dbf976be140\",
        \"href\": \"api/sn_tmf_api/catalogmanagement/productOffering/8b61dd9fd0a63110f8770dbf976be140\",
        \"name\": \"Basic internet - 100 Mbps Plan\",
        \"@type\": \"ProductOfferingRef\"
      },
      \"productRelationship\": [
        {
          \"product\": \"ea88d77c4165ae10f8776348db5f9196\",
          \"relationshipType\": \"HasParent\"
        }
      ]
    },
    {
      \"id\": \"3a881b7c4165ae10f8776348db5f911b\",
      \"@type\": \"QuoteItem\",
      \"action\": \"add\",
      \"quantity\": \"1\",
      \"state\": \"Draft\",
      \"product\": {
        \"@type\": \"Product\"
      },
      \"productOffering\": {
        \"id\": \"62619d9fd0a63110f8770dbf976be180\",
        \"href\": \"api/sn_tmf_api/catalogmanagement/productOffering/62619d9fd0a63110f8770dbf976be180\",
        \"name\": \"Solana Movie streaming channel\",
        \"@type\": \"ProductOfferingRef\"
      },
      \"productRelationship\": [
        {
          \"product\": \"ea88d77c4165ae10f8776348db5f9196\",
          \"relationshipType\": \"HasParent\"
        }
      ]
    }
  ],
  \"relatedParty\": [
    {
      \"role\": \"Customer\",
      \"id\": \"ab9a0e8b2fc9a610b79db3bf42faf3a6\",
      \"name\": \"Funco Intl\",
      \"@type\": \"RelatedPartyRef\",
      \"@referredType\": \"Organization\"
    }
  ]
}" \
--user 'userName':'password'

Corpo da resposta.

{
  "@type": "Quote",
  "description": "Quote for Internet and OTT Bundle",
  "state": "Draft",
  "externalId": "12233",
  "contactMedium": [
    {
      "@type": "GeographicalAddressContactMedium",
      "mediumType": "ShippingAddressRef",
      "locationId": "6774fee611383110f877366201dea64f",
      "city": "Santa Clara",
      "country": "USA",
      "postCode": "95050",
      "stateOrProvince": "CA",
      "street": "2866 Stevens Creek Blvd"
    }
  ],
  "note": [
    {
      "@type": "Note",
      "text": "This is a quote request for the Internet and OTT Bundle"
    }
  ],
  "quoteItem": [
    {
      "id": "ea88d77c4165ae10f8776348db5f9196",
      "@type": "QuoteItem",
      "action": "add",
      "quantity": "1",
      "state": "Draft",
      "product": {
        "@type": "Product"
      },
      "productOffering": {
        "id": "ffeb447211bc3110f877366201dea6df",
        "href": "api/sn_tmf_api/catalogmanagement/productOffering/ffeb447211bc3110f877366201dea6df",
        "name": "Internet and OTT Bundle",
        "@type": "ProductOfferingRef",
        "internalVersion": "1",
        "version": "",
        "internalId": "ffeb447211bc3110f877366201dea6df"
      },
      "productRelationship": [
        {
          "product": "3688d77c4165ae10f8776348db5f91cf",
          "relationshipType": "HasChild"
        },
        {
          "product": "3a881b7c4165ae10f8776348db5f911b",
          "relationshipType": "HasChild"
        },
        {
          "product": "7e88d77c4165ae10f8776348db5f91fb",
          "relationshipType": "HasChild"
        }
      ]
    },
    {
      "id": "3688d77c4165ae10f8776348db5f91cf",
      "@type": "QuoteItem",
      "action": "add",
      "quantity": "1",
      "state": "Draft",
      "product": {
        "@type": "Product"
      },
      "productOffering": {
        "id": "0761dd9fd0a63110f8770dbf976be173",
        "href": "api/sn_tmf_api/catalogmanagement/productOffering/0761dd9fd0a63110f8770dbf976be173",
        "name": "Solana Modem N Series",
        "@type": "ProductOfferingRef",
        "internalVersion": "1",
        "version": "",
        "internalId": "0761dd9fd0a63110f8770dbf976be173"
      },
      "productRelationship": [
        {
          "product": "ea88d77c4165ae10f8776348db5f9196",
          "relationshipType": "HasParent"
        }
      ]
    },
    {
      "id": "7e88d77c4165ae10f8776348db5f91fb",
      "@type": "QuoteItem",
      "action": "add",
      "quantity": "1",
      "state": "Draft",
      "product": {
        "@type": "Product"
      },
      "productOffering": {
        "id": "8b61dd9fd0a63110f8770dbf976be140",
        "href": "api/sn_tmf_api/catalogmanagement/productOffering/8b61dd9fd0a63110f8770dbf976be140",
        "name": "Basic internet - 100 Mbps Plan",
        "@type": "ProductOfferingRef",
        "internalVersion": "1",
        "version": "",
        "internalId": "8b61dd9fd0a63110f8770dbf976be140"
      },
      "productRelationship": [
        {
          "product": "ea88d77c4165ae10f8776348db5f9196",
          "relationshipType": "HasParent"
        }
      ]
    },
    {
      "id": "3a881b7c4165ae10f8776348db5f911b",
      "@type": "QuoteItem",
      "action": "add",
      "quantity": "1",
      "state": "Draft",
      "product": {
        "@type": "Product"
      },
      "productOffering": {
        "id": "62619d9fd0a63110f8770dbf976be180",
        "href": "api/sn_tmf_api/catalogmanagement/productOffering/62619d9fd0a63110f8770dbf976be180",
        "name": "Solana Movie streaming channel",
        "@type": "ProductOfferingRef",
        "internalVersion": "1",
        "version": "",
        "internalId": "62619d9fd0a63110f8770dbf976be180"
      },
      "productRelationship": [
        {
          "product": "ea88d77c4165ae10f8776348db5f9196",
          "relationshipType": "HasParent"
        }
      ]
    }
  ],
  "relatedParty": [
    {
      "role": "Customer",
      "id": "ab9a0e8b2fc9a610b79db3bf42faf3a6",
      "name": "Funco Intl",
      "@type": "RelatedPartyRef",
      "@referredType": "Organization"
    }
  ],
  "id": "acc805bcfff5a610b79dffffffffffe6",
  "href": "api/sn_tmf_api/quote_management_api/quote/acc805bcfff5a610b79dffffffffffe6"
}