API de pedido de produto em aberto

Versão de lançamento: Zurich

Atualizado 31 de jul. de 2025

163 min. de leitura

. Pedido de produto em aberto A API fornece endpoints que permitem um mecanismo padronizado para fazer pedidos de produtos.

Um pedido de produto é criado com base em uma oferta de produto definida e publicada em um catálogo de produtos. A oferta de produto identifica o produto ou conjunto de produtos que estão disponíveis para um cliente e inclui as características relevantes do produto que capturam as opções exclusivas de um produto e outros atributos relevantes, como preço, termos de contrato e disponibilidade.

Para acessar esta API, o plug-in Gestão de pedidos para telecomunicações (sn_ind_tmt_orum) deve ser ativado.

Esta API é fornecida no sn_ind_tmt_orn namespace.

O usuário chamador deve ter a função sn_ind_tmt_orn.order_integrator.

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. Para obter mais informações, consulte. Guia do desenvolvedor de API aberta de pedido de produto .

. Pedido de produto em aberto A API é um ServiceNow® TMF622 Product Ordering Management API REST Specification e é certificado de conformidade pelo TM Forum.

Logotipo de conformidade da TMF

API de pedido de produto em aberto - OBTER /sn_ind_tmt_orn/order/productOrder

Recupera todos os pedidos de produtos.

Este endpoint recupera informações do pedido das seguintes tabelas:

Pedido do cliente [sn_ind_tmt_orn_order]
Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
Ordem de característica [sn_ind_tmt_orn_order_characteric_value]
Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]
Itens relacionados à linha de pedido [sn_ind_tmt_orn_order_line_related_items]

Formato de URL

URL padrão: /api/sn_ind_tmt_orn/order/productOrder

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
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Tipo de dados: Cadeia de caracteres Padrão: Todos os campos retornados.
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
estado	Filtrar pedidos por estado. Somente pedidos com um estado correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: Cadeia de caracteres Padrão: Não ordenar por estado.

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
Nenhum(a)

Tabela 5. 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 6. 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
canal	Lista de canais a serem usados para vender os produtos. Tipo de dados: Matriz de objetos `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificador exclusivo do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
channel.name	Nome do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
committedDueDate	Data e hora em que a ação deve ser executada no pedido. Este valor deve ser igual ou posterior a committedDueDatevalores para cada item de linha do pedido. Tipo de dados: Cadeia de caracteres
ExpectedCompletionDate	Data em que o pedido será concluído. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro do pedido do produto. Tipo de dados: Cadeia de caracteres
id	Sys_id do pedido do produto. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz de objetos `"note": [ { "author": "String", "date": "String", "text": "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	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres
OrderCurrency	Código da moeda do pedido e dos itens de linha do pedido. Tipo de dados: Cadeia de caracteres
ponr	Sinalizador que indica se o ponto sem retorno do pedido foi atingido. Valores possíveis: Verdadeiro: O ponto sem retorno do pedido foi atingido. Falso: O ponto sem retorno do pedido não foi atingido. Tipo de dados: Booliano
ProductOrderItem	Lista que descreve os itens associados ao pedido do produto e sua ação associada. Tipo de dados: Matriz de objetos `"productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
ProductOrderItem.action	Ação a ser realizada no produto. As ações possíveis são definidas na guia Lista de seleção na entrada Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Tipo de dados: Cadeia de caracteres
ProductOrderItem.actionMotivo	Motivo para adicionar o item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo action_reason da tabela sn_ind_tmt_orn_order_line_item.
productOrderItem.committedDueDate	Data e hora em que a ação deve ser executada no item de linha do pedido. Tipo de dados: Cadeia de caracteres
ProductOrderItem.externalProductInventory	Lista de IDs externos mapeados para os inventários de produtos criados para o pedido. Tipo de dados: Matriz de objetos `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
ProductOrderItem.externalProductInventory.externalProductInventoryId	ID externo mapeado para o inventário do produto. Tipo de dados: Cadeia de caracteres
productOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice	Lista que descreve o preço associado ao produto. Tipo de dados: Matriz de objetos `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Descrição do preço do produto associado. Tipo de dados: Objeto `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: Objeto `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Código da moeda no qual o preço é representado. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preço do produto, incluindo qualquer imposto. Tipo de dados: Número
productOrderItem.itemPrice.priceType	Tipo de preço do item, recorrente ou não recorrente. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.recurringChargePeriod	Se o preço for recorrente, o período recorrente, como `mês` . Tipo de dados: Cadeia de caracteres
ProductOrderItem.ponr	Sinalizador que indica se o ponto sem retorno do pedido foi atingido. Valores possíveis: Verdadeiro: O ponto sem retorno do pedido foi atingido. Falso: O ponto sem retorno do pedido não foi atingido. Tipo de dados: Booliano
productOrderItem.product	Descrição dos detalhes da instância do produto comprado pelo cliente. Tipo de dados: Objeto `"product:" { "place": {Object}, "productCharacteristic": [Array], "productRelationship": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	Mapas dos locais nos quais o produto será instalado. Tipo de dados: Objeto `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.place.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Lugar` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic	Lista de características do produto associado. Somente as características do produto cujos valuesão diferentes de previousValueretornados. Tipo de dados: Matriz de objetos `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica [sn_prd_pm_characteric]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para um pedido de mudança. A solicitação é uma ordem de mudança se productOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.value	Valores de opção de característica associados ao produto. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.valueType	Tipo de valor de característica. Valores possíveis: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Teste de linha única Caixa de seleção Escolha Data, Endereço E-mail Inteiro, Data/Hora Objeto Texto de Linha Única Sim/Não Tipo de dados: Cadeia de caracteres
productOrderItem.product.productRelationship	Lista de detalhes de relacionamento de produto para um item de linha de pedido. Tipo de dados: Matriz de objetos `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.product.productRelationship.id	Sys_id ou sn_prd_invt_external_id do inventário do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou sn_prd_invt_external_id da tabela Inventário de produto [sn_prd_invt_product_inventory].
productOrderItem.product.productRelationship.relationshipType	Tipo de relacionamento entre o item de linha do pedido e o inventário do produto. Valor possível: Requer Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification	Descrição da especificação do produto associada ao produto. Tipo de dados: Objeto `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id da especificação do produto. Initial_version é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.internalId	Versão inicial da especificação do produto. A versão inicial é o sys_id da primeira versão da especificação. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.internalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Especificação do produto [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.name	Nome da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.version	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.@type	Parte do padrão TMF Open API. Este valor é sempre `ProductSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty	Lista de contatos para itens de linha. Tipo de dados: Matriz de objetos `"relatedParty:" [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.firstName	Nome do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.id	Sys_id do contato do item de linha associado ao item de linha do pedido. Localizado na tabela Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.lastName	Sobrenome do contato. Tipo de dados: Cadeia de caracteres Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@referredType	Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering	Descrição da oferta de produto associada ao produto. Tipo de dados: Objeto `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id da oferta de produto. Initial_version é o sys_id da primeira versão da oferta. Localizado no campo sys_id ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.internalId	Versão inicial da oferta de produto. A versão inicial é o sys_id da primeira versão da oferta. Tipo de dados: Cadeia de caracteres Tabela: Oferta de produto [sn_prd_pm_product_offering]
productOrderItem.productOffering.internalVersion	Versão da oferta do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].
productOrderItem.productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.version	Versão externa da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].
ProductOrderItem.Quantidade	Número de itens de produto comprados. Tipo de dados: Número
productOrderItem.productOrderItemRelationship	Lista de relacionamentos entre itens de linha do pedido. Tipo de dados: Matriz de objetos `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOrderItemRelationship.relationshipType	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: HasChild HasParent Requer `HasChild` e. `HasParent` são usados para relacionamentos primário/secundário. `Requer` é usado para relacionamentos horizontais (um item de linha requer outro item de linha). Tipo de dados: Cadeia de caracteres
ProductOrderItem.state	Estado do pedido do item de produto associado. Tipo de dados: Cadeia de caracteres
ProductOrderItem.version	Versão do pedido. Tipo de dados: Cadeia de caracteres
ProductOrderItem. No tipo	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Deve listar pelo menos um item que contém informações da conta do cliente ou da conta do consumidor. Tipo de dados: Matriz de objetos `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. 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. Em	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
estado	Estado atual do pedido. Tipo de dados: Cadeia de caracteres
versão	Versão do pedido. Tipo de dados: Cadeia de caracteres
.	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrder` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo recupera todos os pedidos de produtos.

curl --location --request GET 'https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder' \
--user 'username':'password'

Corpo da resposta.

[
   {
      "id": "8d75939453126010a795ddeeff7b126a",
      "href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
      "ponr": "false",
      "orderCurrency": "USD",
      "expectedCompletionDate": "2021-05-02T08:13:59.000Z",
      "requestedCompletionDate": "2021-05-02T08:13:59.000Z",
      "requestedStartDate": "2020-05-03T08:13:59.000Z",
      "channel": [
         {
            "id": "1",
            "name": "Agent Assist"
         }
      ],
      "note": [
         {
            "author": "System Administrator",
            "date": "2021-02-25T14:22:07.000Z",
            "text": "This is a TMF product order illustration no 2"
         },
         {
            "author": "System Administrator",
            "date": "2021-02-25T14:22:06.000Z",
            "text": "This is a TMF product order illustration"
         }
      ],
      "productOrderItem": [
         {
            "id": "POI130",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "actionReason": "adding service package OLI",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "USD",
                        "value": 20
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productCharacteristic": [
                  {
                     "name": "Security Type",
                     "valueType": "Choice",
                     "value": "Base",
                     "previousValue": ""
                  }
               ],
               "productSpecification": {
                  "id": "a6514bd3534560102f18ddeeff7b1247",
                  "name": "SD-WAN Security",
                  "version": "v1",
                  "internalVersion": "1",
                  "internalId": "a6514bd3534560102f18ddeeff7b1247",
                  "@type": "ProductSpecificationRef"
               },
               "relatedParty": [
                  {
                     "id": "4175939453126010a795ddeeff7b127d",
                     "name": "John Smith",
                     "email": "abc2@example.com",
                     "phone": "32456768",
                     "@type": "RelatedParty",
                     "@referredType": "OrderLineItemContact"
                  },
                  {
                     "id": "c175939453126010a795ddeeff7b127c",
                     "name": "Joe Doe",
                     "email": "abc@example.com",
                     "phone": "1234567890",
                     "@type": "RelatedParty",
                     "@referredType": "OrderLineItemContact"
                  }
               ]
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering",
               "version": "v1",
               "internalId": "69017a0f536520103b6bddeeff7b127d",
               "internalVersion": "1"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI100",
                  "relationshipType": "HasParent"
               }
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         },
         {
            "id": "POI100",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productSpecification": {
                  "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
                  "name": "SD-WAN Service Package",
                  "version": "v1",
                  "internalVersion": "1",
                  "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
                  "@type": "ProductSpecificationRef"
               }
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering",
               "version": "v1",
               "internalId": "69017a0f536520103b6bddeeff7b127d",
               "internalVersion": "1"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI130",
                  "relationshipType": "HasChild"
               },
               {
                  "id": "POI120",
                  "relationshipType": "HasChild"
               },
               {
                  "id": "POI110",
                  "relationshipType": "HasChild"
               }
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         },
         {
            "id": "POI120",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "USD",
                        "value": 20
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productCharacteristic": [
                  {
                     "name": "CPE Type",
                     "valueType": "Choice",
                     "value": "Physical",
                     "previousValue": ""
                  },
                  {
                     "name": "WAN Optimization",
                     "valueType": "Choice",
                     "value": "Advance",
                     "previousValue": ""
                  },
                  {
                     "name": "Routing",
                     "valueType": "Choice",
                     "value": "Premium",
                     "previousValue": ""
                  },
                  {
                     "name": "CPE Model",
                     "valueType": "Choice",
                     "value": "ASR",
                     "previousValue": ""
                  }
               ],
               "productSpecification": {
                  "id": "39b627aa53702010cd6dddeeff7b1202",
                  "name": "SD-WAN Edge Device",
                  "version": "v1",
                  "internalVersion": "1",
                  "internalId": "39b627aa53702010cd6dddeeff7b1202",
                  "@type": "ProductSpecificationRef"
               },
               "productRelationship": [
                  {
                     "id": "326d13f45b5620102dff5e92dc81c785",
                     "relationshipType": "Requires"
                  }
               ]
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "69017a0f536520103b6bddeeff7b127d"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI100",
                  "relationshipType": "HasParent"
               },
               {
                  "id": "POI110",
                  "relationshipType": "Requires"
               }       
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         },
         {
            "id": "POI110",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "USD",
                        "value": 5
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productCharacteristic": [
                  {
                     "name": "Tenancy",
                     "valueType": "Choice",
                     "value": "Base (10 site)",
                     "previousValue": ""
                  }
               ],
               "productSpecification": {
                  "id": "216663aa53702010cd6dddeeff7b12b5",
                  "name": "SD-WAN Controller",
                  "version": "v1",
                  "internalVersion": "1",
                  "internalId": "216663aa53702010cd6dddeeff7b12b5",
                  "@type": "ProductSpecificationRef"
               },
               "place": {
                  "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                  "@type": "Place"
               }
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering",
               "version": "v1",
               "internalId": "69017a0f536520103b6bddeeff7b127d",
               "internalVersion": "1"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI100",
                  "relationshipType": "HasParent"
               }
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         }
      ],
      "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
      "state": "in_progress",
      "version": "1",
      "@type": "ProductOrder"
   }
]

API de pedido de produto em aberto - OBTER /sn_ind_tmt_orn/order/productOrder/

Recupera o pedido de produto especificado.

Este endpoint recupera informações do pedido das seguintes tabelas:

Pedido do cliente [sn_ind_tmt_orn_order]
Ordem de característica [sn_ind_tmt_orn_order_characteric_value]
Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]
Itens relacionados à linha de pedido [sn_ind_tmt_orn_order_line_related_items]

Formato de URL

URL padrão: /api/sn_ind_tmt_orn/order/product Order/

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho
Nome	Descrição
id	Sys_id ou external_id da ordem do cliente a ser recuperada. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]

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

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
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 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). A resposta retornará Bem-sucedida com uma mensagem de erro se o pedido selecionado tiver problemas de processamento. Uma resposta 200 OK acontece se o pedido estiver na tabela Fila de entrada [sn_tmt_core_inbound_queue] aguardando que o programador escolha o registro a ser processado. O campo de mensagem de erro inclui detalhes do registro. Por exemplo: `{ "code": 102, "reason": "Request in queue", "message": "Request in queue", "details": [ { "message": "This Order is still in the inbound queue table waiting to be processed.", "datapath": "" } ] }` Uma resposta 200 OK acontece se uma criação de pedido falhar e o registro na tabela Fila de entrada [sn_tmt_core_inbound_queue] estiver em um estado de erro. O campo de mensagem de erro inclui detalhes em para o registro da tabela de fila de entrada. Por exemplo: `{ "code": 23, "reason": "Missing body field", "message": "Missing body field", "details": [ { "message": "Invalid payload: orderCurrency is missing", "datapath": "/" } ] }`
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
canal	Lista de canais a serem usados para vender os produtos. Tipo de dados: Matriz de objetos `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificador exclusivo do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
channel.name	Nome do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
committedDueDate	Data e hora em que a ação deve ser executada no pedido. Este valor deve ser igual ou posterior a committedDueDatevalores para cada item de linha do pedido. Tipo de dados: Cadeia de caracteres
ExpectedCompletionDate	Data em que o pedido será concluído. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro do pedido do produto. Tipo de dados: Cadeia de caracteres
id	Sys_id do pedido do produto. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz de objetos `"note": [ { "author": "String", "date": "String", "text": "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	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres
OrderCurrency	Código da moeda do pedido e dos itens de linha do pedido. Tipo de dados: Cadeia de caracteres
ponr	Sinalizador que indica se o ponto sem retorno do pedido foi atingido. Valores possíveis: Verdadeiro: O ponto sem retorno do pedido foi atingido. Falso: O ponto sem retorno do pedido não foi atingido. Tipo de dados: Booliano
ProductOrderItem	Lista que descreve os itens associados ao pedido do produto e sua ação associada. Tipo de dados: Matriz de objetos `"productOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
ProductOrderItem.action	Ação a ser realizada no produto. As ações possíveis são definidas na guia Lista de seleção na entrada Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Tipo de dados: Cadeia de caracteres
ProductOrderItem.actionMotivo	Motivo para adicionar o item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo action_reason da tabela sn_ind_tmt_orn_order_line_item.
productOrderItem.committedDueDate	Data e hora em que a ação deve ser executada no item de linha do pedido. Tipo de dados: Cadeia de caracteres
ProductOrderItem.externalProductInventory	Lista de IDs externos mapeados para os inventários de produtos criados para o pedido. Tipo de dados: Matriz de objetos `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
ProductOrderItem.externalProductInventory.externalProductInventoryId	ID externo mapeado para o inventário do produto. Tipo de dados: Cadeia de caracteres
productOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice	Lista que descreve o preço associado ao produto. Tipo de dados: Matriz de objetos `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Descrição do preço do produto associado. Tipo de dados: Objeto `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: Objeto `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Código da moeda no qual o preço é representado. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preço do produto, incluindo qualquer imposto. Tipo de dados: Número
productOrderItem.itemPrice.priceType	Tipo de preço do item, recorrente ou não recorrente. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.recurringChargePeriod	Se o preço for recorrente, o período recorrente, como `mês` . Tipo de dados: Cadeia de caracteres
ProductOrderItem.ponr	Sinalizador que indica se o ponto sem retorno do pedido foi atingido. Valores possíveis: Verdadeiro: O ponto sem retorno do pedido foi atingido. Falso: O ponto sem retorno do pedido não foi atingido. Tipo de dados: Booliano
productOrderItem.product	Descrição dos detalhes da instância do produto comprado pelo cliente. Tipo de dados: Objeto `"product:" { "place": {Object}, "productCharacteristic": [Array], "productRelationship": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	Mapas dos locais nos quais o produto será instalado. Tipo de dados: Objeto `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.place.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Lugar` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic	Lista de características do produto associado. Somente as características do produto cujos valuesão diferentes de previousValueretornados. Tipo de dados: Matriz de objetos `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica [sn_prd_pm_characteric]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para um pedido de mudança. A solicitação é uma ordem de mudança se productOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.value	Valores de opção de característica associados ao produto. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.valueType	Tipo de valor de característica. Valores possíveis: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Teste de linha única Caixa de seleção Escolha Data, Endereço E-mail Inteiro, Data/Hora Objeto Texto de Linha Única Sim/Não Tipo de dados: Cadeia de caracteres
productOrderItem.product.productRelationship	Lista de detalhes de relacionamento de produto para um item de linha de pedido. Tipo de dados: Matriz de objetos `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.product.productRelationship.id	Sys_id ou sn_prd_invt_external_id do inventário do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou sn_prd_invt_external_id da tabela Inventário de produto [sn_prd_invt_product_inventory].
productOrderItem.product.productRelationship.relationshipType	Tipo de relacionamento entre o item de linha do pedido e o inventário do produto. Valor possível: Requer Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification	Descrição da especificação do produto associada ao produto. Tipo de dados: Objeto `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id da especificação do produto. Initial_version é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.internalId	Versão inicial da especificação do produto. A versão inicial é o sys_id da primeira versão da especificação. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.internalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Especificação do produto [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.name	Nome da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.version	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.@type	Parte do padrão TMF Open API. Este valor é sempre `ProductSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty	Lista de contatos para itens de linha. Tipo de dados: Matriz de objetos `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
productOrderItem.product.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.firstName	Nome do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.id	Sys_id do contato do item de linha associado ao item de linha do pedido. Localizado na tabela Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.lastName	Sobrenome do contato. Tipo de dados: Cadeia de caracteres Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@referredType	Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering	Descrição da oferta de produto associada ao produto. Tipo de dados: Objeto `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id da oferta de produto. Initial_version é o sys_id da primeira versão da oferta. Localizado no campo sys_id ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.internalId	Versão inicial da oferta de produto. A versão inicial é o sys_id da primeira versão da oferta. Tipo de dados: Cadeia de caracteres Tabela: Oferta de produto [sn_prd_pm_product_offering]
productOrderItem.productOffering.internalVersion	Versão da oferta do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].
productOrderItem.productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.version	Versão externa da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].
ProductOrderItem.Quantidade	Número de itens de produto comprados. Tipo de dados: Número
productOrderItem.productOrderItemRelationship	Lista de relacionamentos entre itens de linha do pedido. Tipo de dados: Matriz de objetos `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOrderItemRelationship.relationshipType	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: HasChild HasParent Requer `HasChild` e. `HasParent` são usados para relacionamentos primário/secundário. `Requer` é usado para relacionamentos horizontais (um item de linha requer outro item de linha). Tipo de dados: Cadeia de caracteres
ProductOrderItem.state	Estado do pedido do item de produto associado. Tipo de dados: Cadeia de caracteres
ProductOrderItem.version	Versão do pedido. Tipo de dados: Cadeia de caracteres
ProductOrderItem. No tipo	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Deve listar pelo menos um item que contém informações da conta do cliente ou da conta do consumidor. Tipo de dados: Matriz de objetos `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. 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. Em	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
estado	Estado atual do pedido. Tipo de dados: Cadeia de caracteres
versão	Versão do pedido. Tipo de dados: Cadeia de caracteres
.	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrder` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo recupera um pedido de produto especificado.

curl -X GET "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a" \
-u "username":"password"

Corpo da resposta.

{
   "id": "8d75939453126010a795ddeeff7b126a",
   "href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
   "ponr": "false",
   "orderCurrency": "USD",
   "expectedCompletionDate": "2021-05-02T08:13:59.000Z",
   "requestedCompletionDate": "2021-05-02T08:13:59.000Z",
   "requestedStartDate": "2020-05-03T08:13:59.000Z",
   "channel": [
      {
         "id": "1",
         "name": "Agent Assist"
      }
   ],
   "note": [
      {
         "author": "System Administrator",
         "date": "2021-02-25T14:22:07.000Z",
         "text": "This is a TMF product order illustration no 2"
      },
      {
         "author": "System Administrator",
         "date": "2021-02-25T14:22:06.000Z",
         "text": "This is a TMF product order illustration"
      }
   ],
   "productOrderItem": [
      {
         "id": "POI130",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "actionReason": "adding service package OLI",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "USD",
                     "value": 20
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productCharacteristic": [
               {
                  "name": "Security Type",
                  "valueType": "Choice",
                  "value": "Base",
                  "previousValue": ""
               }
            ],
            "productSpecification": {
               "id": "a6514bd3534560102f18ddeeff7b1247",
               "name": "SD-WAN Security",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "a6514bd3534560102f18ddeeff7b1247",
               "@type": "ProductSpecificationRef"
            },
            "relatedParty": [
               {
                  "id": "4175939453126010a795ddeeff7b127d",
                  "name": "John Smith",
                  "email": "abc2@example.com",
                  "phone": "32456768",
                  "@type": "RelatedParty",
                  "@referredType": "OrderLineItemContact"
               },
               {
                  "id": "c175939453126010a795ddeeff7b127c",
                  "name": "Joe Doe",
                  "email": "abc@example.com",
                  "phone": "1234567890",
                  "@type": "RelatedParty",
                  "@referredType": "OrderLineItemContact"
               }
            ]
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalId": "69017a0f536520103b6bddeeff7b127d",
            "internalVersion": "1"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI100",
               "relationshipType": "HasParent"
            }
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      },
      {
         "id": "POI100",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "actionReason":"adding service package OLI",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productSpecification": {
               "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
               "name": "SD-WAN Service Package",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
               "@type": "ProductSpecificationRef"
            }
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalId": "69017a0f536520103b6bddeeff7b127d",
            "internalVersion": "1"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI130",
               "relationshipType": "HasChild"
            },
            {
               "id": "POI120",
               "relationshipType": "HasChild"
            },
            {
               "id": "POI110",
               "relationshipType": "HasChild"
            }
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      },
      {
         "id": "POI120",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "actionReason": "adding service package OLI",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "USD",
                     "value": 20
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productCharacteristic": [
               {
                  "name": "CPE Type",
                  "valueType": "Choice",
                  "value": "Physical",
                  "previousValue": ""
               },
               {
                  "name": "WAN Optimization",
                  "valueType": "Choice",
                  "value": "Advance",
                  "previousValue": ""
               },
               {
                  "name": "Routing",
                  "valueType": "Choice",
                  "value": "Premium",
                  "previousValue": ""
               },
               {
                  "name": "CPE Model",
                  "valueType": "Choice",
                  "value": "ASR",
                  "previousValue": ""
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202",
               "@type": "ProductSpecificationRef"
            }, 
            "productRelationship": [
               {
                  "id": "326d13f45b5620102dff5e92dc81c785",
                  "relationshipType": "Requires"
               }
            ]
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "69017a0f536520103b6bddeeff7b127d"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI100",
               "relationshipType": "HasParent"
            },
            {
               "id": "POI110",
               "relationshipType": "Requires"
            }    
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      },
      {
         "id": "POI110",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "actionReason": "adding service package OLI",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "USD",
                     "value": 5
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productCharacteristic": [
               {
                  "name": "Tenancy",
                  "valueType": "Choice",
                  "value": "Base (10 site)",
                  "previousValue": ""
               }
            ],
            "productSpecification": {
               "id": "216663aa53702010cd6dddeeff7b12b5",
               "name": "SD-WAN Controller",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "216663aa53702010cd6dddeeff7b12b5",
               "@type": "ProductSpecificationRef"
            },
            "place": {
               "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
               "@type": "Place"
            }
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalId": "69017a0f536520103b6bddeeff7b127d",
            "internalVersion": "1"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI100",
               "relationshipType": "HasParent"
            }
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
   "state": "in_progress",
   "version": "1",
   "@type": "ProductOrder"
}

API de pedido de produto em aberto - OBTER /sn_ind_tmt_orn/productorder

Recupera todos os pedidos de produtos.

Importante:

Começando com Tokyo este endpoint foi descontinuado. A nova versão deste endpoint é API de pedido de produto em aberto - OBTER /sn_ind_tmt_orn/order/productOrder.

Este endpoint recupera informações do pedido das seguintes tabelas:

Pedido do cliente [sn_ind_tmt_orn_order]
Ordem de característica [sn_ind_tmt_orn_order_characteric_value]
Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]

Formato de URL

URL padrão: /api/sn_ind_tmt_orn/productorder

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
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Tipo de dados: Cadeia de caracteres Padrão: Todos os campos retornados.
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
estado	Filtrar pedidos por estado. Somente pedidos com um estado correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: Cadeia de caracteres Padrão: Todos os estados retornados.

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
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 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
canal	Lista de canais a serem usados para vender os produtos. Tipo de dados: Matriz de objetos `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificador exclusivo do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
channel.name	Nome do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
ExpectedCompletionDate	Data em que o pedido será concluído. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz de objetos `"note": { "author": "String", "date": "String", "text": "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	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres
ponr	Sinalizador que indica se o ponto sem retorno do pedido foi atingido. Valores possíveis: Verdadeiro: O ponto sem retorno do pedido foi atingido. Falso: O ponto sem retorno do pedido não foi atingido. Tipo de dados: Booliano
ProductOrderItem	Lista que descreve os itens associados ao pedido do produto e sua ação associada. Tipo de dados: Matriz de objetos `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
ProductOrderItem.action	Ação a ser realizada no produto. As ações possíveis são definidas na guia Lista de seleção na entrada Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Tipo de dados: Cadeia de caracteres
ProductOrderItem.actionMotivo	Motivo para adicionar o item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo action_reason da tabela sn_ind_tmt_orn_order_line_item.
productOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice	Lista que descreve o preço associado ao produto. Tipo de dados: Matriz de objetos `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Descrição do preço do produto associado. Tipo de dados: Objeto `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: Objeto `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Código da moeda no qual o preço é representado. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preço do produto, incluindo qualquer imposto. Tipo de dados: Número
productOrderItem.itemPrice.priceType	Tipo de preço do item, recorrente ou não recorrente. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.recurringChargePeriod	Se o preço for recorrente, o período recorrente, como `mês` . Tipo de dados: Cadeia de caracteres
ProductOrderItem.ponr	Sinalizador que indica se o ponto sem retorno do pedido foi atingido. Valores possíveis: Verdadeiro: O ponto sem retorno do pedido foi atingido. Falso: O ponto sem retorno do pedido não foi atingido. Tipo de dados: Booliano
productOrderItem.product	Descrição dos detalhes da instância do produto comprado pelo cliente. Tipo de dados: Objeto `"product:" { "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	Mapas dos locais nos quais o produto será instalado. Tipo de dados: Objeto `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.place.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Lugar` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic	Lista de características do produto associado. Somente as características do produto cujos valuesão diferentes de previousValueretornados. Tipo de dados: Matriz de objetos `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica [sn_prd_pm_characteric]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para um pedido de mudança. A solicitação é uma ordem de mudança se productOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.value	Valores de opção de característica associados ao produto. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.valueType	Tipo de valor de característica. Valores possíveis: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Teste de linha única Caixa de seleção Escolha Data, Endereço E-mail Inteiro, Data/Hora Objeto Texto de Linha Única Sim/Não Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification	Descrição da especificação do produto associada ao produto. Tipo de dados: Objeto `"productSpecification:" { "id": "String", "name": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id da especificação do produto. Initial_version é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.name	Nome da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.@type	Parte do padrão TMF Open API. Este valor é sempre `ProductSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty	Lista de contatos para itens de linha. Tipo de dados: Matriz de objetos `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
productOrderItem.product.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.firstName	Nome do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.id	Sys_id do contato do item de linha associado ao item de linha do pedido. Localizado na tabela Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.lastName	Sobrenome do contato. Tipo de dados: Cadeia de caracteres Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@referredType	Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering	Descrição da oferta de produto associada ao produto. Tipo de dados: Objeto `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id da oferta de produto. Initial_version é o sys_id da primeira versão da oferta. Localizado no campo sys_id ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
ProductOrderItem.Quantidade	Número de itens de produto comprados. Tipo de dados: Número
productOrderItem.productOrderItemRelationship	Lista de relacionamentos entre itens de linha do pedido. Tipo de dados: Matriz de objetos `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOrderItemRelationship.relationshipType	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: HasChild HasParent Requer `HasChild` e. `HasParent` são usados para relacionamentos primário/secundário. `Requer` é usado para relacionamentos horizontais (um item de linha requer outro item de linha). Tipo de dados: Cadeia de caracteres
ProductOrderItem.state	Estado do pedido do item de produto associado. Tipo de dados: Cadeia de caracteres
ProductOrderItem.version	Versão do pedido. Tipo de dados: Cadeia de caracteres
ProductOrderItem. No tipo	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Deve listar pelo menos um item que contém informações da conta do cliente ou da conta do consumidor. Tipo de dados: Matriz de objetos `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. 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. Em	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
estado	Estado atual do pedido. Tipo de dados: Cadeia de caracteres
versão	Versão do pedido. Tipo de dados: Cadeia de caracteres
.	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrder` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo recupera todos os pedidos de produtos.

curl --location --request GET 'https://instance.servicenow.com/api/sn_ind_tmt_orm/productorder' \
--user 'username':'password'

Corpo da resposta.

[
   {
      "id": "8d75939453126010a795ddeeff7b126a",
      "ponr": "false",
      "expectedCompletionDate": "2021-05-02T08:13:59.000Z",
      "requestedCompletionDate": "2021-05-02T08:13:59.000Z",
      "requestedStartDate": "2020-05-03T08:13:59.000Z",
      "channel": [
         {
            "id": "1",
            "name": "Agent Assist"
         }
      ],
      "note": [
         {
            "author": "System Administrator",
            "date": "2021-02-25T14:22:07.000Z",
            "text": "This is a TMF product order illustration no 2"
         },
         {
            "author": "System Administrator",
            "date": "2021-02-25T14:22:06.000Z",
            "text": "This is a TMF product order illustration"
         }
      ],
      "productOrderItem": [
         {
            "id": "POI130",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "actionReason": "adding service package OLI",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "USD",
                        "value": 20
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productCharacteristic": [
                  {
                     "name": "Security Type",
                     "valueType": "Choice",
                     "value": "Base",
                     "previousValue": ""
                  }
               ],
               "productSpecification": {
                  "id": "a6514bd3534560102f18ddeeff7b1247",
                  "name": "SD-WAN Security",
                  "@type": "ProductSpecificationRef"
               },
               "relatedParty": [
                  {
                     "id": "4175939453126010a795ddeeff7b127d",
                     "name": "John Smith",
                     "email": "abc2@example.com",
                     "phone": "32456768",
                     "@type": "RelatedParty",
                     "@referredType": "OrderLineItemContact"
                  },
                  {
                     "id": "c175939453126010a795ddeeff7b127c",
                     "name": "Joe Doe",
                     "email": "abc@example.com",
                     "phone": "1234567890",
                     "@type": "RelatedParty",
                     "@referredType": "OrderLineItemContact"
                  }
               ]
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI100",
                  "relationshipType": "HasParent"
               }
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         },
         {
            "id": "POI100",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productSpecification": {
                  "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
                  "name": "SD-WAN Service Package",
                  "@type": "ProductSpecificationRef"
               }
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI130",
                  "relationshipType": "HasChild"
               },
               {
                  "id": "POI120",
                  "relationshipType": "HasChild"
               },
               {
                  "id": "POI110",
                  "relationshipType": "HasChild"
               }
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         },
         {
            "id": "POI120",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "actionReason":"adding service package OLI",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "USD",
                        "value": 20
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productCharacteristic": [
                  {
                     "name": "CPE Type",
                     "valueType": "Choice",
                     "value": "Physical",
                     "previousValue": ""
                  },
                  {
                     "name": "WAN Optimization",
                     "valueType": "Choice",
                     "value": "Advance",
                     "previousValue": ""
                  },
                  {
                     "name": "Routing",
                     "valueType": "Choice",
                     "value": "Premium",
                     "previousValue": ""
                  },
                  {
                     "name": "CPE Model",
                     "valueType": "Choice",
                     "value": "ASR",
                     "previousValue": ""
                  }
               ],
               "productSpecification": {
                  "id": "39b627aa53702010cd6dddeeff7b1202",
                  "name": "SD-WAN Edge Device",
                  "@type": "ProductSpecificationRef"
               }
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI100",
                  "relationshipType": "HasParent"
               }
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         },
         {
            "id": "POI110",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "actionReason": "adding service package OLI",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "USD",
                        "value": 5
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productCharacteristic": [
                  {
                     "name": "Tenancy",
                     "valueType": "Choice",
                     "value": "Base (10 site)",
                     "previousValue": ""
                  }
               ],
               "productSpecification": {
                  "id": "216663aa53702010cd6dddeeff7b12b5",
                  "name": "SD-WAN Controller",
                  "@type": "ProductSpecificationRef"
               },
               "place": {
                  "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                  "@type": "Place"
               }
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI100",
                  "relationshipType": "HasParent"
               }
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         }
      ],
      "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
      "state": "in_progress",
      "version": "1",
      "@type": "ProductOrder"
   }
]

API de pedido de produto em aberto - OBTER /sn_ind_tmt_orn/productorder/

Recupera o pedido de produto especificado.

Importante:

Começando com Tokyo este endpoint foi descontinuado. A nova versão deste endpoint é API de pedido de produto em aberto - OBTER /sn_ind_tmt_orn/order/productOrder/.

Este endpoint recupera informações do pedido das seguintes tabelas:

Pedido do cliente [sn_ind_tmt_orn_order]
Ordem de característica [sn_ind_tmt_orn_order_characteric_value]
Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]

Formato de URL

URL padrão: /api/sn_ind_tmt_orn/productorder/

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho
Nome	Descrição
id	Sys_id ou external_id da ordem do cliente a ser recuperada. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]

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

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

Cabeçalhos

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 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
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Pode ser por qualquer um dos seguintes motivos: Parâmetro de consulta ausente URI inválido
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
canal	Lista de canais a serem usados para vender os produtos. Tipo de dados: Matriz de objetos `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificador exclusivo do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
channel.name	Nome do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
ExpectedCompletionDate	Data em que o pedido será concluído. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Objeto `"note": { "author": "String", "date": "String", "text": "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	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres
ponr	Sinalizador que indica se o ponto sem retorno do pedido foi atingido. Valores possíveis: Verdadeiro: O ponto sem retorno do pedido foi atingido. Falso: O ponto sem retorno do pedido não foi atingido. Tipo de dados: Booliano
ProductOrderItem	Lista que descreve os itens associados ao pedido do produto e sua ação associada. Tipo de dados: Matriz de objetos `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
ProductOrderItem.action	Ação a ser realizada no produto. As ações possíveis são definidas na guia Lista de seleção na entrada Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Tipo de dados: Cadeia de caracteres
ProductOrderItem.actionMotivo	Motivo para adicionar o item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo action_reason da tabela sn_ind_tmt_orn_order_line_item.
productOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice	Lista que descreve o preço associado ao produto. Tipo de dados: Matriz de objetos `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Descrição do preço do produto associado. Tipo de dados: Objeto `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: Objeto `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Código da moeda no qual o preço é representado. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preço do produto, incluindo qualquer imposto. Tipo de dados: Número
productOrderItem.itemPrice.priceType	Tipo de preço do item, recorrente ou não recorrente. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.recurringChargePeriod	Se o preço for recorrente, o período recorrente, como `mês` . Tipo de dados: Cadeia de caracteres
ProductOrderItem.ponr	Sinalizador que indica se o ponto sem retorno do pedido foi atingido. Valores possíveis: Verdadeiro: O ponto sem retorno do pedido foi atingido. Falso: O ponto sem retorno do pedido não foi atingido. Tipo de dados: Booliano
productOrderItem.product	Descrição dos detalhes da instância do produto comprado pelo cliente. Tipo de dados: Objeto `"product:" { "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	Mapas dos locais nos quais o produto será instalado. Tipo de dados: Objeto `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.place.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Lugar` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic	Lista de características do produto associado. Somente as características do produto cujos valuesão diferentes de previousValueretornados. Tipo de dados: Matriz de objetos `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica [sn_prd_pm_characteric]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para um pedido de mudança. A solicitação é uma ordem de mudança se productOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.value	Valores de opção de característica associados ao produto. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.valueType	Tipo de valor de característica. Valores possíveis: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Teste de linha única Caixa de seleção Escolha Data, Endereço E-mail Inteiro, Data/Hora Objeto Texto de Linha Única Sim/Não Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification	Descrição da especificação do produto associada ao produto. Tipo de dados: Objeto `"productSpecification:" { "id": "String", "name": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id da especificação do produto. Initial_version é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.name	Nome da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.@type	Parte do padrão TMF Open API. Este valor é sempre `ProductSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty	Lista de contatos para itens de linha. Tipo de dados: Objeto `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
productOrderItem.product.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.firstName	Nome do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.id	Sys_id do contato do item de linha associado ao item de linha do pedido. Localizado na tabela Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.lastName	Sobrenome do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@referredType	Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering	Descrição da oferta de produto associada ao produto. Tipo de dados: Objeto `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id da oferta de produto. Initial_version é o sys_id da primeira versão da oferta. Localizado no campo sys_id ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
ProductOrderItem.Quantidade	Número de itens de produto comprados. Tipo de dados: Número
productOrderItem.productOrderItemRelationship	Lista de relacionamentos entre itens de linha do pedido. Tipo de dados: Matriz de objetos `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOrderItemRelationship.relationshipType	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: HasChild HasParent Requer `HasChild` e. `HasParent` são usados para relacionamentos primário/secundário. `Requer` é usado para relacionamentos horizontais (um item de linha requer outro item de linha). Tipo de dados: Cadeia de caracteres
ProductOrderItem.state	Estado do pedido do item de produto associado. Tipo de dados: Cadeia de caracteres
ProductOrderItem.version	Versão do pedido. Tipo de dados: Cadeia de caracteres
ProductOrderItem. No tipo	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Deve listar pelo menos um item que contém informações da conta do cliente ou da conta do consumidor. Tipo de dados: Matriz de objetos `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. 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. Em	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
estado	Estado atual do pedido. Tipo de dados: Cadeia de caracteres
versão	Versão do pedido. Tipo de dados: Cadeia de caracteres
.	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrder` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo de código a seguir solicita uma ordem de cliente existente.

curl -X GET "https://servicenow-instance/api/sn_ind_tmt_orm/productorder/8d75939453126010a795ddeeff7b126a" \
-u "username":"password"

Corpo da resposta.

{
  "id": "8d75939453126010a795ddeeff7b126a",
  "ponr": "false",
  "expectedCompletionDate": "2021-05-02T08:13:59.000Z",
  "requestedCompletionDate": "2021-05-02T08:13:59.000Z",
  "requestedStartDate": "2020-05-03T08:13:59.000Z",
  "channel": [
    {
      "id": "1",
      "name": "Agent Assist"
    }
  ],
  "note": [
    {
      "author": "System Administrator",
      "date": "2021-02-25T14:22:07.000Z",
      "text": "This is a TMF product order illustration no 2"
    },
    {
      "author": "System Administrator",
      "date": "2021-02-25T14:22:06.000Z",
      "text": "This is a TMF product order illustration"
    }
  ],

  "productOrderItem": [
    {
      "id": "POI130",
      "ponr": "false",
      "quantity": 1,
      "action": "add",
      "actionReason":"adding service package OLI",
      "itemPrice": [
        {
          "priceType": "recurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        },
        {
          "priceType": "nonRecurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "INR",
              "value": 0
            }
          }
        }
      ],
      "product": {
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "Security Type",
            "valueType": "Choice",
            "value": "Base",
            "previousValue": ""
          }
        ],
        "productSpecification": {
          "id": "a6514bd3534560102f18ddeeff7b1247",
          "name": "SD-WAN Security",
          "@type": "ProductSpecificationRef"
        },
        "relatedParty": [
          {
            "id": "4175939453126010a795ddeeff7b127d",
            "name": "John Smith",
            "email": "abc2@example.com",
            "phone": "32456768",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          },
          {
            "id": "c175939453126010a795ddeeff7b127c",
            "name": "Joe Doe",
            "email": "abc@example.com",
            "phone": "1234567890",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ]
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        }
      ],
      "state": "in_progress",
      "version": "1",
      "@type": "ProductOrderItem"
    },
    {
    "id": "POI100",
    "ponr": "false",
    "quantity": 1,
    "action": "add",
    "itemPrice": [
      {
        "priceType": "recurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "INR",
            "value": 0
          }
        }
      },
      {
        "priceType": "nonRecurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "INR",
            "value": 0
          }
        }
      }
    ],
    "product": {
      "@type": "Product",
      "productSpecification": {
        "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
        "name": "SD-WAN Service Package",
        "@type": "ProductSpecificationRef"
      }
    },
    "productOffering": {
      "id": "69017a0f536520103b6bddeeff7b127d",
      "name": "Premium SD-WAN Offering"
    },
    "productOrderItemRelationship": [
      {
        "id": "POI130",
        "relationshipType": "HasChild"
      },
      {
        "id": "POI120",
        "relationshipType": "HasChild"
      },
      {
        "id": "POI110",
        "relationshipType": "HasChild"
      }
    ],
    "state": "in_progress",
    "version": "1",
    "@type": "ProductOrderItem"
  },
  {
    "id": "POI120",
    "ponr": "false",
    "quantity": 1,
    "action": "add",
    "itemPrice": [
      {
        "priceType": "recurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        },
        {
          "priceType": "nonRecurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "INR",
              "value": 0
            }
          }
        }
      ],
      "product": {
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "CPE Type",
            "valueType": "Choice",
            "value": "Physical",
            "previousValue": ""
          },
          {
            "name": "WAN Optimization",
            "valueType": "Choice",
            "value": "Advance",
            "previousValue": ""
          },
          {
            "name": "Routing",
            "valueType": "Choice",
            "value": "Premium",
            "previousValue": ""
          },
          {
            "name": "CPE Model",
            "valueType": "Choice",
            "value": "ASR",
            "previousValue": ""
           }
        ],
        "productSpecification": {
          "id": "39b627aa53702010cd6dddeeff7b1202",
          "name": "SD-WAN Edge Device",
          "@type": "ProductSpecificationRef"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        }
      ],
      "state": "in_progress",
      "version": "1",
      "@type": "ProductOrderItem"
    },
    {
      "id": "POI110",
      "ponr": "false",
      "quantity": 1,
      "action": "add",
      "actionReason":"adding service package OLI",
      "itemPrice": [
        {
          "priceType": "recurring",
            "price": {
              "taxIncludedAmount": {
                "unit": "INR",
                "value": 0
              }
            }
          },
          {
          "priceType": "nonRecurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 5
            }
          }
        }
      ],
      "product": {
      "@type": "Product",
      "productCharacteristic": [
        {
          "name": "Tenancy",
          "valueType": "Choice",
          "value": "Base (10 site)",
          "previousValue": ""
        }
      ],
      "productSpecification": {
        "id": "216663aa53702010cd6dddeeff7b12b5",
        "name": "SD-WAN Controller",
        "@type": "ProductSpecificationRef"
      },
      "place": {
        "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
        "@type": "Place"
      }
    },
    "productOffering": {
      "id": "69017a0f536520103b6bddeeff7b127d",
      "name": "Premium SD-WAN Offering"
    },
    "productOrderItemRelationship": [
      {
        "id": "POI100",
        "relationshipType": "HasParent"
      }
    ],
    "state": "in_progress",
    "version": "1",
    "@type": "ProductOrderItem"
  }
],
"relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
"state": "in_progress",
"version": "1",
"@type": "ProductOrder"
}

API de pedido de produto em aberto - PATCH /sn_ind_tmt_orn/order/productOrder/

Atualiza a ordem do cliente especificada.

Formato de URL

URL padrão: /api/sn_ind_tmt_orn/order/product Order/

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho
Nome	Descrição
id	Sys_id da ordem do cliente a ser atualizada. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]

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

Tabela 27. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
canal	Lista de canais a serem usados para vender os produtos. Tipo de dados: Matriz de objetos `"channel": [ { "id": "String", "name": "String" } ]` Armazenado em: sn_ind_tmt_ORM_ORM_ORDER
channel.id	Necessário se channelo parâmetro é usado. Identificador exclusivo do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Canal de distribuição [sn_prd_pm_distribution_channel]. Armazenado em: O campo de canal da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
channel.name	Nome do canal a ser usado para vender os produtos associados. Os nomes de canal possíveis são definidos na guia Lista de seleção na entrada Dicionário de canais da tabela sn_ind_tmt_ORM_order. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
committedDueDate	Data e hora em que a ação deve ser executada no pedido. Este valor deve ser igual ou posterior a committedDueDatevalores para cada item de linha do pedido. Se a ação para itens de linha do pedido for `suspender` ou `retomar` este parâmetro não pode ser atualizado. Tipo de dados: Cadeia de caracteres Armazenado em: O campo committed_due_date da tabela sn_ind_tmt_orn_order.
externalId	Identificador exclusivo da ordem do cliente. Este valor é determinado por um sistema externo. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_id da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz de objetos `"note": [ { "text": "String" } ]` Armazenado em: sn_ind_tmt_ORM_ORM_ORDER
note.text	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de comentários da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
OrderCurrency	Código da moeda do pedido e dos itens de linha do pedido. A atualização do código da moeda de um pedido existente não é compatível. Fornecer qualquer valor diferente do código da moeda já associado ao pedido faz com que a atualização seja rejeitada. Tipo de dados: Cadeia de caracteres
ProductOrderItem	Lista que descreve os itens associados ao pedido do produto e sua ação associada. Tipo de dados: Matriz de objetos `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "revisionOperation": "String", "@type": "String" } ]` Armazenado em: sn_ind_tmt_orn_order_line_item
ProductOrderItem.action	Necessário se productOrderItemo parâmetro é usado. Ação a ser realizada no produto. As ações possíveis são definidas na guia Lista de seleção na entrada Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Valores possíveis: adicionar mudança excluir nenhuma mudança resume suspender Tipo de dados: Cadeia de caracteres Armazenado em: O campo de ação da tabela sn_ind_tmt_orn_order_line_item. Padrão: Adicionar
ProductOrderItem.actionMotivo	Motivo para adicionar o item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo action_reason da tabela sn_ind_tmt_orn_order_line_item.
productOrderItem.committedDueDate	Data e hora em que a ação deve ser executada no item de linha do pedido. Se a ação do item for `suspender` ou `retomar` este parâmetro não pode ser atualizado. Tipo de dados: Cadeia de caracteres Armazenado em: O campo committed_due_date da tabela sn_ind_tmt_orn_order_line_item.
ProductOrderItem.externalProductInventory	Lista de IDs externos a serem mapeados para os inventários de produtos criados para o pedido. Tipo de dados: Matriz de objetos `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Nota: Anteriormente, ao criar um pedido DE PATCH com um ID de inventário de produto externo que já existia, a operação era anulada e retornava um erro. Com Xanadu Este parâmetro é simplesmente ignorado quando um ID de inventário de produto externo existente é fornecido e um erro não é gerado.
ProductOrderItem.externalProductInventory.externalProductInventoryId	ID externo a ser mapeado para o inventário do produto. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_inventory_id da tabela sn_ind_tmt_orn_order_line_item e o campo sn_prd_invt_external_id da tabela sn_prd_invt_product_inventory.
ProductOrderItem.id	Necessário se productOrderItemo parâmetro é usado. Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_id da tabela sn_ind_tmt_orn_order_line_item. Comprimento máximo: 40 Cadeia de caracteres em branco
productOrderItem.itemPrice	Lista que descreve o preço associado ao produto. Tipo de dados: Matriz de objetos `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Armazenado em: sn_ind_tmt_ORM_ORM_ORDER Cadeia de caracteres em branco
productOrderItem.itemPrice.price	Descrição do preço do produto associado. Tipo de dados: Objeto `"price": { "taxIncludedAmount": {Object} }` Armazenado em: sn_ind_tmt_orn_order_line_item Cadeia de caracteres em branco
productOrderItem.itemPrice.price.taxIncludedAmount	Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: Objeto `"taxIncludedAmount": { "unit": "String", "value": Number }` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Código da moeda no qual o preço é representado. Tipo de dados: Cadeia de caracteres Armazenado em: O campo mrc ou nrc na tabela sn_ind_tmt_orn_order_line_item.
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preço do produto, incluindo qualquer imposto. Tipo de dados: Número Armazenado em: O campo mrc ou nrc na tabela sn_ind_tmt_orn_order_line_item.
productOrderItem.itemPrice.priceType	Tipo de preço do item, recorrente ou não recorrente. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.recurringChargePeriod	Se o preço for recorrente, o período recorrente, como `mês` . Tipo de dados: Cadeia de caracteres
productOrderItem.product	Necessário se productOrderItem.actioné mudança ou exclusão. Descrição dos detalhes da instância do produto comprado pelo cliente. Tipo de dados: Objeto `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.product.id	Necessário se productOrderItem.actioné mudança ou exclusão. Identificador exclusivo do produto vendido. Localizado no campo sys_id ou sn_ind_tmt_orn_external_id da tabela Inventário de produto [sn_ind_tmt_orn_product_inventory]. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
productOrderItem.product.place	Mapas dos locais nos quais o produto será instalado. Tipo de dados: Objeto `"place": { "id": "String", "@type": "String" }` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.product.place.id	Necessário se productOrderItem.product.placeo parâmetro é usado. Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de local da tabela sn_ind_tmt_orn_order_line_item. Cadeia de caracteres em branco
productOrderItem.product.place.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Lugar` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic	Lista de características do produto associado. Tipo de dados: Matriz de objetos `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]` Armazenado em: sn_ind_tmt_orn_order_characteric_value
productOrderItem.product.productCharacteristic.name	Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica [sn_prd_pm_characteric]. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de características da tabela sn_ind_tmt_orn_order_characteristic_value. Cadeia de caracteres em branco
productOrderItem.product.productCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para um pedido de mudança. A solicitação é uma ordem de mudança se productOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres Armazenado em: Previous_characteric_option_value da tabela sn_ind_tmt_orn_order_characteristic_value. Cadeia de caracteres em branco
productOrderItem.product.productCharacteristic.value	Valores de opção de característica associados ao produto. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres Armazenado em: O campo characteric_option_value da tabela sn_ind_tmt_orn_order_characteristic_value. Cadeia de caracteres em branco
productOrderItem.product.productCharacteristic.valueType	Tipo de valor de característica. Tipo de dados: Cadeia de caracteres Valores possíveis: matriz.data array.datetime array.decimal array.integer array.object teste de linha única.array caixa de seleção escolha data, endereço e-mail inteiro,data/hora objeto texto de linha única sim/não
productOrderItem.product.productSpecification	Descrição da especificação do produto associada ao produto. Nota: Ordens de mudança ( productOrderItem.action. `mudança` ) são processados de forma diferente com base no valor de sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrderpropriedade do sistema. O valor desta propriedade do sistema determina como o pedido será processado se o inventário do produto for uma versão diferente da indicada no pedido. Quando esta propriedade do sistema é definida como verdadeira (padrão), o inventário do produto é atualizado automaticamente para a versão no pedido, alterando a especificação do produto referenciado. Isso permite que o pedido seja processado com sucesso. Se esta propriedade do sistema estiver definida como falsa, se o inventário do produto for uma versão diferente da indicada no pedido, o pedido falhará devido à incompatibilidade da versão. Tipo de dados: Objeto `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.product.productSpecification.id	Necessário se productOrderItem.product.productSpecificationo parâmetro é usado. Initial_version ou external_id da especificação do produto. Initial_version é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.internalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.name	Nome da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.version	External_version da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.@type	Parte do padrão TMF Open API. Este valor é sempre `ProductSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty	Lista de contatos para itens de linha. Tipo de dados: Matriz de objetos `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Armazenado em: sn_ind_tmt_orn_order_line_item_contact
productOrderItem.product.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de e-mail da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.firstName	Nome do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo first_name da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.id	Sys_id do contato do item de linha associado ao item de linha do pedido. Localizado na tabela Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]. Tipo de dados: Cadeia de caracteres Armazenado em: O campo sys_id da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.lastName	Sobrenome do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo lastName da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo business_phone da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.@referredType	Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.@type	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Produto` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering	Descrição da oferta de produto associada ao produto. Tipo de dados: Objeto `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.productOffering.id	Necessário se productOrderItem.productOfferingo parâmetro é usado. Initial_version ou external_id da oferta de produto. Initial_version é o sys_id da primeira versão da oferta. Localizado no campo sys_id ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.internalVersion	Versão da oferta do produto. Tipo de dados: Cadeia de caracteres Tabela: Oferta de produto [sn_prd_pm_product_offering]
productOrderItem.productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.version	External_version da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: Oferta de produto [sn_prd_pm_product_offering]
productOrderItem.productOrderItem.quantity	Número de itens associados a serem solicitados. Tipo de dados: Número Armazenado em: O campo Quantidade do sn_ind_tmt_orn_order. Padrão: Nulo
productOrderItem.productOrderItemRelationship	Lista de relacionamentos entre itens de linha do pedido. Tipo de dados: Matriz de objetos `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.productOrderItemRelationship.id	Necessário se productOrderItem.productOrderItemRelationshipo parâmetro é usado. Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres Armazenado em: O campo parent_line_item da tabela bsn_ind_tmt_orn_order_line_item. Cadeia de caracteres em branco
productOrderItem.productOrderItemRelationship.relationshipType	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: HasChild HasParent Requer `HasChild` e. `HasParent` são usados para relacionamentos primário/secundário. `Requer` é usado para relacionamentos horizontais (um item de linha requer outro item de linha). Tipo de dados: Cadeia de caracteres
ProductOrderItem.Quantidade	Número de itens solicitados. Tipo de dados: Número Armazenado em: O campo Quantidade da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
ProductOrderItem.revisionOperation	Tipo de atualização a ser executada no item de linha. Se este valor estiver vazio, o item de linha existente será atualizado ou um novo item de linha será adicionado se ainda não existir. Se este valor for `cancelar` , o item de linha foi cancelado. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
ProductOrderItem. No tipo	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Deve listar pelo menos um item que contém informações da conta do cliente ou da conta do consumidor. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
IdentidadeRelatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. 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. Em	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres Armazenado em: O campo expected_end_date da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres Armazenado em: O campo expected_start_date da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
.	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrder` . 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.
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 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. Se houver problemas com as características ou as informações da opção de características, o endpoint armazenará os seguintes comentários nos campos de anotações de trabalho do registro de item de linha de pedido do cliente associado: `As seguintes características do item do pedido não existem: Revisar especificação > characteristic.name> e corrija a característica e a opção de característica no item de linha do pedido antes de aprovar o pedido.` `Característica do item do pedido characteristic.name> com valor de característica: > characteristic.value> é inválido. Corrija os valores das características antes de aprovar o pedido.`
400	Solicitação Incorreta. Qualquer um dos seguintes motivos: `Carga inválida: Corpo da solicitação ausente` A carga não foi passada no corpo da solicitação. `Carga inválida: ProductOrderItem está ausente` Objeto de item de linha de pedido do produto ou JSON ausente. `Carga inválida: O ID de productOrderItem está ausente` - O. ido parâmetro está ausente no item de linha do pedido do produto da carga. `Carga inválida: A ação productOrderItem está ausente` - O. actiono parâmetro está ausente no item de linha do pedido do produto da carga. `Carga inválida: ProductOrderItem productOffering está ausente` - O objeto de oferta do produto ou JSON está ausente no item de linha do pedido do produto na carga. `Carga inválida: O ID de productOffering está ausente` - O. ido parâmetro está ausente no item de linha do pedido do produto do objeto de oferta do produto na carga. `Carga inválida: A oferta de produto não existe` - A oferta de produto no item de linha do pedido do produto não é válida. `Carga inválida: O produto productOrderItem está ausente` - O objeto do produto ou JSON no item de linha do pedido do produto está ausente na carga. `Carga inválida: O produto ProductSpecification está ausente` - O objeto de especificação do produto ou JSON no item de linha do pedido do produto está ausente na carga. `Carga inválida: O ID de especificação do produto está ausente` - O. ido parâmetro no item de linha do pedido do produto do objeto de especificação do produto está ausente na carga. `Carga inválida: A especificação do produto não existe` - A especificação do produto no item de linha do pedido do produto não é válida. `Carga inválida: O inventário do produto não existe` - Em um pedido de mudança (ação: Mudança), a quantidade de um item é maior do que a quantidade em estoque. `Carga inválida: O ID do inventário do produto está ausente` - Em uma ordem de mudança, o. product.idestá ausente na carga. `Carga inválida: O produto vendido está inativo` - Em um pedido de mudança, um produto especificado na carga está inativo. `Carga inválida: RelatedParty está ausente` - O objeto da parte relacionada está ausente na carga. `A conta do cliente ou o consumidor está ausente` - O objeto do cliente ou consumidor da parte relacionada está ausente na carga. `Carga inválida: O consumidor não existe` - O consumidor da parte relacionada especificada não existe no ServiceNow instância. `Carga inválida: A conta do cliente não existe` - O cliente da parte relacionada especificada não existe no ServiceNow instância. `Carga inválida: Falha na criação do pedido` - Não foi possível criar o pedido solicitado. `Revisão em andamento para a moeda do pedido não compatível` - O. orderCurrencyo parâmetro não pode ser atualizado depois que o pedido é criado. `Este pedido ainda não foi criado na tabela de pedido de venda. Verifique na fila de entrada para obter mais detalhes.` - O ID do pedido fornecido não está na tabela de pedido do cliente. `A solicitação de patch não pode ser feita porque o tipo de execução do pedido não é "entregar.` - A solicitação de patch foi feita em um pedido que tem um tipo de execução diferente de Entrega.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
canal	Lista de canais a serem usados para vender os produtos. Tipo de dados: Matriz de objetos `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificador exclusivo do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
channel.name	Nome do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
committedDueDate	Data e hora em que a ação deve ser executada no pedido. Este valor deve ser igual ou posterior a committedDueDatevalores para cada item de linha do pedido. Tipo de dados: Cadeia de caracteres
externalId	Identificador externo da ordem de venda, como um número de ordem de compra. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro do pedido do produto. Tipo de dados: Cadeia de caracteres
id	Sys_id da ordem do cliente atualizada para esta solicitação. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz de objetos `"note": [ { "text": "String" } ]`
note.text	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres
OrderCurrency	Código da moeda do pedido e dos itens de linha do pedido. Tipo de dados: Cadeia de caracteres
ProductOrderItem	Lista que descreve os itens associados ao pedido do produto e sua ação associada. Tipo de dados: Matriz de objetos `"productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
ProductOrderItem.action	Ação a ser realizada no produto. As ações possíveis são definidas na guia Lista de seleção na entrada Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Tipo de dados: Cadeia de caracteres
ProductOrderItem.actionMotivo	Motivo para adicionar o item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo action_reason da tabela sn_ind_tmt_orn_order_line_item.
productOrderItem.committedDueDate	Data e hora em que a ação deve ser executada no item de linha do pedido. Tipo de dados: Cadeia de caracteres
ProductOrderItem.externalProductInventory	Lista de IDs externos a serem mapeados para os inventários de produtos criados para o pedido. Tipo de dados: Matriz de objetos `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Nota: Anteriormente, ao criar um pedido DE PATCH com um ID de inventário de produto externo que já existia, a operação era anulada e retornava um erro. Com Xanadu Este parâmetro é simplesmente ignorado quando um ID de inventário de produto externo existente é fornecido e um erro não é gerado.
ProductOrderItem.externalProductInventory.externalProductInventoryId	ID externo mapeado para o inventário do produto. Tipo de dados: Cadeia de caracteres
productOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice	Lista que descreve o preço associado ao produto. Tipo de dados: Matriz de objetos `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Descrição do preço do produto associado. Tipo de dados: Objeto `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: Objeto `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	Código da moeda no qual o preço é representado. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.price.taxIncludeAmount.value	Preço do produto, incluindo qualquer imposto. Tipo de dados: Número
productOrderItem.itemPrice.priceType	Tipo de preço do item, recorrente ou não recorrente. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.recurringChargePeriod	Se o preço for recorrente, o período recorrente, como `mês` . Tipo de dados: Cadeia de caracteres
productOrderItem.product	Descrição dos detalhes da instância do produto comprado pelo cliente. Tipo de dados: Objeto `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.id	Identificador exclusivo do produto vendido. Localizado no campo sys_id ou sn_ind_tmt_orn_external_id da tabela Inventário de produto [sn_ind_tmt_orn_product_inventory]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.place	Mapas dos locais nos quais o produto será instalado. Tipo de dados: Objeto `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic	Lista de características do produto associado. Tipo de dados: Matriz de objetos `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica [sn_prd_pm_characteric]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para um pedido de mudança. A solicitação é uma ordem de mudança se productOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.value	Valores de opção de característica associados ao produto. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification	Descrição da especificação do produto associada ao produto. Tipo de dados: Objeto `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id da especificação do produto. Initial_version é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.internalId	Versão inicial da especificação do produto. A versão inicial é o sys_id da primeira versão da especificação. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.internalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Especificação do produto [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.name	Nome da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.version	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.@type	Parte do padrão TMF Open API. Este valor é sempre `ProductSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty	Lista de contatos para itens de linha. Tipo de dados: Matriz de objetos `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.firstName	Nome do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.id	Sys_id do contato do item de linha associado ao item de linha do pedido. Localizado na tabela Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.lastName	Sobrenome do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@referredType	Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.@type	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Produto` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering	Descrição da oferta de produto associada ao produto. Tipo de dados: Objeto `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id da oferta de produto. Initial_version é o sys_id da primeira versão da oferta. Localizado no campo sys_id ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.internalId	Versão inicial da oferta de produto. A versão inicial é o sys_id da primeira versão da oferta. Tipo de dados: Cadeia de caracteres Tabela: Oferta de produto [sn_prd_pm_product_offering]
productOrderItem.productOffering.internalVersion	Versão da oferta do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].
productOrderItem.productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.version	Versão externa da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].
productOrderItem.productOrderItemRelationship	Lista de relacionamentos entre itens de linha do pedido. Tipo de dados: Matriz de objetos `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOrderItemRelationship.relationshipType	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Tipo de dados: Cadeia de caracteres
ProductOrderItem.Quantidade	Número de itens associados a serem solicitados. Tipo de dados: Número
ProductOrderItem.state	Estado atual do item do pedido do produto. Tipo de dados: Cadeia de caracteres
ProductOrderItem. No tipo	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Deve listar pelo menos um item que contém informações da conta do cliente ou da conta do consumidor. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty.type	Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
estado	Estado atual do pedido. Tipo de dados: Cadeia de caracteres
.	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrder` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo atualiza o canal de um pedido de produto.

curl -X PATCH "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
  "channel": [
    {
      "id": "1",
      "name": "Agent Assist"
    }
  ]
}

Corpo da resposta.

{
   "id": "8d75939453126010a795ddeeff7b126a",
   "href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
   "expectedCompletionDate": "2021-05-02T08:13:59.000Z",
   "requestedCompletionDate": "2021-05-02T08:13:59.000Z",
   "requestedStartDate": "2020-05-03T08:13:59.000Z",
   "externalId": "PO-456",
   "orderCurrency": "USD",
   "channel": [
      {
         "id": "1",
         "name": "Agent Assist"
      }
   ],
   "note": [
      {
         "author": "System Administrator",
         "date": "2021-02-25T14:22:07.000Z",
         "text": "This is a TMF product order illustration no 2"
      },
      {
         "author": "System Administrator",
         "date": "2021-02-25T14:22:06.000Z",
         "text": "This is a TMF product order illustration"
      }
   ],
   "productOrderItem": [
      {
         "id": "POI130",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "actionReason": "adding service package OLI",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "USD",
                     "value": 20
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productCharacteristic": [
               {
                  "name": "Security Type",
                  "valueType": "Choice",
                  "value": "Base",
                  "previousValue": ""
               }
            ],
            "productSpecification": {
               "id": "a6514bd3534560102f18ddeeff7b1247",
               "name": "SD-WAN Security",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "a6514bd3534560102f18ddeeff7b1247",
               "@type": "ProductSpecificationRef"
            },
            "relatedParty": [
               {
                  "id": "4175939453126010a795ddeeff7b127d",
                  "name": "John Smith",
                  "email": "abc2@example.com",
                  "phone": "32456768",
                  "@type": "RelatedParty",
                  "@referredType": "OrderLineItemContact"
               },
               {
                  "id": "c175939453126010a795ddeeff7b127c",
                  "name": "Joe Doe",
                  "email": "abc@example.com",
                  "phone": "1234567890",
                  "@type": "RelatedParty",
                  "@referredType": "OrderLineItemContact"
               }
            ]
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalId": "69017a0f536520103b6bddeeff7b127d",
            "internalVersion": "1"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI100",
               "relationshipType": "HasParent"
            }
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      },
      {
         "id": "POI100",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productSpecification": {
               "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
               "name": "SD-WAN Service Package",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
               "@type": "ProductSpecificationRef"
            }
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalId": "69017a0f536520103b6bddeeff7b127d",
            "internalVersion": "1"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI130",
               "relationshipType": "HasChild"
            },
            {
               "id": "POI120",
               "relationshipType": "HasChild"
            },
            {
               "id": "POI110",
               "relationshipType": "HasChild"
            }
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      },
      {
         "id": "POI120",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "actionReason": "adding service package OLI",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "USD",
                     "value": 20
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productCharacteristic": [
               {
                  "name": "CPE Type",
                  "valueType": "Choice",
                  "value": "Physical",
                  "previousValue": ""
               },
               {
                  "name": "WAN Optimization",
                  "valueType": "Choice",
                  "value": "Advance",
                  "previousValue": ""
               },
               {
                  "name": "Routing",
                  "valueType": "Choice",
                  "value": "Premium",
                  "previousValue": ""
               },
               {
                  "name": "CPE Model",
                  "valueType": "Choice",
                  "value": "ASR",
                  "previousValue": ""
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202",
               "@type": "ProductSpecificationRef"
            }
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "69017a0f536520103b6bddeeff7b127d"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI100",
               "relationshipType": "HasParent"
            }
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      },
      {
         "id": "POI110",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "actionReason":"adding service package OLI",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "USD",
                     "value": 5
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productCharacteristic": [
               {
                  "name": "Tenancy",
                  "valueType": "Choice",
                  "value": "Base (10 site)",
                  "previousValue": ""
               }
            ],
            "productSpecification": {
               "id": "216663aa53702010cd6dddeeff7b12b5",
               "name": "SD-WAN Controller",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "216663aa53702010cd6dddeeff7b12b5",
               "@type": "ProductSpecificationRef"
            },
            "place": {
               "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
               "@type": "Place"
            }
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalId": "69017a0f536520103b6bddeeff7b127d",
            "internalVersion": "1"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI100",
               "relationshipType": "HasParent"
            }
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
   "state": "in_progress",
   "@type": "ProductOrder"
}

API de pedido de produto em aberto - PATCH /sn_ind_tmt_orn/productorder/

Atualiza a ordem do cliente especificada.

Importante:

Começando com Tokyo este endpoint foi descontinuado. A nova versão deste endpoint é API de pedido de produto em aberto - PATCH /sn_ind_tmt_orn/order/productOrder/.

Formato de URL

URL padrão: /api/sn_ind_tmt_orn/productorder/

Parâmetros de solicitação compatíveis

Tabela 31. Parâmetros de caminho
Nome	Descrição
id	Sys_id da ordem do cliente a ser atualizada. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]

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

Tabela 33. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
canal	Lista de canais a serem usados para vender os produtos. Tipo de dados: Matriz de objetos `"channel": [ { "id": "String", "name": "String" } ]` Armazenado em: sn_ind_tmt_ORM_ORM_ORDER
channel.id	Necessário se channelo parâmetro é usado. Identificador exclusivo do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Canal de distribuição [sn_prd_pm_distribution_channel]. Armazenado em: O campo de canal da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
channel.name	Nome do canal a ser usado para vender os produtos associados. Os nomes de canal possíveis são definidos na guia Lista de seleção na entrada Dicionário de canais da tabela sn_ind_tmt_ORM_order. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
committedDueDate	Data e hora em que a ação deve ser executada no pedido. Este valor deve ser igual ou posterior a committedDueDatevalores para cada item de linha do pedido. Se a ação para itens de linha do pedido for `suspender` ou `retomar` este parâmetro não pode ser atualizado. Tipo de dados: Cadeia de caracteres Armazenado em: O campo committed_due_date da tabela sn_ind_tmt_orn_order.
externalId	Identificador exclusivo da ordem do cliente. Este valor é determinado por um sistema externo. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_id da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz de objetos `"note": [ { "text": "String" } ]` Armazenado em: sn_ind_tmt_ORM_ORM_ORDER
note.text	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de comentários da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
OrderCurrency	Código da moeda do pedido e dos itens de linha do pedido. A atualização do código da moeda de um pedido existente não é compatível. Fornecer qualquer valor diferente do código da moeda já associado ao pedido faz com que a atualização seja rejeitada. Tipo de dados: Cadeia de caracteres
ProductOrderItem	Lista que descreve os itens associados ao pedido do produto e sua ação associada. Tipo de dados: Matriz de objetos `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "revisionOperation": "String", "@type": "String" } ]` Armazenado em: sn_ind_tmt_orn_order_line_item
ProductOrderItem.action	Necessário se productOrderItemo parâmetro é usado. Ação a ser realizada no produto. As ações possíveis são definidas na guia Lista de seleção na entrada Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Valores possíveis: adicionar mudança excluir nenhuma mudança resume suspender Tipo de dados: Cadeia de caracteres Armazenado em: O campo de ação da tabela sn_ind_tmt_orn_order_line_item. Padrão: Adicionar
ProductOrderItem.actionMotivo	Motivo para adicionar o item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo action_reason da tabela sn_ind_tmt_orn_order_line_item.
productOrderItem.committedDueDate	Data e hora em que a ação deve ser executada no item de linha do pedido. Se a ação do item for `suspender` ou `retomar` este parâmetro não pode ser atualizado. Tipo de dados: Cadeia de caracteres Armazenado em: O campo committed_due_date da tabela sn_ind_tmt_orn_order_line_item.
ProductOrderItem.externalProductInventory	Lista de IDs externos a serem mapeados para os inventários de produtos criados para o pedido. Tipo de dados: Matriz de objetos `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Nota: Anteriormente, ao criar um pedido DE PATCH com um ID de inventário de produto externo que já existia, a operação era anulada e retornava um erro. Com Xanadu Este parâmetro é simplesmente ignorado quando um ID de inventário de produto externo existente é fornecido e um erro não é gerado.
ProductOrderItem.externalProductInventory.externalProductInventoryId	ID externo a ser mapeado para o inventário do produto. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_inventory_id da tabela sn_ind_tmt_orn_order_line_item e o campo sn_prd_invt_external_id da tabela sn_prd_invt_product_inventory.
ProductOrderItem.id	Necessário se productOrderItemo parâmetro é usado. Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_id da tabela sn_ind_tmt_orn_order_line_item. Comprimento máximo: 40 Cadeia de caracteres em branco
productOrderItem.itemPrice	Lista que descreve o preço associado ao produto. Tipo de dados: Matriz de objetos `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Armazenado em: sn_ind_tmt_ORM_ORM_ORDER Cadeia de caracteres em branco
productOrderItem.itemPrice.price	Descrição do preço do produto associado. Tipo de dados: Objeto `"price": { "taxIncludedAmount": {Object} }` Armazenado em: sn_ind_tmt_orn_order_line_item Cadeia de caracteres em branco
productOrderItem.itemPrice.price.taxIncludedAmount	Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: Objeto `"taxIncludedAmount": { "unit": "String", "value": Number }` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Código da moeda no qual o preço é representado. Tipo de dados: Cadeia de caracteres Armazenado em: O campo mrc ou nrc na tabela sn_ind_tmt_orn_order_line_item.
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preço do produto, incluindo qualquer imposto. Tipo de dados: Número Armazenado em: O campo mrc ou nrc na tabela sn_ind_tmt_orn_order_line_item.
productOrderItem.itemPrice.priceType	Tipo de preço do item, recorrente ou não recorrente. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.recurringChargePeriod	Se o preço for recorrente, o período recorrente, como `mês` . Tipo de dados: Cadeia de caracteres
productOrderItem.product	Necessário se productOrderItem.actioné mudança ou exclusão. Descrição dos detalhes da instância do produto comprado pelo cliente. Tipo de dados: Objeto `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.product.id	Necessário se productOrderItem.actioné mudança ou exclusão. Identificador exclusivo do produto vendido. Localizado no campo sys_id ou sn_ind_tmt_orn_external_id da tabela Inventário de produto [sn_ind_tmt_orn_product_inventory]. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
productOrderItem.product.place	Mapas dos locais nos quais o produto será instalado. Tipo de dados: Objeto `"place": { "id": "String", "@type": "String" }` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.product.place.id	Necessário se productOrderItem.product.placeo parâmetro é usado. Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de local da tabela sn_ind_tmt_orn_order_line_item. Cadeia de caracteres em branco
productOrderItem.product.place.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Lugar` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic	Lista de características do produto associado. Tipo de dados: Matriz de objetos `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]` Armazenado em: sn_ind_tmt_orn_order_characteric_value
productOrderItem.product.productCharacteristic.name	Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica [sn_prd_pm_characteric]. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de características da tabela sn_ind_tmt_orn_order_characteristic_value. Cadeia de caracteres em branco
productOrderItem.product.productCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para um pedido de mudança. A solicitação é uma ordem de mudança se productOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres Armazenado em: Previous_characteric_option_value da tabela sn_ind_tmt_orn_order_characteristic_value. Cadeia de caracteres em branco
productOrderItem.product.productCharacteristic.value	Valores de opção de característica associados ao produto. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres Armazenado em: O campo characteric_option_value da tabela sn_ind_tmt_orn_order_characteristic_value. Cadeia de caracteres em branco
productOrderItem.product.productCharacteristic.valueType	Tipo de valor de característica. Tipo de dados: Cadeia de caracteres Valores possíveis: matriz.data array.datetime array.decimal array.integer array.object teste de linha única.array caixa de seleção escolha data, endereço e-mail inteiro,data/hora objeto texto de linha única sim/não
productOrderItem.product.productSpecification	Descrição da especificação do produto associada ao produto. Nota: Ordens de mudança ( productOrderItem.action. `mudança` ) são processados de forma diferente com base no valor de sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrderpropriedade do sistema. O valor desta propriedade do sistema determina como o pedido será processado se o inventário do produto for uma versão diferente da indicada no pedido. Quando esta propriedade do sistema é definida como verdadeira (padrão), o inventário do produto é atualizado automaticamente para a versão no pedido, alterando a especificação do produto referenciado. Isso permite que o pedido seja processado com sucesso. Se esta propriedade do sistema estiver definida como falsa, se o inventário do produto for uma versão diferente da indicada no pedido, o pedido falhará devido à incompatibilidade da versão. Tipo de dados: Objeto `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.product.productSpecification.id	Necessário se productOrderItem.product.productSpecificationo parâmetro é usado. Initial_version ou external_id da especificação do produto. Initial_version é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.internalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.name	Nome da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.version	External_version da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.@type	Parte do padrão TMF Open API. Este valor é sempre `ProductSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty	Lista de contatos para itens de linha. Tipo de dados: Matriz de objetos `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Armazenado em: sn_ind_tmt_orn_order_line_item_contact
productOrderItem.product.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de e-mail da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.firstName	Nome do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo first_name da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.id	Sys_id do contato do item de linha associado ao item de linha do pedido. Localizado na tabela Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]. Tipo de dados: Cadeia de caracteres Armazenado em: O campo sys_id da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.lastName	Sobrenome do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo lastName da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo business_phone da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.@referredType	Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.@type	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Produto` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering	Descrição da oferta de produto associada ao produto. Tipo de dados: Objeto `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.productOffering.id	Necessário se productOrderItem.productOfferingo parâmetro é usado. Initial_version ou external_id da oferta de produto. Initial_version é o sys_id da primeira versão da oferta. Localizado no campo sys_id ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.internalVersion	Versão da oferta do produto. Tipo de dados: Cadeia de caracteres Tabela: Oferta de produto [sn_prd_pm_product_offering]
productOrderItem.productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.version	External_version da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: Oferta de produto [sn_prd_pm_product_offering]
productOrderItem.productOrderItem.quantity	Número de itens associados a serem solicitados. Tipo de dados: Número Armazenado em: O campo Quantidade do sn_ind_tmt_orn_order. Padrão: Nulo
productOrderItem.productOrderItemRelationship	Lista de relacionamentos entre itens de linha do pedido. Tipo de dados: Matriz de objetos `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.productOrderItemRelationship.id	Necessário se productOrderItem.productOrderItemRelationshipo parâmetro é usado. Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres Armazenado em: O campo parent_line_item da tabela bsn_ind_tmt_orn_order_line_item. Cadeia de caracteres em branco
productOrderItem.productOrderItemRelationship.relationshipType	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: HasChild HasParent Requer `HasChild` e. `HasParent` são usados para relacionamentos primário/secundário. `Requer` é usado para relacionamentos horizontais (um item de linha requer outro item de linha). Tipo de dados: Cadeia de caracteres
ProductOrderItem.Quantidade	Número de itens solicitados. Tipo de dados: Número Armazenado em: O campo Quantidade da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
ProductOrderItem.revisionOperation	Tipo de atualização a ser executada no item de linha. Se este valor estiver vazio, o item de linha existente será atualizado ou um novo item de linha será adicionado se ainda não existir. Se este valor for `cancelar` , o item de linha foi cancelado. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
ProductOrderItem. No tipo	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Deve listar pelo menos um item que contém informações da conta do cliente ou da conta do consumidor. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
IdentidadeRelatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. 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. Em	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres Armazenado em: O campo expected_end_date da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres Armazenado em: O campo expected_start_date da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
.	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrder` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Cabeçalhos

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

Tabela 36. Códigos de status
Código do status	Descrição
201	Bem-sucedido. Se houver problemas com as características ou as informações da opção de características, o endpoint armazenará os seguintes comentários nos campos de anotações de trabalho do registro de item de linha de pedido do cliente associado: `As seguintes características do item do pedido não existem: Revisar especificação > characteristic.name> e corrija a característica e a opção de característica no item de linha do pedido antes de aprovar o pedido.` `Característica do item do pedido characteristic.name> com valor de característica: > characteristic.value> é inválido. Corrija os valores das características antes de aprovar o pedido.`
400	Solicitação Incorreta. Qualquer um dos seguintes motivos: `Carga inválida: Corpo da solicitação ausente` A carga não foi passada no corpo da solicitação. `Carga inválida: ProductOrderItem está ausente` Objeto de item de linha de pedido do produto ou JSON ausente. `Carga inválida: O ID de productOrderItem está ausente` - O. ido parâmetro está ausente no item de linha do pedido do produto da carga. `Carga inválida: A ação productOrderItem está ausente` - O. actiono parâmetro está ausente no item de linha do pedido do produto da carga. `Carga inválida: ProductOrderItem productOffering está ausente` - O objeto de oferta do produto ou JSON está ausente no item de linha do pedido do produto na carga. `Carga inválida: O ID de productOffering está ausente` - O. ido parâmetro está ausente no item de linha do pedido do produto do objeto de oferta do produto na carga. `Carga inválida: A oferta de produto não existe` - A oferta de produto no item de linha do pedido do produto não é válida. `Carga inválida: O produto productOrderItem está ausente` - O objeto do produto ou JSON no item de linha do pedido do produto está ausente na carga. `Carga inválida: O produto ProductSpecification está ausente` - O objeto de especificação do produto ou JSON no item de linha do pedido do produto está ausente na carga. `Carga inválida: O ID de especificação do produto está ausente` - O. ido parâmetro no item de linha do pedido do produto do objeto de especificação do produto está ausente na carga. `Carga inválida: A especificação do produto não existe` - A especificação do produto no item de linha do pedido do produto não é válida. `Carga inválida: O inventário do produto não existe` - Em um pedido de mudança (ação: Mudança), a quantidade de um item é maior do que a quantidade em estoque. `Carga inválida: O ID do inventário do produto está ausente` - Em uma ordem de mudança, o. product.idestá ausente na carga. `Carga inválida: O produto vendido está inativo` - Em um pedido de mudança, um produto especificado na carga está inativo. `Carga inválida: RelatedParty está ausente` - O objeto da parte relacionada está ausente na carga. `Carga inválida: A conta do cliente ou o consumidor está ausente` - O objeto do cliente ou consumidor da parte relacionada está ausente na carga. `Carga inválida: O consumidor não existe` - O consumidor da parte relacionada especificada não existe no ServiceNow instância. `Carga inválida: A conta do cliente não existe` - O cliente da parte relacionada especificada não existe no ServiceNow instância. `Carga inválida: Falha na criação do pedido` - Não foi possível criar o pedido solicitado. `Carga inválida: Este pedido ainda não foi criado na tabela de pedido do cliente. Verifique na fila de entrada para obter mais detalhes.` - A solicitação de patch foi feita para um pedido que ainda não está na tabela de pedidos do cliente. A ordem está na tabela Fila de entrada [sn_tmt_core_inbound_queue] aguardando que o programador escolha o registro a ser processado. `Carga inválida: A solicitação de patch não pode ser feita porque o tipo de execução do pedido não é "entregar".` - A solicitação de patch foi feita para um pedido que tem um tipo de execução diferente de deliver.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
canal	Lista de canais a serem usados para vender os produtos. Tipo de dados: Matriz de objetos `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificador exclusivo do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
channel.name	Nome do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
id	Sys_id da ordem do cliente atualizada para esta solicitação. Tipo de dados: Cadeia de caracteres
externalId	Identificador externo da ordem de venda, como um número de ordem de compra. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz de objetos `"note": [ { "text": "String" } ]`
note.text	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres
ProductOrderItem	Lista que descreve os itens associados ao pedido do produto e sua ação associada. Tipo de dados: Matriz de objetos `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
ProductOrderItem.action	Ação a ser realizada no produto. As ações possíveis são definidas na guia Lista de seleção na entrada Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Tipo de dados: Cadeia de caracteres
ProductOrderItem.actionMotivo	Motivo para adicionar o item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo action_reason da tabela sn_ind_tmt_orn_order_line_item.
productOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice	Lista que descreve o preço associado ao produto. Tipo de dados: Matriz de objetos `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Descrição do preço do produto associado. Tipo de dados: Objeto `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: Objeto `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	Código da moeda no qual o preço é representado. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.price.taxIncludeAmount.value	Preço do produto, incluindo qualquer imposto. Tipo de dados: Número
productOrderItem.itemPrice.priceType	Tipo de preço do item, recorrente ou não recorrente. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.recurringChargePeriod	Se o preço for recorrente, o período recorrente, como `mês` . Tipo de dados: Cadeia de caracteres
productOrderItem.product	Descrição dos detalhes da instância do produto comprado pelo cliente. Tipo de dados: Objeto `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.id	Identificador exclusivo do produto vendido. Localizado no campo sys_id ou sn_ind_tmt_orn_external_id da tabela Inventário de produto [sn_ind_tmt_orn_product_inventory]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.place	Mapas dos locais nos quais o produto será instalado. Tipo de dados: Objeto `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic	Lista de características do produto associado. Tipo de dados: Matriz de objetos `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica [sn_prd_pm_characteric]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para um pedido de mudança. A solicitação é uma ordem de mudança se productOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.value	Valores de opção de característica associados ao produto. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification	Descrição da especificação do produto associada ao produto. Tipo de dados: Objeto `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id da especificação do produto. Initial_version é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.name	Nome da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.@type	Parte do padrão TMF Open API. Este valor é sempre `ProductSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty	Lista de contatos para itens de linha. Tipo de dados: Matriz de objetos `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.firstName	Nome do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.id	Sys_id do contato do item de linha associado ao item de linha do pedido. Localizado na tabela Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.lastName	Sobrenome do contato. Tipo de dados: Cadeia de caracteres Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@referredType	Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.@type	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Produto` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering	Descrição da oferta de produto associada ao produto. Tipo de dados: Objeto `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id da oferta de produto. Initial_version é o sys_id da primeira versão da oferta. Localizado no campo sys_id ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOrderItemRelationship	Lista de relacionamentos entre itens de linha do pedido. Tipo de dados: Matriz de objetos `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOrderItemRelationship.relationshipType	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Tipo de dados: Cadeia de caracteres
ProductOrderItem.Quantidade	Número de itens associados a serem solicitados. Tipo de dados: Número
ProductOrderItem.state	Estado atual do item do pedido do produto. Tipo de dados: Cadeia de caracteres
ProductOrderItem. No tipo	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Deve listar pelo menos um item que contém informações da conta do cliente ou da conta do consumidor. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty.type	Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
estado	Estado atual do pedido. Tipo de dados: Cadeia de caracteres
.	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrder` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo de código a seguir atualiza o canal de uma ordem de cliente.

curl -X PATCH "https://instance.servicenow.com/api/sn_ind_tmt_orm/productorder/6be0a925c3a220103e2e73ce3640ddfe" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
  "channel": [
    {
      "id": "1",
      "name": "Agent Assist"
    }
  ]
}

Corpo da resposta.

{
    "requestedCompletionDate": "2021-05-02T08:13:59.506Z",
    "requestedStartDate": "2020-05-03T08:13:59.506Z",
    "externalId": "PO-456",
    "channel": [
        {
            "id": "1",
            "name": "Agent Assist"
        }
    ],
    "note": [
        {
            "text": "This is a TMF product order illustration"
        },
        {
            "text": "This is a TMF product order illustration no 2"
        }
    ],
    "productOrderItem": [
        {
            "id": "POI100",
            "quantity": 1,
            "action": "change",
            "actionReason":"adding service package OLI",
            "product": {
                "id": "fa6d13f45b5620102dff5e92dc81c77f",
                "@type": "Product",
                "productSpecification": {
                    "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
                    "name": "SD-WAN Service Package",
                    "@type": "ProductSpecificationRef"
                },
                "place": {
                    "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                    "@type": "Place"
                }
            },
            "productOffering": {
                "id": "69017a0f536520103b6bddeeff7b127d",
                "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
                {
                    "id": "POI120",
                    "relationshipType": "HasChild"
                },
                {
                    "id": "POI130",
                    "relationshipType": "HasChild"
                }
            ],
            "@type": "ProductOrderItem",
            "state": "new"
        },
        {
            "id": "POI120",
            "quantity": 1,
            "action": "change",
            "actionReason":"adding service package OLI",
            "itemPrice": [
                {
                    "priceType": "recurring",
                    "recurringChargePeriod": "month",
                    "price": {
                        "taxIncludedAmount": {
                            "unit": "USD",
                            "value": 20
                        }
                    }
                }
            ],
            "product": {
                "id": "766d13f45b5620102dff5e92dc81c78a",
                "@type": "Product",
                "productCharacteristic": [
                    {
                        "name": "WAN Optimization"
                        "valueType": "Choice",
                        "value": "Base",
                        "previousValue": "Advance"
                    }
                ],
                "productSpecification": {
                    "id": "39b627aa53702010cd6dddeeff7b1202",
                    "name": "SD-WAN Edge Device",
                    "@type": "ProductSpecificationRef"
                },
                "relatedParty": [
                    {
                        "id": "51670151c35420105252716b7d40ddfe",
                        "firstName": "Joe",
                        "lastName": "Doe",
                        "email": "abc@example.com",
                        "phone": "1234567890",
                        "@type": "RelatedParty",
                        "@referredType": "OrderLineItemContact"
                    }
                ],
                "place": {
                    "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                    "@type": "Place"
                }
            },
            "productOffering": {
                "id": "69017a0f536520103b6bddeeff7b127d",
                "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
                {
                    "id": "POI100",
                    "relationshipType": "HasParent"
                }
            ],
            "@type": "ProductOrderItem",
            "state": "new"
        },
        {
            "id": "POI130",
            "quantity": 1,
            "action": "add",
            "actionReason":"adding service package OLI",
            "itemPrice": [
                {
                    "priceType": "recurring",
                    "recurringChargePeriod": "month",
                    "price": {
                        "taxIncludedAmount": {
                            "unit": "USD",
                            "value": 20
                        }
                    }
                }
            ],
            "product": {
                "@type": "Product",
                "productCharacteristic": [
                    {
                        "name": "Security Type",
                        "valueType": "Choice",
                        "value": "Base",
                        "previousValue": "Advance"
                    }
                ],
                "productSpecification": {
                    "id": "a6514bd3534560102f18ddeeff7b1247",
                    "name": "SD-WAN Security",
                    "@type": "ProductSpecificationRef"
                },
                "relatedParty": [
                    {
                        "id": "51670151c35420105252716b7d40ddfe",
                        "firstName": "Joe",
                        "lastName": "Doe",
                        "email": "abc@example.com",
                        "phone": "1234567890",
                        "@type": "RelatedParty",
                        "@referredType": "OrderLineItemContact"
                    }
                ],
                "place": {
                    "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                    "@type": "Place"
                }
            },
            "productOffering": {
                "id": "69017a0f536520103b6bddeeff7b127d",
                "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
                {
                    "id": "POI100",
                    "relationshipType": "HasParent"
                }
            ],
            "@type": "ProductOrderItem",
            "state": "new"
        }
    ],
    "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
    "@type": "ProductOrder",
    "id": "6be0a925c3a220103e2e73ce3640ddfe",
    "state": "in_progress"
}

API de pedido de produto em aberto - POST /sn_ind_tmt_orn/cancelproductorder

Cancela a ordem do cliente especificada.

Formato de URL

URL padrão: /api/sn_ind_tmt_orn/cancelproductorder

Parâmetros de solicitação compatíveis

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

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

Tabela 39. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
CancelationMotivo	Motivo do cancelamento. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
ProductOrder	Contém dados sobre o pedido do produto. Tipo de dados: Objeto `"productOrder": { "id": "String", "href": "String", "@referredType": "String" }`
productOrder.id	Obrigatório. Sys_id da ordem do cliente a ser cancelada. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]
ProductOrder.href	URL da ordem do cliente a ser cancelada. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
ProductOrder. Em referredType	O valor deste parâmetro deve ser `ProductOrder` . Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
CancellationDate solicitada	Data para cancelar o pedido. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
.	O valor deste parâmetro deve ser `CancelProductOrder` . Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco

Cabeçalhos

Tabela 40. 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 41. 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 42. Códigos de status
Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Qualquer um dos seguintes motivos: Carga vazia. Carga inválida. Campo obrigatório ausente: <field name>. ID de pedido inválido. ID de pedido inválido: `Este pedido ainda não foi criado na tabela de pedido de venda` . A solicitação de cancelamento foi feita para um pedido que ainda não foi criado. A ordem está na tabela Fila de entrada [sn_tmt_core_inbound_queue] aguardando que o programador escolha o registro.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
CancelationMotivo	Motivo do cancelamento. Tipo de dados: Cadeia de caracteres
href	URL do pedido cancelado. Tipo de dados: Cadeia de caracteres
id	Sys_id do pedido cancelado. Tipo de dados: Cadeia de caracteres
ProductOrder	Dados sobre o pedido do produto. Tipo de dados: Objeto `"productOrder": { "id": "String", "href": "String", "@referredType": "String" }`
ProductOrder.id	Sys_id do pedido cancelado. Tipo de dados: Cadeia de caracteres
ProductOrder.href	URL do pedido cancelado. Tipo de dados: Cadeia de caracteres
ProductOrder. Em referredType	O valor deste parâmetro é `ProductOrder` . Tipo de dados: Cadeia de caracteres
CancellationDate solicitada	Data para cancelar o pedido. Tipo de dados: Cadeia de caracteres
estado	Estado do cancelamento. Se a solicitação de cancelamento foi processada com sucesso (código de status 201), o valor desse parâmetro será `concluído` . Tipo de dados: Cadeia de caracteres
.	O valor deste parâmetro é `CancelProductOrder` . Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo de código a seguir cancela um pedido de cliente.

curl -X POST "https://instance.servicenow.com/api/sn_ind_tmt_orm/cancelproductorder" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
    "cancellationReason": "Duplicate order",
    "requestedCancellationDate": "2019-04-30T12:56:21.931Z",
    "productOrder": {
        "id": "163ee2805358811032a4ddeeff7b122d",
        "href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b",
        "@referredType": "ProductOrder"
    },
    "@type": "CancelProductorder"
}

{
    "id": "163ee2805358811032a4ddeeff7b122d",
    "href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b",
    "cancellationReason": "Duplicate order",
    "requestedCancellationDate": "2019-04-30T12:56:21.931Z",
    "@type": "CancelProductorder",
    "productOrder": {
        "id": "163ee2805358811032a4ddeeff7b122d",
        "href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b",
        "@referredType": "ProductOrder"
    },
    "state": "done"
}

API de pedido de produto em aberto - POST /sn_ind_tmt_orn/order/productOrder

Cria a ordem de venda especificada e os itens de linha de ordem de venda.

Uma vez processados, os registros são criados nas seguintes tabelas:

Pedido do cliente [sn_ind_tmt_orn_order]
Ordem de característica [sn_ind_tmt_orn_order_characteric_value]
Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]
Itens relacionados à linha de pedido [sn_ind_tmt_orn_order_line_related_items]

Formato de URL

URL padrão: /api/sn_ind_tmt_orn/order/productOrder

Parâmetros de solicitação compatíveis

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

Tabela 44. Parâmetros de consulta
Nome	Descrição
modo	Habilita o processamento assíncrono de pedidos. Ou seja, o pedido é adicionado à tabela Fila de entrada [sn_tmt_core_inbound_queue] a ser criada. Se não estiver incluído, o pedido será processado de forma síncrona. Valor válido: Assíncrono Tipo de dados: Cadeia de caracteres

Tabela 45. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
canal	Lista de canais a serem usados para vender os produtos. Tipo de dados: Matriz de objetos `"channel": [ { "id": "String", "name": "String" } ]` Armazenado em: sn_ind_tmt_ORM_ORM_ORDER
channel.id	Obrigatório. Identificador exclusivo do canal a ser usado para vender os produtos associados. Os valores de ID do canal estão localizados no campo external_id da tabela Canal de distribuição [sn_prd_pm_distribution_channel]. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de canal da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
channel.name	Nome do canal a ser usado para vender os produtos associados. Os nomes de canal possíveis são definidos na guia Lista de seleção na entrada Dicionário de canais da tabela sn_ind_tmt_ORM_order. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
committedDueDate	Data e hora em que a ação deve ser executada no pedido. Este valor deve ser igual ou posterior a committedDueDatevalores para cada item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo committed_due_date da tabela sn_ind_tmt_orn_order.
externalId	Identificador exclusivo da ordem do cliente. Este valor é determinado por um sistema externo. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_id da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
nota	Anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz de objetos `"note": [ { "text": "String" } ]` Armazenado em: sn_ind_tmt_ORM_ORM_ORDER
note.text	Obrigatório. Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de comentários da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
OrderCurrency	Obrigatório. Código da moeda do pedido e dos itens de linha do pedido. A moeda deve ser a mesma para todos os elementos do pedido e dos itens de linha do pedido, caso contrário, um erro será retornado e o pedido não será criado. Depois que um pedido é criado, seu código de moeda não pode ser alterado. Tipo de dados: Cadeia de caracteres
ProductOrderItem	Obrigatório. Itens associados ao pedido do produto e à ação associada. Tipo de dados: Matriz de objetos `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ]` Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
ProductOrderItem.action	Obrigatório. Ação a ser realizada no produto. As ações possíveis são definidas na guia Lista de seleção na entrada Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Valores possíveis: adicionar mudança excluir nenhuma mudança resume suspender Tipo de dados: Cadeia de caracteres Armazenado em: O campo de ação da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item].
ProductOrderItem.actionMotivo	Opcional. Descrição do motivo do item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo action_reason da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item].
productOrderItem.committedDueDate	Data e hora em que a ação deve ser executada no item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo committed_due_date da tabela Item de linha do pedido [sn_ind_tmt_ORM_order_line_item].
ProductOrderItem.externalProductInventory	IDs externos a serem mapeados para os inventários de produtos criados para o pedido. Tipo de dados: Matriz de objetos `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
ProductOrderItem.externalProductInventory.externalProductInventoryId	ID externo a ser mapeado para o inventário do produto. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_inventory_id da tabela Item de linha do pedido [sn_ind_tmt_ORM_order_line_item] e o campo sn_prd_invt_external_id da tabela sn_prd_invt_product_inventory.
productOrderItem.id	Obrigatório. Identificador exclusivo do item de linha. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Comprimento máximo: 40 Cadeia de caracteres em branco
productOrderItem.itemPrice	Preço associado ao produto. Tipo de dados: Matriz de objetos `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Armazenado em: sn_ind_tmt_ORM_ORM_ORDER Cadeia de caracteres em branco
productOrderItem.itemPrice.price	Descrição do preço do produto associado. Tipo de dados: Objeto `"price": { "taxIncludedAmount": {Object} }` Item de linha do pedido [sn_ind_tmt_orn_order_line_item] Cadeia de caracteres em branco
productOrderItem.itemPrice.price.taxIncludedAmount	Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: Objeto `"taxIncludedAmount": { "unit": "String", "value": Number }` Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Código da moeda no qual o preço é expresso. Tipo de dados: Cadeia de caracteres Armazenado em: O campo mrc ou nrc da tabela Item de linha do pedido [sn_ind_tmt_ORM_order_line_item]
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preço do produto, incluindo qualquer imposto. Tipo de dados: Número Armazenado em: O campo mrc ou nrc da tabela Item de linha do pedido [sn_ind_tmt_ORM_order_line_item]
productOrderItem.itemPrice.priceType	Especifica se o preço do item é recorrente ou não. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.recurringChargePeriod	Se o preço for recorrente, o período recorrente, como `mês` . Tipo de dados: Cadeia de caracteres
productOrderItem.product	Necessário se productOrderItem.actioné mudança ou exclusão. Detalhes da instância do produto comprado pelo cliente. Tipo de dados: Objeto `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
productOrderItem.product.id	Necessário se productOrderItem.actioné mudança ou exclusão. Identificador exclusivo do produto vendido. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco Tabela: No campo sys_id ou sn_ind_tmt_orn_external_id da tabela Inventário de produto [sn_ind_tmt_orn_product_inventory].
productOrderItem.product.place	Mapas dos locais nos quais o produto será instalado. Tipo de dados: Objeto `"place": { "id": "String", "@type": "String" }` Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
productOrderItem.product.place.id	Obrigatório. Sys_id do registro de local associado. Tipo de dados: Cadeia de caracteres Tabela: Local [cmn_location] Armazenado em: O campo de local da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item].
productOrderItem.product.place.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Lugar` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic	Caraterísticas do produto associado. Tipo de dados: Matriz de objetos `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]` Armazenado em: sn_ind_tmt_orn_order_characteric_value
productOrderItem.product.productCharacteristic.name	Nome do registro de característica a ser associado ao produto. Tipo de dados: Cadeia de caracteres Tabela: Característica [sn_prd_pm_characteric] Armazenado em: O campo de características da tabela sn_ind_tmt_orn_order_characteristic_value. Cadeia de caracteres em branco
productOrderItem.product.productCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para pedido de mudança. A solicitação é uma ordem de mudança se productOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres Armazenado em: O campo previous_characteristic_option_value da tabela sn_ind_tmt_orn_order_characteristic_value. Cadeia de caracteres em branco
productOrderItem.product.productCharacteristic.value	Valores de opção de característica associados ao produto. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres Armazenado em: O campo characteric_option_value da tabela sn_ind_tmt_orn_order_characteristic_value. Cadeia de caracteres em branco
productOrderItem.product.productCharacteristic.valueType	Tipo de valor de característica. Valores possíveis: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Teste de linha única Caixa de seleção Escolha Data, Endereço E-mail Inteiro, Data/Hora Objeto Texto de Linha Única Sim/Não Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification	Opcional. Descrição da especificação do produto associada ao produto. Nota: Ordens de mudança ( productOrderItem.action. `mudança` ) são processados de forma diferente com base no valor de sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrderpropriedade do sistema. O valor desta propriedade do sistema determina como o pedido será processado se o inventário do produto for uma versão diferente da indicada no pedido. Quando esta propriedade do sistema é definida como verdadeira (padrão), o inventário do produto é atualizado automaticamente para a versão no pedido, alterando a especificação do produto referenciado. Isso permite que o pedido seja processado com sucesso. Se esta propriedade do sistema estiver definida como falsa, se o inventário do produto for uma versão diferente da indicada no pedido, o pedido falhará devido à incompatibilidade da versão. Tipo de dados: Objeto `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.product.productSpecification.id	Obrigatório. Versão inicial ou ID externo da especificação do produto. A versão inicial é o sys_id da primeira versão da especificação. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.internalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Especificação do produto [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.name	Nome da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.version	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.@type	Parte do padrão TMF Open API. Este valor é sempre `ProductSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty	Lista de funções de terceiros vinculadas a um OrderLineItemContact. Tipo de dados: Matriz de objetos `"relatedParty": [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Armazenado em: sn_ind_tmt_orn_order_line_item_contact
productOrderItem.product.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de e-mail da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.firstName	Nome do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo first_name da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.lastName	Sobrenome do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo lastName da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo business_phone da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.@referredType	Obrigatório. Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.@type	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Produto` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering	Obrigatório. Descrição da oferta de produto associada ao produto. Tipo de dados: Objeto `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.productOffering.id	Obrigatório. Versão inicial ou ID externo da oferta de produto. A versão inicial é o sys_id da primeira versão da oferta. Tipo de dados: Cadeia de caracteres Tabela: Oferta de produto [sn_prd_pm_product_offering]
productOrderItem.productOffering.internalVersion	Versão da oferta do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].
productOrderItem.productOffering.name	Nome da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: Oferta de produto [sn_prd_pm_product_offering]
productOrderItem.productOffering.version	Versão externa da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].
productOrderItem.productOrderItem.quantity	Número de itens associados a serem solicitados. Tipo de dados: Número Armazenado em: O campo Quantidade da tabela sn_ind_tmt_orn_order. Padrão: Nulo
productOrderItem.productOrderItemRelationship	Obrigatório. Lista que descreve o relacionamento primário/secundário entre os itens do pedido. Tipo de dados: Matriz de objetos `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.productOrderItemRelationship.id	Obrigatório. Igual a productOrderItem.idvalor. Usado para relacionamento primário/secundário Tipo de dados: Cadeia de caracteres Armazenado em: O campo parent_line_item da tabela sn_ind_tmt_orn_order_line_item. Cadeia de caracteres em branco
productOrderItem.productOrderItemRelationship.relationshipType	Obrigatório. Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: HasChild HasParent Tipo de dados: Cadeia de caracteres
ProductOrderItem.Quantidade	Número de itens solicitados. Tipo de dados: Número Armazenado em: O campo Quantidade da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
ProductOrderItem. No tipo	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Deve listar pelo menos um item que contém informações da conta do cliente ou da conta do consumidor. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id da conta ou contato do cliente associado ao pedido. Tipo de dados: Cadeia de caracteres Tabela: Conta [customer_account], tabela Contato [customer_contact] ou Consumidor [csm_consumer]
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Obrigatório. Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres Armazenado em: O campo expected_end_date da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres Armazenado em: O campo expected_start_date da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
.	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrder` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Cabeçalhos

Tabela 46. 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 47. 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 48. Códigos de status
Código do status	Descrição
201	Bem-sucedido. Se houver problemas com as características ou as informações da opção de características, o endpoint armazenará os seguintes comentários nos campos de anotações de trabalho do registro de item de linha de pedido do cliente associado: `As seguintes características do item do pedido não existem: Revisar especificação > characteristic.name> e corrija a característica e a opção de característica no item de linha do pedido antes de aprovar o pedido.` `Característica do item do pedido characteristic.name> com valor de característica: > characteristic.value> é inválido. Corrija os valores das características antes de aprovar o pedido.`
202	Aceito. Solicitação bem-sucedida de um pedido no modo assíncrono. Ou seja, a solicitação foi feita com modeparâmetro definido como `assíncrono` E o registro está programado para ser processado na tabela Fila de entrada [sn_tmt_core_inbound_queue].
400	Solicitação Incorreta. Qualquer um dos seguintes motivos: `Carga inválida: Corpo da solicitação ausente` A carga não foi passada no corpo da solicitação. `Carga inválida: ProductOrderItem está ausente` Objeto de item de linha de pedido do produto ou JSON ausente. `Carga inválida: O ID de productOrderItem está ausente` - O. ido parâmetro está ausente no item de linha do pedido do produto da carga. `Carga inválida: A ação productOrderItem está ausente` - O. actiono parâmetro está ausente no item de linha do pedido do produto da carga. `Carga inválida: ProductOrderItem productOffering está ausente` - O objeto de oferta do produto ou JSON está ausente no item de linha do pedido do produto na carga. `Carga inválida: O ID de productOffering está ausente` - O. ido parâmetro está ausente no item de linha do pedido do produto do objeto de oferta do produto na carga. `Carga inválida: A oferta de produto não existe` - A oferta de produto no item de linha do pedido do produto não é válida. `Carga inválida: O produto productOrderItem está ausente` - O objeto do produto ou JSON no item de linha do pedido do produto está ausente na carga. `Carga inválida: O produto ProductSpecification está ausente` - O objeto de especificação do produto ou JSON no item de linha do pedido do produto está ausente na carga. `Carga inválida: O ID de especificação do produto está ausente` - O. ido parâmetro no item de linha do pedido do produto do objeto de especificação do produto está ausente na carga. `Carga inválida: A especificação do produto não existe` - A especificação do produto no item de linha do pedido do produto não é válida. `Carga inválida: O inventário do produto não existe` - Em um pedido de mudança (ação: Mudança), a quantidade de um item é maior do que a quantidade em estoque. `Carga inválida: O ID do inventário do produto está ausente` - Na ordem de mudança, o. product.idestá ausente na carga. `Carga inválida: O produto vendido está inativo` - Em um pedido de mudança, um produto especificado na carga está inativo. `Carga inválida: RelatedParty está ausente` - O objeto da parte relacionada está ausente na carga. `Carga inválida: A conta do cliente ou o consumidor está ausente` - O objeto do cliente ou consumidor da parte relacionada está ausente na carga. `Carga inválida: O consumidor não existe` - O consumidor da parte relacionada especificada não existe no ServiceNow instância. `Carga inválida: A conta do cliente não existe` - O cliente da parte relacionada especificada não existe no ServiceNow instância. `Carga inválida: Falha na criação do pedido` - Não foi possível criar o pedido solicitado. `Carga inválida: OrderCurrency é necessária` - O. orderCurrencyo parâmetro está ausente na carga. `Código da moeda inativa: <currency>` - A moeda fornecida está inativa no ServiceNow instância. `Um ou mais itens de linha têm um código de moeda diferente da moeda do pedido` - Todos os itens de linha não têm o mesmo código de moeda que a moeda do pedido. `Revisão em andamento para a moeda do pedido não compatível` - O. orderCurrencyo parâmetro não pode ser atualizado depois que o pedido é criado.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
canal	Lista de canais a serem usados para vender os produtos. Tipo de dados: Matriz de objetos `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificador exclusivo do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
channel.name	Nome do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
committedDueDate	Data e hora em que a ação deve ser executada no pedido. Este valor deve ser igual ou posterior a committedDueDatevalores para cada item de linha do pedido. Tipo de dados: Cadeia de caracteres
externalId	Identificador externo da ordem de venda, como um número de ordem de compra. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro do pedido do produto. Tipo de dados: Cadeia de caracteres
id	Sys_id da ordem de venda criada para esta solicitação. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz de objetos `"note": [ { "text": "String" } ]`
note.text	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres
OrderCurrency	Código da moeda do pedido e dos itens de linha do pedido. Tipo de dados: Cadeia de caracteres
orderId	Sys_id do pedido a ser criado. Na solicitação bem-sucedida, o pedido é adicionado à tabela Fila de entrada [sn_tmt_core_inbound_queue] em uma programação a ser processada. Nota: Este valor será o único resultado se o pedido for criado de forma assíncrona usando o. modeparâmetro de consulta. `{ "orderId": "b0fc877ac3ab5110856d73ce3640dde0" }` Tipo de dados: Cadeia de caracteres
ProductOrderItem	Lista que descreve os itens associados ao pedido do produto e sua ação associada. Tipo de dados: Matriz de objetos `"productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
ProductOrderItem.action	Ação a ser realizada no produto. As ações possíveis são definidas na guia Lista de seleção na entrada Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Tipo de dados: Cadeia de caracteres
ProductOrderItem.actionMotivo	Motivo para adicionar o item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo action_reason da tabela sn_ind_tmt_orn_order_line_item.
productOrderItem.committedDueDate	Data e hora em que a ação deve ser executada no item de linha do pedido. Tipo de dados: Cadeia de caracteres
ProductOrderItem.externalProductInventory	Lista de IDs externos mapeados para os inventários de produtos criados para o pedido. Tipo de dados: Matriz de objetos `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
ProductOrderItem.externalProductInventory.externalProductInventoryId	ID externo mapeado para o inventário do produto. Tipo de dados: Cadeia de caracteres
productOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice	Lista que descreve o preço associado ao produto. Tipo de dados: Matriz de objetos `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Descrição do preço do produto associado. Tipo de dados: Objeto `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: Objeto `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	Código da moeda no qual o preço é representado. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.price.taxIncludeAmount.value	Preço do produto, incluindo qualquer imposto. Tipo de dados: Número
productOrderItem.itemPrice.priceType	Tipo de preço do item, recorrente ou não recorrente. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.recurringChargePeriod	Se o preço for recorrente, o período recorrente, como `mês` . Tipo de dados: Cadeia de caracteres
productOrderItem.product	Descrição dos detalhes da instância do produto comprado pelo cliente. Tipo de dados: Objeto `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.id	Identificador exclusivo do produto vendido. Localizado no campo sys_id ou sn_ind_tmt_orn_external_id da tabela Inventário de produto [sn_ind_tmt_orn_product_inventory].Este parâmetro só será retornado se productOrderItem.action. `mudança` ou `excluir` . Se sys_id e external_id estiverem presentes, external_id será retornado. Tipo de dados: Cadeia de caracteres
productOrderItem.product.place	Mapas dos locais nos quais o produto será instalado. Tipo de dados: Objeto `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic	Lista de características do produto associado. Tipo de dados: Matriz de objetos `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica [sn_prd_pm_characteric]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para um pedido de mudança. A solicitação é uma ordem de mudança se productOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.value	Valores de opção de característica associados ao produto. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productRelationship	Lista de detalhes de relacionamento de produto para um item de linha de pedido. Tipo de dados: Matriz `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.product.productRelationship.id	Sys_id ou sn_prd_invt_external_id do inventário do produto. Tipo de dados: Cadeia de caracteres Tabela: Campo sys_id ou sn_prd_invt_external_id da tabela Inventário de produto [sn_prd_invt_product_inventory].
productOrderItem.product.productRelationship.relationshipType	Tipo de relacionamento entre o item de linha do pedido e o inventário do produto. Valor possível: Requer Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification	Descrição da especificação do produto associada ao produto. Tipo de dados: Objeto `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id da especificação do produto. Initial_version é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification]. Se sys_id e external_id estiverem presentes, external_id será retornado. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.internalId	Versão inicial da especificação do produto. A versão inicial é o sys_id da primeira versão da especificação. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.internalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Especificação do produto [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.name	Nome da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.version	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.@type	Parte do padrão TMF Open API. Este valor é sempre `ProductSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty	Lista de contatos para itens de linha. Tipo de dados: Matriz de objetos `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.firstName	Nome do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.lastName	Sobrenome do contato. Tipo de dados: Cadeia de caracteres Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@referredType	Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.@type	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Produto` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering	Descrição da oferta de produto associada ao produto. Tipo de dados: Objeto `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id da oferta de produto. Initial_version é o sys_id da primeira versão da oferta. Localizado no campo sys_id ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering]. Se sys_id e external_id estiverem presentes, external_id será retornado. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.internalId	Versão inicial da oferta de produto. A versão inicial é o sys_id da primeira versão da oferta. Tipo de dados: Cadeia de caracteres Tabela: Oferta de produto [sn_prd_pm_product_offering]
productOrderItem.productOffering.internalVersion	Versão da oferta do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].
productOrderItem.productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.version	Versão externa da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].
productOrderItem.productOrderItemRelationship	Lista de relacionamentos entre itens de linha do pedido. Tipo de dados: Matriz de objetos `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOrderItemRelationship.relationshipType	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: HasChild HasParent Requer `HasChild` e. `HasParent` são usados para relacionamentos primário/secundário. `Requer` é usado para relacionamentos horizontais (um item de linha requer outro item de linha). Tipo de dados: Cadeia de caracteres
ProductOrderItem.Quantidade	Número de itens associados a serem solicitados. Tipo de dados: Número
ProductOrderItem.state	Estado atual do item do pedido do produto. Este valor é sempre `novo` . Tipo de dados: Cadeia de caracteres
ProductOrderItem. No tipo	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Deve listar pelo menos um item que contém informações da conta do cliente ou da conta do consumidor. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty.type	Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
estado	Estado atual do pedido. Para este endpoint, este valor é sempre `novo` . Tipo de dados: Cadeia de caracteres
.	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrder` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Processando de forma assíncrona

Este exemplo mostra como usar o. modeparâmetro de consulta para criar um pedido de forma assíncrona. O pedido é adicionado à tabela Fila de entrada [sn_tmt_core_inbound_queue] em uma programação a ser criada.

curl -X POST 'https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder?mode=async' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d '{
  "requestedCompletionDate": "2021-05-02T08:13:59.506Z",
  "requestedStartDate": "2020-05-03T08:13:59.506Z",
  "orderDate": "2020-05-03T08:13:59.506Z",
  "externalId": "PO-4ddd56",
  "orderCurrency": "USD",
  "note": [
    {
      "id": "1",
      "author": "Jean Pontus",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration"
    },
    {
      "id": "2",
      "author": "Jean Pontus1",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "productOrderItem": [
    {
      "id": "100",
      "quantity": 1,
      "action": "add",
      "actionReason":"adding service package OLI",
      "product": {
        "isBundle": false,
        "@type": "Product",
        "productSpecification": {
          "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
          "name": "SD-WAN Service Package",
          "@type": "ProductSpecificationRef"
        },
        "relatedParty": [
          {
            "firstName": "John",
            "lastName": "Smith",
            "email": "abc2@example.com",
            "phone": "32456768",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "productRelationship": [
          {
            "id": "be6d13f45b5620102dff5e92dc81c781",
            "relationshipType": "Requires"
          }
        ]
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "110",
          "relationshipType": "HasChild"
        },
        {
          "id": "120",
          "relationshipType": "HasChild"
        },
        {
          "id": "130",
          "relationshipType": "HasChild"
        }
      ],
      "@type": "ProductOrderItem"
    },
    {
      "id": "110",
      "quantity": 1,
      "action": "add",
      "itemPrice": [
        {
          "description": "Access Fee",
          "name": "Access Fee",
          "priceType": "nonRecurring",
          "price": {
            "taxRate": 0,
            "dutyFreeAmount": {
              "unit": "USD",
              "value": 100
            },
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 220
            }
          }
        }
      ],
      "product": {
        "isBundle": false,
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "Tenancy",
            "valueType": "string",
            "value": "Premium (>50 sites)"
          }
        ],
        "productSpecification": {
          "id": "216663aa53702010cd6dddeeff7b12b5",
          "name": "SD-WAN Controller",
          "@type": "ProductSpecificationRef"
        },
        "place": {
          "@type": "Place",
          "id": "5671dd2ec3a53010188473ce3640dd81"
        },
        "relatedParty": [
          {
            "firstName": "John",
            "lastName": "Smith",
            "email": "abc2@example.com",
            "phone": "32456768",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "productRelationship": [
          {
            "id": "be6d13f45b5620102dff5e92dc81c781",
            "relationshipType": "Requires"
          }
        ]
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "100",
          "relationshipType": "HasParent"
        }
      ],
      "@type": "ProductOrderItem"
    },
    {
      "id": "120",
      "action": "add",
      "actionReason":"adding service package OLI",
      "quantity": 1,
      "itemPrice": [
        {
          "description": "Tariff plan monthly fee",
          "name": "MonthlyFee",
          "priceType": "recurring",
          "recurringChargePeriod": "month",
          "price": {
            "taxRate": 0,
            "dutyFreeAmount": {
              "unit": "USD",
              "value": 300
            },
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 349
            }
          }
        }
      ],
      "product": {
        "isBundle": false,
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "CPE Model",
            "valueType": "string",
            "value": "ASR"
          },
          {
            "name": "WAN Optimization",
            "valueType": "string",
            "value": "Advance"
          },
          {
            "name": "CPE Type",
            "valueType": "string",
            "value": "Physical"
          },
          {
            "name": "Routing",
            "valueType": "string",
            "value": "Premium"
          }
        ],
        "productSpecification": {
          "id": "39b627aa53702010cd6dddeeff7b1202",
          "name": "SD-WAN Edge Device",
          "@type": "ProductSpecificationRef"
        },
        "place": {
          "@type": "Place",
          "id": "5671dd2ec3a53010188473ce3640dd81"
        },
        "relatedParty": [
          {
            "firstName": "John",
            "lastName": "Smith",
            "email": "abc2@example.com",
            "phone": "32456768",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "productRelationship": [
          {
            "id": "be6d13f45b5620102dff5e92dc81c781",
            "relationshipType": "Requires"
          }
        ]
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "100",
          "relationshipType": "HasParent"
        }
      ],
      "@type": "ProductOrderItem"
    },
    {
      "id": "130",
      "quantity": 1,
      "action": "add",
      "actionReason":"adding service package OLI",
      "itemPrice": [
        {
          "description": "Tariff plan monthly security",
          "name": "MonthlySecurity",
          "priceType": "nonRecurring",
          "price": {
            "taxRate": 0,
            "dutyFreeAmount": {
              "unit": "USD",
              "value": 30
            },
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 30
            }
          }
        }
      ],
      "product": {
        "isBundle": false,
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "Security Type",
            "valueType": "string",
            "value": "Premium"
          }
        ],
        "productSpecification": {
          "id": "a6514bd3534560102f18ddeeff7b1247",
          "name": "SD-WAN Security",
          "@type": "ProductSpecificationRef"
        },
        "place": {
          "@type": "Place",
          "id": "5671dd2ec3a53010188473ce3640dd81"
        },
        "relatedParty": [
          {
            "firstName": "John",
            "lastName": "Smith",
            "email": "abc2@example.com",
            "phone": "32456768",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "productRelationship": [
          {
            "id": "be6d13f45b5620102dff5e92dc81c781",
            "relationshipType": "Requires"
          }
        ]
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "100",
          "relationshipType": "HasParent"
        }
      ],
      "@type": "ProductOrderItem"
    }
  ],
  "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
  "@type": "ProductOrder"
}'

Corpo da resposta.

{
  "orderId": "304e877ac3ab5110856d73ce3640dde5"
}

Processando de forma síncrona (padrão)

O exemplo a seguir mostra como criar um pedido de produto.

curl -X POST "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
  "requestedCompletionDate": "2021-05-02T08:13:59.506Z",
  "requestedStartDate": "2020-05-03T08:13:59.506Z",
  "externalId": "PO-456",
  "currencyCode": "USD",
  "channel": [
    {
      "id": "2",
      "name": "Online channel"
    }
  ],
  "note": [
    {
      "text": "This is a TMF product order illustration"
    },
    {
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "productOrderItem": [
    {
      "id": "POI100",
      "quantity": 1,
      "action": "change",
      "product": {
        "id": "fa6d13f45b5620102dff5e92dc81c77f",
        "@type": "Product",
        "productSpecification": {
          "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
          "name": "SD-WAN Service Package",
          "@type": "ProductSpecificationRef"
        },
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI120",
          "relationshipType": "HasChild"
        },
        {
          "id": "POI130",
          "relationshipType": "HasChild"
        }
      ],
      "@type": "ProductOrderItem"
    },
    {
      "id": "POI120",
      "quantity": 1,
      "action": "change",
      "actionReason":"adding service package OLI",
      "itemPrice": [
        {
          "priceType": "recurring",
          "recurringChargePeriod": "month",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        }
      ],
      "product": {
        "id": "766d13f45b5620102dff5e92dc81c78a",
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "WAN Optimization",
            "value": "Base",
            "previousValue": "Advance"
          }
        ],
        "productSpecification": {
          "id": "39b627aa53702010cd6dddeeff7b1202",
          "name": "SD-WAN Edge Device",
          "@type": "ProductSpecificationRef"
        },
        "productRelationship": [
           {
              "id": "326d13f45b5620102dff5e92dc81c785",
              "relationshipType": "Requires"
           }
        ],
        "relatedParty": [
          {
            "id": "51670151c35420105252716b7d40ddfe",
            "firstName": "Joe",
            "lastName": "Doe",
            "email": "abc@example.com",
            "phone": "1234567890",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        },
        {
          "id": "POI130",
          "relationshipType": "Requires"
        }  
      ],
      "@type": "ProductOrderItem"
    },
    {
      "id": "POI130",
      "quantity": 1,
      "action": "add",
      "actionReason":"adding service package OLI",
      "itemPrice": [
        {
          "priceType": "recurring",
          "recurringChargePeriod": "month",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        }
      ],
      "product": {
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "Security Type",
            "value": "Base",
            "previousValue": "Advance"
          }
        ],
        "productSpecification": {
          "id": "a6514bd3534560102f18ddeeff7b1247",
          "name": "SD-WAN Security",
          "@type": "ProductSpecificationRef"
        },
        "relatedParty": [
          {
            "id": "51670151c35420105252716b7d40ddfe",
            "firstName": "Joe",
            "lastName": "Doe",
            "email": "abc@example.com",
            "phone": "1234567890",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        }
      ],
      "@type": "ProductOrderItem"
    }
  ],
  "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
  "@type": "ProductOrder"
}

Corpo da resposta.

{
  "requestedCompletionDate": "2021-05-02T08:13:59.506Z",
  "requestedStartDate": "2020-05-03T08:13:59.506Z",
  "externalId": "PO-456",
  "currencyCode": "USD",
  "channel": [
    {
      "id": "2",
      "name": "Online chanel"
    }
  ],
  "note": [
    {
      "text": "This is a TMF product order illustration"
    },
    {
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "productOrderItem": [
    {
      "id": "POI100",
      "quantity": 1,
      "action": "change",
      "actionReason":"adding service package OLI",
      "product": {
        "id": "fa6d13f45b5620102dff5e92dc81c77f",
        "@type": "Product",
        "productSpecification": {
          "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
          "name": "SD-WAN Service Package",
          "internalVersion": "1",
          "version": "v1",
          "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
          "@type": "ProductSpecificationRef"
        },
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering",
        "internalVersion": "1",
        "version": "v1",
        "internalId": "69017a0f536520103b6bddeeff7b127d"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI120",
          "relationshipType": "HasChild"
        },
        {
          "id": "POI130",
          "relationshipType": "HasChild"
        }
      ],
      "@type": "ProductOrderItem",
      "state": "new"
    },
    {
      "id": "POI120",
      "quantity": 1,
      "action": "change",
      "actionReason":"adding service package OLI",
      "itemPrice": [
        {
          "priceType": "recurring",
          "recurringChargePeriod": "month",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        }
      ],
      "product": {
        "id": "766d13f45b5620102dff5e92dc81c78a",
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "WAN Optimization",
            "value": "Base",
            "previousValue": "Advance"
          }
        ],
        "productSpecification": {
          "id": "39b627aa53702010cd6dddeeff7b1202",
          "name": "SD-WAN Edge Device",
          "internalVersion": "1",
          "version": "v1",
          "internalId": "39b627aa53702010cd6dddeeff7b1202",
          "@type": "ProductSpecificationRef"
        },
        "productRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ],
        "relatedParty": [
          {
            "id": "51670151c35420105252716b7d40ddfe",
            "firstName": "Joe",
            "lastName": "Doe",
            "email": "abc@example.com",
            "phone": "1234567890",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering",
        "internalVersion": "1",
        "version": "v1",
        "internalId": "69017a0f536520103b6bddeeff7b127d"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        },
        {
          "id": "POI130",
          "relationshipType": "Requires"
        }  
      ],
      "@type": "ProductOrderItem",
      "state": "new"
    },
    {
      "id": "POI130",
      "quantity": 1,
      "action": "add",
      "actionReason":"adding service package OLI",
      "itemPrice": [
        {
          "priceType": "recurring",
          "recurringChargePeriod": "month",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        }
      ],
      "product": {
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "Security Type",
            "value": "Base",
            "previousValue": "Advance"
          }
        ],
        "productSpecification": {
          "id": "a6514bd3534560102f18ddeeff7b1247",
          "name": "SD-WAN Security",
          "internalVersion": "1",
          "version": "v1",
          "internalId": "a6514bd3534560102f18ddeeff7b1247",
          "@type": "ProductSpecificationRef"
        },
        "relatedParty": [
          {
            "id": "51670151c35420105252716b7d40ddfe",
            "firstName": "Joe",
            "lastName": "Doe",
            "email": "abc@example.com",
            "phone": "1234567890",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering",
        "internalVersion": "1",
        "version": "v1",
        "internalId": "69017a0f536520103b6bddeeff7b127d"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        }
      ],
      "@type": "ProductOrderItem",
      "state": "new"
    }
  ],
  "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
  "@type": "ProductOrder",
  "id": "8d75939453126010a795ddeeff7b126a",
  "href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
  "state": "new"
}

API de pedido de produto em aberto - POST /sn_ind_tmt_orn/productorder

Cria a ordem de venda especificada e os itens de linha de ordem de venda.

Importante:

Começando com Tokyo este endpoint foi descontinuado. A nova versão deste endpoint é API de pedido de produto em aberto - POST /sn_ind_tmt_orn/order/productOrder.

Uma vez processados, novos registros são criados nas seguintes tabelas:

Pedido do cliente [sn_ind_tmt_orn_order]
Ordem de característica [sn_ind_tmt_orn_order_characteric_value]
Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]

Formato de URL

URL padrão: /api/sn_ind_tmt_orn/productorder

Parâmetros de solicitação compatíveis

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

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

Tabela 51. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
canal	Lista de canais a serem usados para vender os produtos. Tipo de dados: Matriz de objetos `"channel": [ { "id": "String", "name": "String" } ]` Armazenado em: sn_ind_tmt_ORM_ORM_ORDER
channel.id	Obrigatório. Identificador exclusivo do canal a ser usado para vender os produtos associados. Os valores de ID do canal estão localizados no campo external_id da tabela Canal de distribuição [sn_prd_pm_distribution_channel]. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de canal da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
channel.name	Nome do canal a ser usado para vender os produtos associados. Os nomes de canal possíveis são definidos na guia Lista de seleção na entrada Dicionário de canais da tabela sn_ind_tmt_ORM_order. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
committedDueDate	Data e hora em que a ação deve ser executada no pedido. Este valor deve ser igual ou posterior a committedDueDatevalores para cada item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo committed_due_date da tabela sn_ind_tmt_orn_order.
externalId	Identificador exclusivo da ordem do cliente. Este valor é determinado por um sistema externo. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_id da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
nota	Anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz de objetos `"note": [ { "text": "String" } ]` Armazenado em: sn_ind_tmt_ORM_ORM_ORDER
note.text	Obrigatório. Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de comentários da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
OrderCurrency	Obrigatório. Código da moeda do pedido e dos itens de linha do pedido. A moeda deve ser a mesma para todos os elementos do pedido e dos itens de linha do pedido, caso contrário, um erro será retornado e o pedido não será criado. Depois que um pedido é criado, seu código de moeda não pode ser alterado. Tipo de dados: Cadeia de caracteres
ProductOrderItem	Obrigatório. Itens associados ao pedido do produto e à ação associada. Tipo de dados: Matriz de objetos `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ]` Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
ProductOrderItem.action	Obrigatório. Ação a ser realizada no produto. As ações possíveis são definidas na guia Lista de seleção na entrada Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Valores possíveis: adicionar mudança excluir nenhuma mudança resume suspender Tipo de dados: Cadeia de caracteres Armazenado em: O campo de ação da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item].
ProductOrderItem.actionMotivo	Opcional. Descrição do motivo do item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo action_reason da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item].
productOrderItem.committedDueDate	Data e hora em que a ação deve ser executada no item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo committed_due_date da tabela Item de linha do pedido [sn_ind_tmt_ORM_order_line_item].
ProductOrderItem.externalProductInventory	IDs externos a serem mapeados para os inventários de produtos criados para o pedido. Tipo de dados: Matriz de objetos `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
ProductOrderItem.externalProductInventory.externalProductInventoryId	ID externo a ser mapeado para o inventário do produto. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_inventory_id da tabela Item de linha do pedido [sn_ind_tmt_ORM_order_line_item] e o campo sn_prd_invt_external_id da tabela sn_prd_invt_product_inventory.
productOrderItem.id	Obrigatório. Identificador exclusivo do item de linha. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Comprimento máximo: 40 Cadeia de caracteres em branco
productOrderItem.itemPrice	Preço associado ao produto. Tipo de dados: Matriz de objetos `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Armazenado em: sn_ind_tmt_ORM_ORM_ORDER Cadeia de caracteres em branco
productOrderItem.itemPrice.price	Descrição do preço do produto associado. Tipo de dados: Objeto `"price": { "taxIncludedAmount": {Object} }` Item de linha do pedido [sn_ind_tmt_orn_order_line_item] Cadeia de caracteres em branco
productOrderItem.itemPrice.price.taxIncludedAmount	Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: Objeto `"taxIncludedAmount": { "unit": "String", "value": Number }` Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Código da moeda no qual o preço é expresso. Tipo de dados: Cadeia de caracteres Armazenado em: O campo mrc ou nrc da tabela Item de linha do pedido [sn_ind_tmt_ORM_order_line_item]
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preço do produto, incluindo qualquer imposto. Tipo de dados: Número Armazenado em: O campo mrc ou nrc da tabela Item de linha do pedido [sn_ind_tmt_ORM_order_line_item]
productOrderItem.itemPrice.priceType	Especifica se o preço do item é recorrente ou não. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.recurringChargePeriod	Se o preço for recorrente, o período recorrente, como `mês` . Tipo de dados: Cadeia de caracteres
productOrderItem.product	Necessário se productOrderItem.actioné mudança ou exclusão. Detalhes da instância do produto comprado pelo cliente. Tipo de dados: Objeto `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
productOrderItem.product.id	Necessário se productOrderItem.actioné mudança ou exclusão. Identificador exclusivo do produto vendido. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco Tabela: No campo sys_id ou sn_ind_tmt_orn_external_id da tabela Inventário de produto [sn_ind_tmt_orn_product_inventory].
productOrderItem.product.place	Mapas dos locais nos quais o produto será instalado. Tipo de dados: Objeto `"place": { "id": "String", "@type": "String" }` Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
productOrderItem.product.place.id	Obrigatório. Sys_id do registro de local associado. Tipo de dados: Cadeia de caracteres Tabela: Local [cmn_location] Armazenado em: O campo de local da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item].
productOrderItem.product.place.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Lugar` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic	Caraterísticas do produto associado. Tipo de dados: Matriz de objetos `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]` Armazenado em: sn_ind_tmt_orn_order_characteric_value
productOrderItem.product.productCharacteristic.name	Nome do registro de característica a ser associado ao produto. Tipo de dados: Cadeia de caracteres Tabela: Característica [sn_prd_pm_characteric] Armazenado em: O campo de características da tabela sn_ind_tmt_orn_order_characteristic_value. Cadeia de caracteres em branco
productOrderItem.product.productCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para pedido de mudança. A solicitação é uma ordem de mudança se productOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres Armazenado em: O campo previous_characteristic_option_value da tabela sn_ind_tmt_orn_order_characteristic_value. Cadeia de caracteres em branco
productOrderItem.product.productCharacteristic.value	Valores de opção de característica associados ao produto. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres Armazenado em: O campo characteric_option_value da tabela sn_ind_tmt_orn_order_characteristic_value. Cadeia de caracteres em branco
productOrderItem.product.productCharacteristic.valueType	Tipo de valor de característica. Valores possíveis: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Teste de linha única Caixa de seleção Escolha Data, Endereço E-mail Inteiro, Data/Hora Objeto Texto de Linha Única Sim/Não Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification	Opcional. Descrição da especificação do produto associada ao produto. Nota: Ordens de mudança ( productOrderItem.action. `mudança` ) são processados de forma diferente com base no valor de sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrderpropriedade do sistema. O valor desta propriedade do sistema determina como o pedido será processado se o inventário do produto for uma versão diferente da indicada no pedido. Quando esta propriedade do sistema é definida como verdadeira (padrão), o inventário do produto é atualizado automaticamente para a versão no pedido, alterando a especificação do produto referenciado. Isso permite que o pedido seja processado com sucesso. Se esta propriedade do sistema estiver definida como falsa, se o inventário do produto for uma versão diferente da indicada no pedido, o pedido falhará devido à incompatibilidade da versão. Tipo de dados: Objeto `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.product.productSpecification.id	Obrigatório. Versão inicial ou ID externo da especificação do produto. A versão inicial é o sys_id da primeira versão da especificação. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.internalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Especificação do produto [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.name	Nome da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.version	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.@type	Parte do padrão TMF Open API. Este valor é sempre `ProductSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty	Lista de funções de terceiros vinculadas a um OrderLineItemContact. Tipo de dados: Matriz de objetos `"relatedParty": [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Armazenado em: sn_ind_tmt_orn_order_line_item_contact
productOrderItem.product.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de e-mail da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.firstName	Nome do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo first_name da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.lastName	Sobrenome do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo lastName da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: Cadeia de caracteres Armazenado em: O campo business_phone da tabela sn_ind_tmt_orn_order_line_item_contact. Cadeia de caracteres em branco
productOrderItem.product.relatedParty.@referredType	Obrigatório. Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.@type	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Produto` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering	Obrigatório. Descrição da oferta de produto associada ao produto. Tipo de dados: Objeto `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.productOffering.id	Obrigatório. Versão inicial ou ID externo da oferta de produto. A versão inicial é o sys_id da primeira versão da oferta. Tipo de dados: Cadeia de caracteres Tabela: Oferta de produto [sn_prd_pm_product_offering]
productOrderItem.productOffering.internalVersion	Versão da oferta do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].
productOrderItem.productOffering.name	Nome da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: Oferta de produto [sn_prd_pm_product_offering]
productOrderItem.productOffering.version	Versão externa da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].
productOrderItem.productOrderItem.quantity	Número de itens associados a serem solicitados. Tipo de dados: Número Armazenado em: O campo Quantidade da tabela sn_ind_tmt_orn_order. Padrão: Nulo
productOrderItem.productOrderItemRelationship	Obrigatório. Lista que descreve o relacionamento primário/secundário entre os itens do pedido. Tipo de dados: Matriz de objetos `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` Armazenado em: sn_ind_tmt_orn_order_line_item
productOrderItem.productOrderItemRelationship.id	Obrigatório. Igual a productOrderItem.idvalor. Usado para relacionamento primário/secundário Tipo de dados: Cadeia de caracteres Armazenado em: O campo parent_line_item da tabela sn_ind_tmt_orn_order_line_item. Cadeia de caracteres em branco
productOrderItem.productOrderItemRelationship.relationshipType	Obrigatório. Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: HasChild HasParent Tipo de dados: Cadeia de caracteres
ProductOrderItem.Quantidade	Número de itens solicitados. Tipo de dados: Número Armazenado em: O campo Quantidade da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
ProductOrderItem. No tipo	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Deve listar pelo menos um item que contém informações da conta do cliente ou da conta do consumidor. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id da conta ou contato do cliente associado ao pedido. Tipo de dados: Cadeia de caracteres Tabela: Conta [customer_account], tabela Contato [customer_contact] ou Consumidor [csm_consumer]
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Obrigatório. Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres Armazenado em: O campo expected_end_date da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres Armazenado em: O campo expected_start_date da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
.	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrder` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Cabeçalhos

Tabela 52. 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 53. 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 54. Códigos de status
Código do status	Descrição
201	Bem-sucedido. Se houver problemas com as características ou as informações da opção de características, o endpoint armazenará os seguintes comentários nos campos de anotações de trabalho do registro de item de linha de pedido do cliente associado: `As seguintes características do item do pedido não existem: Revisar especificação > characteristic.name> e corrija a característica e a opção de característica no item de linha do pedido antes de aprovar o pedido.` `Característica do item do pedido characteristic.name> com valor de característica: > characteristic.value> é inválido. Corrija os valores das características antes de aprovar o pedido.`
400	Solicitação Incorreta. Qualquer um dos seguintes motivos: `Carga inválida: Corpo da solicitação ausente` A carga não foi passada no corpo da solicitação. `Carga inválida: ProductOrderItem está ausente` Objeto de item de linha de pedido do produto ou JSON ausente. `Carga inválida: O ID de productOrderItem está ausente` - O. ido parâmetro está ausente no item de linha do pedido do produto da carga. `Carga inválida: A ação productOrderItem está ausente` - O. actiono parâmetro está ausente no item de linha do pedido do produto da carga. `Carga inválida: ProductOrderItem productOffering está ausente` - O objeto de oferta do produto ou JSON está ausente no item de linha do pedido do produto na carga. `Carga inválida: O ID de productOffering está ausente` - O. ido parâmetro está ausente no item de linha do pedido do produto do objeto de oferta do produto na carga. `Carga inválida: A oferta de produto não existe` - A oferta de produto no item de linha do pedido do produto não é válida. `Carga inválida: O produto productOrderItem está ausente` - O objeto do produto ou JSON no item de linha do pedido do produto está ausente na carga. `Carga inválida: O produto ProductSpecification está ausente` - O objeto de especificação do produto ou JSON no item de linha do pedido do produto está ausente na carga. `Carga inválida: O ID de especificação do produto está ausente` - O. ido parâmetro no item de linha do pedido do produto do objeto de especificação do produto está ausente na carga. `Carga inválida: A especificação do produto não existe` - A especificação do produto no item de linha do pedido do produto não é válida. `Carga inválida: O inventário do produto não existe` - Em um pedido de mudança (ação: Mudança), a quantidade de um item é maior do que a quantidade em estoque. `Carga inválida: O ID do inventário do produto está ausente` - Na ordem de mudança, o. product.idestá ausente na carga. `Carga inválida: O produto vendido está inativo` - Em um pedido de mudança, um produto especificado na carga está inativo. `Carga inválida: RelatedParty está ausente` - O objeto da parte relacionada está ausente na carga. `Carga inválida: A conta do cliente ou o consumidor está ausente` - O objeto do cliente ou consumidor da parte relacionada está ausente na carga. `Carga inválida: O consumidor não existe` - O consumidor da parte relacionada especificada não existe no ServiceNow instância. `Carga inválida: A conta do cliente não existe` - O cliente da parte relacionada especificada não existe no ServiceNow instância. `Carga inválida: Falha na criação do pedido` - Não foi possível criar o pedido solicitado.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
canal	Lista de canais a serem usados para vender os produtos. Tipo de dados: Matriz de objetos `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificador exclusivo do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
channel.name	Nome do canal a ser usado para vender os produtos associados. Tipo de dados: Cadeia de caracteres
id	Sys_id da ordem de venda criada para esta solicitação. Tipo de dados: Cadeia de caracteres
externalId	Identificador externo da ordem de venda, como um número de ordem de compra. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz de objetos `"note": [ { "text": "String" } ]`
note.text	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres
ProductOrderItem	Lista que descreve os itens associados ao pedido do produto e sua ação associada. Tipo de dados: Matriz de objetos `"productOrderItem:" [ { "action": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
ProductOrderItem.action	Ação a ser realizada no produto. As ações possíveis são definidas na guia Lista de seleção na entrada Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Tipo de dados: Cadeia de caracteres
ProductOderItem.actionMoason	Motivo para adicionar o item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo action_reason da tabela sn_ind_tmt_orn_order_line_item.
productOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice	Lista que descreve o preço associado ao produto. Tipo de dados: Matriz de objetos `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Descrição do preço do produto associado. Tipo de dados: Objeto `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: Objeto `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	Código da moeda no qual o preço é representado. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.price.taxIncludeAmount.value	Preço do produto, incluindo qualquer imposto. Tipo de dados: Número
productOrderItem.itemPrice.priceType	Tipo de preço do item, recorrente ou não recorrente. Tipo de dados: Cadeia de caracteres
productOrderItem.itemPrice.recurringChargePeriod	Se o preço for recorrente, o período recorrente, como `mês` . Tipo de dados: Cadeia de caracteres
productOrderItem.product	Descrição dos detalhes da instância do produto comprado pelo cliente. Tipo de dados: Objeto `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.id	Identificador exclusivo do produto vendido. Localizado no campo sys_id ou sn_ind_tmt_orn_external_id da tabela Inventário de produto [sn_ind_tmt_orn_product_inventory].Este parâmetro só será retornado se productOrderItem.action. `mudança` ou `excluir` . Se sys_id e external_id estiverem presentes, external_id será retornado. Tipo de dados: Cadeia de caracteres
productOrderItem.product.place	Mapas dos locais nos quais o produto será instalado. Tipo de dados: Objeto `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic	Lista de características do produto associado. Tipo de dados: Matriz de objetos `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica [sn_prd_pm_characteric]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para um pedido de mudança. A solicitação é uma ordem de mudança se productOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.value	Valores de opção de característica associados ao produto. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productCharacteristic.valueType	Tipo de valor de característica. Valores possíveis: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Teste de linha única Caixa de seleção Escolha Data, Endereço E-mail Inteiro, Data/Hora Objeto Texto de Linha Única Sim/Não Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification	Descrição da especificação do produto associada ao produto. Tipo de dados: Objeto `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id da especificação do produto. Initial_version é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification]. Se sys_id e external_id estiverem presentes, external_id será retornado. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.name	Nome da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: Cadeia de caracteres
productOrderItem.product.productSpecification.@type	Parte do padrão TMF Open API. Este valor é sempre `ProductSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty	Lista de contatos para itens de linha. Tipo de dados: Matriz de objetos `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.firstName	Nome do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.lastName	Sobrenome do contato. Tipo de dados: Cadeia de caracteres Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@referredType	Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
productOrderItem.product.relatedParty.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.product.@type	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `Produto` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering	Descrição da oferta de produto associada ao produto. Tipo de dados: Objeto `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id da oferta de produto. Initial_version é o sys_id da primeira versão da oferta. Localizado no campo sys_id ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering]. Se sys_id e external_id estiverem presentes, external_id será retornado. Tipo de dados: Cadeia de caracteres
productOrderItem.productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOrderItemRelationship	Lista de relacionamentos entre itens de linha do pedido. Tipo de dados: Matriz de objetos `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
productOrderItem.productOrderItemRelationship.relationshipType	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Tipo de dados: Cadeia de caracteres
ProductOrderItem.Quantidade	Número de itens associados a serem solicitados. Tipo de dados: Número
ProductOrderItem.state	Estado atual do item do pedido do produto. Este valor é sempre `novo` . Tipo de dados: Cadeia de caracteres
ProductOrderItem. No tipo	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Deve listar pelo menos um item que contém informações da conta do cliente ou da conta do consumidor. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty.type	Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
estado	Estado atual do pedido. Para este endpoint, este valor é sempre `novo` . Tipo de dados: Cadeia de caracteres
.	Padrão de API aberta do TMF. Anotação para o produto. Este valor é sempre `ProductOrder` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo de código a seguir cria uma ordem do cliente.

curl -X POST "https://servicenow-instance/api/sn_ind_tmt_orm/productorder" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
  "requestedCompletionDate": "2021-05-02T08:13:59.506Z",
  "requestedStartDate": "2020-05-03T08:13:59.506Z",
  "externalId": "PO-456",
  "channel": [
    {
      "id": "2",
      "name": "Online channel"
    }
  ],
  "note": [
    {
      "text": "This is a TMF product order illustration"
    },
    {
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "productOrderItem": [
    {
      "id": "POI100",
      "quantity": 1,
      "action": "change",
      "product": {
        "id": "fa6d13f45b5620102dff5e92dc81c77f",
        "@type": "Product",
        "productSpecification": {
          "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
          "name": "SD-WAN Service Package",
          "@type": "ProductSpecificationRef"
        },
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI120",
          "relationshipType": "HasChild"
        },
        {
          "id": "POI130",
          "relationshipType": "HasChild"
        }
      ],
      "@type": "ProductOrderItem"
    },
    {
      "id": "POI120",
      "quantity": 1,
      "action": "change",
      "itemPrice": [
        {
          "priceType": "recurring",
          "recurringChargePeriod": "month",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        }
      ],
      "product": {
        "id": "766d13f45b5620102dff5e92dc81c78a",
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "WAN Optimization",
            "valueType": "Object",
            "value": "Base",
            "previousValue": "Advance"
          }
        ],
        "productSpecification": {
          "id": "39b627aa53702010cd6dddeeff7b1202",
          "name": "SD-WAN Edge Device",
          "@type": "ProductSpecificationRef"
        },
        "relatedParty": [
          {
            "id": "51670151c35420105252716b7d40ddfe",
            "firstName": "Joe",
            "lastName": "Doe",
            "email": "abc@example.com",
            "phone": "1234567890",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        }
      ],
      "@type": "ProductOrderItem"
    },
    {
      "id": "POI130",
      "quantity": 1,
      "action": "add",
      "itemPrice": [
        {
          "priceType": "recurring",
          "recurringChargePeriod": "month",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        }
      ],
      "product": {
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "Security Type",
            "valueType": "Object",
            "value": "Base",
            "previousValue": "Advance"
          }
        ],
        "productSpecification": {
          "id": "a6514bd3534560102f18ddeeff7b1247",
          "name": "SD-WAN Security",
          "@type": "ProductSpecificationRef"
        },
        "relatedParty": [
          {
            "id": "51670151c35420105252716b7d40ddfe",
            "firstName": "Joe",
            "lastName": "Doe",
            "email": "abc@example.com",
            "phone": "1234567890",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        }
      ],
      "@type": "ProductOrderItem"
    }
  ],
  "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
  "@type": "ProductOrder"
}

Corpo da resposta.

{
    "requestedCompletionDate": "2021-05-02T08:13:59.506Z",
    "requestedStartDate": "2020-05-03T08:13:59.506Z",
    "externalId": "PO-456",
    "channel": [
        {
            "id": "2",
            "name": "Online chanel"
        }
    ],
    "note": [
        {
            "text": "This is a TMF product order illustration"
        },
        {
            "text": "This is a TMF product order illustration no 2"
        }
    ],
    "productOrderItem": [
        {
            "id": "POI100",
            "quantity": 1,
            "action": "change",
            "product": {
                "id": "fa6d13f45b5620102dff5e92dc81c77f",
                "@type": "Product",
                "productSpecification": {
                    "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
                    "name": "SD-WAN Service Package",
                    "@type": "ProductSpecificationRef"
                },
                "place": {
                    "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                    "@type": "Place"
                }
            },
            "productOffering": {
                "id": "69017a0f536520103b6bddeeff7b127d",
                "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
                {
                    "id": "POI120",
                    "relationshipType": "HasChild"
                },
                {
                    "id": "POI130",
                    "relationshipType": "HasChild"
                }
            ],
            "@type": "ProductOrderItem",
            "state": "new"
        },
        {
            "id": "POI120",
            "quantity": 1,
            "action": "change",
            "itemPrice": [
                {
                    "priceType": "recurring",
                    "recurringChargePeriod": "month",
                    "price": {
                        "taxIncludedAmount": {
                            "unit": "USD",
                            "value": 20
                        }
                    }
                }
            ],
            "product": {
                "id": "766d13f45b5620102dff5e92dc81c78a",
                "@type": "Product",
                "productCharacteristic": [
                    {
                        "name": "WAN Optimization",
                        "valueType": "Object",
                        "value": "Base",
                        "previousValue": "Advance"
                    }
                ],
                "productSpecification": {
                    "id": "39b627aa53702010cd6dddeeff7b1202",
                    "name": "SD-WAN Edge Device",
                    "@type": "ProductSpecificationRef"
                },
                "relatedParty": [
                    {
                        "id": "51670151c35420105252716b7d40ddfe",
                        "firstName": "Joe",
                        "lastName": "Doe",
                        "email": "abc@example.com",
                        "phone": "1234567890",
                        "@type": "RelatedParty",
                        "@referredType": "OrderLineItemContact"
                    }
                ],
                "place": {
                    "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                    "@type": "Place"
                }
            },
            "productOffering": {
                "id": "69017a0f536520103b6bddeeff7b127d",
                "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
                {
                    "id": "POI100",
                    "relationshipType": "HasParent"
                }
            ],
            "@type": "ProductOrderItem",
            "state": "new"
        },
        {
            "id": "POI130",
            "quantity": 1,
            "action": "add",
            "itemPrice": [
                {
                    "priceType": "recurring",
                    "recurringChargePeriod": "month",
                    "price": {
                        "taxIncludedAmount": {
                            "unit": "USD",
                            "value": 20
                        }
                    }
                }
            ],
            "product": {
                "@type": "Product",
                "productCharacteristic": [
                    {
                        "name": "Security Type",
                        "valueType": "Object",
                        "value": "Base",
                        "previousValue": "Advance"
                    }
                ],
                "productSpecification": {
                    "id": "a6514bd3534560102f18ddeeff7b1247",
                    "name": "SD-WAN Security",
                    "@type": "ProductSpecificationRef"
                },
                "relatedParty": [
                    {
                        "id": "51670151c35420105252716b7d40ddfe",
                        "firstName": "Joe",
                        "lastName": "Doe",
                        "email": "abc@example.com",
                        "phone": "1234567890",
                        "@type": "RelatedParty",
                        "@referredType": "OrderLineItemContact"
                    }
                ],
                "place": {
                    "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                    "@type": "Place"
                }
            },
            "productOffering": {
                "id": "69017a0f536520103b6bddeeff7b127d",
                "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
                {
                    "id": "POI100",
                    "relationshipType": "HasParent"
                }
            ],
            "@type": "ProductOrderItem",
            "state": "new"
        }
    ],
    "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
    "@type": "ProductOrder",
    "id": "6be0a925c3a220103e2e73ce3640ddfe",
    "state": "new"
}