--- sourceDocument: Referência de API do Xanadu sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference Release : - xanadu ft:locale : - pt-BR ft:publication_title : - Referência de API do Xanadu ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # API aberta de pedido de produto # API aberta de pedido de produto {#ariaid-title1} * Versão de lançamento: Xanadu * * Atualizado 1 de ago. de 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 158 min. de leitura A API Aberto de pedido de produto fornece endpoints que habilitam 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 o 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 Order Management for Telecommunications (sn_ind_tmt_orm) deve ser ativado. Esta API é fornecida no namespace `sn_ind_tmt_orm`. O usuário de chamada deve ter a função sn_ind_tmt_orm.order_integrator. Esta API pode ser estendida para fazer personalizações em torno dos parâmetros necessários, validação do corpo da solicitação, operações REST adicionais e mapeamentos de campo. Para obter mais informações, consulte o [Guia do desenvolvedor da Open API do pedido de produto](https://servicenow-prod.fluidtopics.net/pycVBYPYgGH8hpOQp3q3sA#product-order_dev-guide "Use a API Aberto de pedido de produto para criar, atualizar e recuperar informações de pedido de produto."). A API aberta do pedido de produto é uma ServiceNow® implementação da especificação REST da API de gestão de produtos do TM Fórum TMF622 e tem conformidade certificada pelo TM Fórum. ## API aberta de pedido de produto - GET /sn_ind_tmt_orm/order/productOrder {#ariaid-title2} Recupera todos os pedidos de produtos. Este endpoint recupera informações de pedido das seguintes tabelas: * Pedido do cliente \[sn_ind_tmt_orm_order\] * Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\] * Característica do pedido \[sn_ind_tmt_orm_order_characteristic_value\] * Contato do item de linha do pedido \[sn_ind_tmt_orm_order_line_item_contact\] * Itens relacionados à linha do pedido \[sn_ind_tmt_orm_order_line_related_items\] {#tmf_prod_order-GET-ord-productOrder__ul_lxc_kxm_t4b} ### Formato da URL {#tmf_prod_order-GET-ord-productOrder__section_mbm_2ct_t4b} URL padrão: /api/sn_ind_tmt_orm/order/productOrder ### Parâmetros de solicitação compatíveis {#tmf_prod_order-GET-ord-productOrder__table_ofr_vgy_fsb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 1. Parâmetros de caminho] {#tmf_prod_order-GET-ord-productOrder__table_ofr_vgy_fsb} {#tmf_prod_order-GET-ord-productOrder__table_pfr_vgy_fsb__entry__2} | Nome | Descrição | |-|-| | campos | Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Se este parâmetro não for usado, todos os campos serão retornados. Tipo de dados: cadeia de caracteres | | limite | Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro offset para paginar a recuperação do registro. Padrão: 20 Máximo: 100 Tipo de dados: número | | deslocamento | Índice inicial no qual os registros serão recuperados. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Padrão: 0 Tipo de dados: número | | 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 | [Tabela 2. Parâmetros de consulta] {#tmf_prod_order-GET-ord-productOrder__table_pfr_vgy_fsb} {#tmf_prod_order-GET-ord-productOrder__table_xcm_cvr_nsb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 3. Parâmetros do corpo da solicitação (JSON)] {#tmf_prod_order-GET-ord-productOrder__table_xcm_cvr_nsb} ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-GET-ord-productOrder__table_kqy_wgy_fsb__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 4. Cabeçalhos da solicitação] {#tmf_prod_order-GET-ord-productOrder__table_kqy_wgy_fsb} {#tmf_prod_order-GET-ord-productOrder__table_h4r_fxr_nsb__entry__2}{#tmf_prod_order-GET-ord-productOrder__content-range-row}{#tmf_prod_order-GET-ord-productOrder__content-type-row}{#tmf_prod_order-GET-ord-productOrder__links-pagination-row}{#tmf_prod_order-GET-ord-productOrder__x-total-count-descr} | Cabeçalho | Descrição | |-|-| | Intervalo de conteúdo | Especifica o intervalo de conteúdo retornado em uma chamada paginada. Por exemplo, se `deslocamento=2` e `limite=3`, o valor do cabeçalho Content-Range será `itens 3-5`. | | Tipo de conteúdo | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | | Link | Contém os links a seguir para navegar pelos resultados da consulta. * primeiro * último * avançar * anterior {#tmf_prod_order-GET-ord-productOrder__ul_zzk_sdm_lsb} | | X-Total-Contagem | Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor. | [Tabela 5. Cabeçalhos de resposta] {#tmf_prod_order-GET-ord-productOrder__table_h4r_fxr_nsb} ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-GET-ord-productOrder__table_wdl_3xr_nsb__entry__2}{#tmf_prod_order-GET-ord-productOrder__tmf-get-status-200-p}{#tmf_prod_order-GET-ord-productOrder__tmf-get-status-206-entry}{#tmf_prod_order-GET-ord-productOrder__tmf-get-status-400-entry}{#tmf_prod_order-GET-ord-productOrder__tmf-get-status-404-entry} | Código de status | Descrição | |-|-| | 200 | Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação). | | 206 | Recurso parcial retornado em resposta (com paginação). | | 400 | Solicitação incorreta. Possíveis motivos: * Parâmetro de caminho inválido * URI inválido {#tmf_prod_order-GET-ord-productOrder__ul_rys_1gy_fsb} | | 404 | Registro não encontrado. Nenhum registro correspondente aos parâmetros de consulta foi encontrado na tabela. | [Tabela 6. Códigos de status] {#tmf_prod_order-GET-ord-productOrder__table_wdl_3xr_nsb} ### Parâmetros do corpo da resposta (JSON) {#tmf_prod_order-GET-ord-productOrder__section_hnf_kxr_nsb} {#tmf_prod_order-GET-ord-productOrder__table_inf_kxr_nsb__entry__2}{#tmf_prod_order-GET-ord-productOrder__externalProdInv-resp-descr}{#tmf_prod_order-GET-ord-productOrder__externalProdInvId-resp-descr} | Nome | Descrição | |-|-| | canal | Matriz de objetos que descreve os canais a serem usados para vender os produtos. Tipo de dados: matriz "channel": [ { "id": "String", "name": "String" } ] | | canal.id | Identificador exclusivo do canal a ser usado para vender os produtos associados. Os valores de ID de 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 | | canal.nome | 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 realizada no pedido. Este valor deve ser igual ou posterior aos valores committedDueDate de cada item de linha do pedido. Tipo de dados: cadeia de caracteres | | DataDeConclusão esperada | Data em que o pedido será concluído. Tipo de dados: cadeia de caracteres | | href | Link relativo ao registro do pedido do produto. Tipo de dados: cadeia de caracteres | | ID | Sys_id do pedido do produto. Tipo de dados: cadeia de caracteres | | anotação | Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz "note": [ { "author": "String", "date": "String", "text": "String" } ] | | anotação.autor | Nome de usuário da pessoa que criou a anotação associada. Tipo de dados: cadeia de caracteres | | anotação.data | Data em que a anotação foi criada. Tipo de dados: cadeia de caracteres | | anotação.texto | Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres | | orderCurrency | Código da moeda para o pedido e 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 válidos: * verdadeiro: o ponto sem retorno do pedido foi atingido. * falso: o ponto sem retorno do pedido não foi atingido. {#tmf_prod_order-GET-ord-productOrder__ul_tdq_rw1_hqb} Tipo de dados: booliano | | productOrderItem | Lista que descreve itens associados ao pedido de produto e sua ação associada. Tipo de dados: matriz "productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.ação | Ação a ser executada no produto. As ações possíveis são definidas na guia Lista de seleção na Entrada do Dicionário de Ação da tabela sn_ind_tmt_orm_order_line_item. Tipo de dados: cadeia de caracteres | | productOrderItem.actionReason | O motivo para adicionar o item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Data e hora em que a ação deve ser realizada no item de linha do pedido. Tipo de dados: cadeia de caracteres | | productOrderItem.externalProductInventory | Matriz de objetos que contém IDs externos mapeados para os inventários de produtos criados para o pedido. Tipo de dados: matriz "externalProductInventory": [ { "externalProductInventoryId": "String" } ] | | productOrderItem.externalProductInventory.externalProductInventoryId | ID externo mapeado para o inventário de produtos. Tipo de dados: cadeia de caracteres | | productOrderItem.id | Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\]. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice | Matriz de objetos que descreve o preço associado ao produto. Tipo de dados: matriz "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} } | | produtoPedidoItem.itemPreço.preço.impostoValorincluído | 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 em que o preço é representado. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice.Price.TaxIncludedAmount.value | Preço do produto, incluindo impostos. 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 month. Tipo de dados: cadeia de caracteres | | productOrderItem.ponr | Sinalizador que indica se o ponto sem retorno do pedido foi atingido. Valores válidos: * verdadeiro: o ponto sem retorno do pedido foi atingido. * falso: o ponto sem retorno do pedido não foi atingido. {#tmf_prod_order-GET-ord-productOrder__d2876e2599} 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 | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre Place. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto | Matriz de objetos que descreve as características do produto associado. Somente as características do produto cujos value são diferentes de previousValue são retornadas. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica \[sn_prd_pm_characteristic\]. Tipo de dados: cadeia de caracteres | | productOrderItem.product.productCharacteristic.previousValue | A opção de característica anterior será válida se a atualização for para uma ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro productOrderItem.action for diferente de add. Para obter informações adicionais sobre valores de opção de característica, consulte [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto.valor | 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](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres | | productOrderItem.product.productRelationship | Lista de detalhes do relacionamento do produto para um item de linha do 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 de produtos. Localizado no campo sys_id ou sn_prd_invt_external_id da tabela Inventário de produtos \[sn_prd_invt_product_inventory\]. Tipo de dados: cadeia de caracteres | | 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. O 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 | Initial_version da especificação do produto. O initial_version é o sys_id da primeira versão da especificação. Localizado na 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. Localizado na 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.version | External_version da especificação do produto. Localizado na tabela Especificação do produto \[sn_prd_pm_product_specification\]. Tipo de dados: cadeia de caracteres | | 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 "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 de item de linha do pedido \[sn_ind_tmt_orm_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 | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.productOferta | 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. O 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 | Initial_version da oferta de produto. O initial_version é o sys_id da primeira versão da oferta. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | productOrderItem.productOffering.internalVersion | Versão da oferta de produto. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | 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.productOferta.versão | External_version da oferta de produto. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | productOrderItem.quantity | Número de itens de produto comprados. Tipo de dados: número | | productOrderItem.productOrderItemRelationship | Matriz de objetos que descreve os relacionamentos entre itens de linha do pedido. Tipo de dados: matriz "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_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: * TemSecundário * Tem pai * Requer {#tmf_prod_order-GET-ord-productOrder__ul_yqf_2ty_54b} `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.estado | Estado da ordem do item de produto associado. Tipo de dados: cadeia de caracteres | | productOrderItem.version | Versão do pedido. Tipo de dados: cadeia de caracteres | | productOrderItem.@type | Parte do padrão TMF Open API. Anotação do 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 contenha informações da conta do cliente ou da conta do consumidor. Tipo de dados: matriz "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.@referredType | Tipo de cliente. Valores possíveis: * Consumidor * Cliente * CustomerContact {#tmf_prod_order-GET-ord-productOrder__ul_lcq_jwm_t4b} Tipo de dados: cadeia de caracteres | | relatedParty.@type | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | requestCompletionDate | Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres | | requestStartDate | 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 | | @tipo | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre ProductOrder. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | [ ] {#tmf_prod_order-GET-ord-productOrder__table_inf_kxr_nsb} ### 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 aberta de pedido de produto - GET /sn_ind_tmt_orm/order/productOrder/{id} {#ariaid-title3} Recupera o pedido de produto especificado. Este endpoint recupera informações de pedido das seguintes tabelas: * Pedido do cliente \[sn_ind_tmt_orm_order\] * Característica do pedido \[sn_ind_tmt_orm_order_characteristic_value\] * Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\] * Contato do item de linha do pedido \[sn_ind_tmt_orm_order_line_item_contact\] * Itens relacionados à linha do pedido \[sn_ind_tmt_orm_order_line_related_items\] {#tmf_prod_order-GET-ord-productOrder-id__ul_lxc_kxm_t4b} ### Formato da URL {#tmf_prod_order-GET-ord-productOrder-id__section_mbm_2ct_t4b} URL padrão: /api/sn_ind_tmt_orm/order/productOrder/{id} ### Parâmetros de solicitação compatíveis {#tmf_prod_order-GET-ord-productOrder-id__entry__2} | Nome | Descrição | |-|-| | ID | Sys_id ou external_id do pedido do cliente a ser recuperado. Localizado na tabela Pedido do cliente \[sn_ind_tmt_orm_order\]. Tipo de dados: cadeia de caracteres | [Tabela 7. Parâmetros de caminho] {#tmf_prod_order-GET-ord-productOrder-id__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 8. Parâmetros de consulta] {#tmf_prod_order-GET-ord-productOrder-id__entry__10} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 9. Parâmetros do corpo da solicitação (JSON)] ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-GET-ord-productOrder-id__table_kqy_wgy_fsb__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 10. Cabeçalhos da solicitação] {#tmf_prod_order-GET-ord-productOrder-id__table_kqy_wgy_fsb} {#tmf_prod_order-GET-ord-productOrder-id__table_tzy_thy_ksb__entry__2} | Cabeçalho | Descrição | |-|-| | Tipo de conteúdo | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 11. Cabeçalhos de resposta] {#tmf_prod_order-GET-ord-productOrder-id__table_tzy_thy_ksb} ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-GET-ord-productOrder-id__tmf-get-list-status-codes__entry__2} | Código de status | Descrição | |-|-| | 200 | Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação). A resposta retornará bem-sucedido com uma mensagem de erro se o pedido selecionado tiver problemas de processamento. * Uma resposta 200 OK acontecerá se a ordem estiver na tabela Fila de entrada \[sn_tmt_core_inbound_queue\] aguardando o programador escolher 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 acontecerá se a criação de um 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 da fila de entrada. Por exemplo: { "code": 23, "reason": "Missing body field", "message": "Missing body field", "details": [ { "message": "Invalid payload: orderCurrency is missing", "datapath": "/" } ] } {#tmf_prod_order-GET-ord-productOrder-id__ul_kdw_y4w_fwb} | | 206 | Recurso parcial retornado em resposta (com paginação). | | 400 | Solicitação incorreta. Possíveis motivos: * Parâmetro de caminho inválido * URI inválido {#tmf_prod_order-GET-ord-productOrder-id__ul_rys_1gy_fsb} | | 404 | Registro não encontrado. Nenhum registro correspondente aos parâmetros de consulta foi encontrado na tabela. | [Tabela 12. Códigos de status] {#tmf_prod_order-GET-ord-productOrder-id__tmf-get-list-status-codes} ### Parâmetros do corpo da resposta (JSON) {#tmf_prod_order-GET-ord-productOrder-id__entry__32}{#tmf_prod_order-GET-ord-productOrder-id__externalProdInv-resp-descr}{#tmf_prod_order-GET-ord-productOrder-id__externalProdInvId-resp-descr} | Nome | Descrição | |-|-| | canal | Matriz de objetos que descreve os canais a serem usados para vender os produtos. Tipo de dados: matriz "channel": [ { "id": "String", "name": "String" } ] | | canal.id | Identificador exclusivo do canal a ser usado para vender os produtos associados. Os valores de ID de 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 | | canal.nome | 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 realizada no pedido. Este valor deve ser igual ou posterior aos valores committedDueDate de cada item de linha do pedido. Tipo de dados: cadeia de caracteres | | DataDeConclusão esperada | Data em que o pedido será concluído. Tipo de dados: cadeia de caracteres | | href | Link relativo ao registro do pedido do produto. Tipo de dados: cadeia de caracteres | | ID | Sys_id do pedido do produto. Tipo de dados: cadeia de caracteres | | anotação | Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz "note": [ { "author": "String", "date": "String", "text": "String" } ] | | anotação.autor | Nome de usuário da pessoa que criou a anotação associada. Tipo de dados: cadeia de caracteres | | anotação.data | Data em que a anotação foi criada. Tipo de dados: cadeia de caracteres | | anotação.texto | Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres | | orderCurrency | Código da moeda para o pedido e 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 válidos: * verdadeiro: o ponto sem retorno do pedido foi atingido. * falso: o ponto sem retorno do pedido não foi atingido. {#tmf_prod_order-GET-ord-productOrder-id__ul_tdq_rw1_hqb} Tipo de dados: booliano | | productOrderItem | Lista que descreve itens associados ao pedido de produto e sua ação associada. Tipo de dados: matriz "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 executada no produto. As ações possíveis são definidas na guia Lista de seleção na Entrada do Dicionário de Ação da tabela sn_ind_tmt_orm_order_line_item. Tipo de dados: cadeia de caracteres | | productOrderItem.actionReason | O motivo para adicionar o item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Data e hora em que a ação deve ser realizada no item de linha do pedido. Tipo de dados: cadeia de caracteres | | productOrderItem.externalProductInventory | Matriz de objetos que contém IDs externos mapeados para os inventários de produtos criados para o pedido. Tipo de dados: matriz "externalProductInventory": [ { "externalProductInventoryId": "String" } ] | | productOrderItem.externalProductInventory.externalProductInventoryId | ID externo mapeado para o inventário de produtos. Tipo de dados: cadeia de caracteres | | productOrderItem.id | Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\]. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice | Matriz de objetos que descreve o preço associado ao produto. Tipo de dados: matriz "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} } | | produtoPedidoItem.itemPreço.preço.impostoValorincluído | 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 em que o preço é representado. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice.Price.TaxIncludedAmount.value | Preço do produto, incluindo impostos. 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 month. Tipo de dados: cadeia de caracteres | | productOrderItem.ponr | Sinalizador que indica se o ponto sem retorno do pedido foi atingido. Valores válidos: * verdadeiro: o ponto sem retorno do pedido foi atingido. * falso: o ponto sem retorno do pedido não foi atingido. {#tmf_prod_order-GET-ord-productOrder-id__d2876e2599} 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 | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre Place. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto | Matriz de objetos que descreve as características do produto associado. Somente as características do produto cujos value são diferentes de previousValue são retornadas. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica \[sn_prd_pm_characteristic\]. Tipo de dados: cadeia de caracteres | | productOrderItem.product.productCharacteristic.previousValue | A opção de característica anterior será válida se a atualização for para uma ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro productOrderItem.action for diferente de add. Para obter informações adicionais sobre valores de opção de característica, consulte [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto.valor | 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](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres | | productOrderItem.product.productRelationship | Lista de detalhes do relacionamento do produto para um item de linha do 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 de produtos. Localizado no campo sys_id ou sn_prd_invt_external_id da tabela Inventário de produtos \[sn_prd_invt_product_inventory\]. Tipo de dados: cadeia de caracteres | | 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. O 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 | Initial_version da especificação do produto. O initial_version é o sys_id da primeira versão da especificação. Localizado na 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. Localizado na 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.version | External_version da especificação do produto. Localizado na tabela Especificação do produto \[sn_prd_pm_product_specification\]. Tipo de dados: cadeia de caracteres | | 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 "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 de item de linha do pedido \[sn_ind_tmt_orm_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 | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.productOferta | 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. O 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 | Initial_version da oferta de produto. O initial_version é o sys_id da primeira versão da oferta. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | productOrderItem.productOffering.internalVersion | Versão da oferta de produto. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | 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.productOferta.versão | External_version da oferta de produto. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | productOrderItem.quantity | Número de itens de produto comprados. Tipo de dados: número | | productOrderItem.productOrderItemRelationship | Matriz de objetos que descreve os relacionamentos entre itens de linha do pedido. Tipo de dados: matriz "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_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: * TemSecundário * Tem pai * Requer {#tmf_prod_order-GET-ord-productOrder-id__ul_yqf_2ty_54b} `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.estado | Estado da ordem do item de produto associado. Tipo de dados: cadeia de caracteres | | productOrderItem.version | Versão do pedido. Tipo de dados: cadeia de caracteres | | productOrderItem.@type | Parte do padrão TMF Open API. Anotação do 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 contenha informações da conta do cliente ou da conta do consumidor. Tipo de dados: matriz "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.@referredType | Tipo de cliente. Valores possíveis: * Consumidor * Cliente * CustomerContact {#tmf_prod_order-GET-ord-productOrder-id__ul_lcq_jwm_t4b} Tipo de dados: cadeia de caracteres | | relatedParty.@type | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | requestCompletionDate | Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres | | requestStartDate | 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 | | @tipo | Parte do padrão TMF Open API. Anotação do 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 aberta de pedido de produto - GET /sn_ind_tmt_orm/productorder {#ariaid-title4} Recupera todos os pedidos de produtos. Importante: A partir da versão Tokyo, este endpoint está obsoleto. A nova versão deste endpoint é [API aberta de pedido de produto - GET /sn_ind_tmt_orm/order/productOrder](https://servicenow-prod.fluidtopics.net/FRGX3jDFdlGt~NrxolgqRg#tmf_prod_order-GET-ord-productOrder "Recupera todos os pedidos de produtos."). Este endpoint recupera informações de pedido das seguintes tabelas: * Pedido do cliente \[sn_ind_tmt_orm_order\] * Característica do pedido \[sn_ind_tmt_orm_order_characteristic_value\] * Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\] * Contato do item de linha do pedido \[sn_ind_tmt_orm_order_line_item_contact\] {#tmf_prod_order-GET-productorder__ul_lxc_kxm_t4b} ### Formato da URL {#tmf_prod_order-GET-productorder__section_mbm_2ct_t4b} URL padrão: /api/sn_ind_tmt_orm/productorder ### Parâmetros de solicitação compatíveis {#tmf_prod_order-GET-productorder__table_ofr_vgy_fsb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 13. Parâmetros de caminho] {#tmf_prod_order-GET-productorder__table_ofr_vgy_fsb} {#tmf_prod_order-GET-productorder__table_pfr_vgy_fsb__entry__2} | 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 o parâmetro offset para paginar a recuperação do registro. Padrão: 20 Máximo: 100 Tipo de dados: número | | deslocamento | Índice inicial no qual os registros serão recuperados. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Padrão: 0 Tipo de dados: número | | 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 14. Parâmetros de consulta] {#tmf_prod_order-GET-productorder__table_pfr_vgy_fsb} {#tmf_prod_order-GET-productorder__table_xcm_cvr_nsb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 15. Parâmetros do corpo da solicitação (JSON)] {#tmf_prod_order-GET-productorder__table_xcm_cvr_nsb} ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-GET-productorder__table_kqy_wgy_fsb__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 16. Cabeçalhos da solicitação] {#tmf_prod_order-GET-productorder__table_kqy_wgy_fsb} {#tmf_prod_order-GET-productorder__table_h4r_fxr_nsb__entry__2}{#tmf_prod_order-GET-productorder__content-range-row}{#tmf_prod_order-GET-productorder__content-type-row}{#tmf_prod_order-GET-productorder__links-pagination-row}{#tmf_prod_order-GET-productorder__x-total-count-descr} | Cabeçalho | Descrição | |-|-| | Intervalo de conteúdo | Especifica o intervalo de conteúdo retornado em uma chamada paginada. Por exemplo, se `deslocamento=2` e `limite=3`, o valor do cabeçalho Content-Range será `itens 3-5`. | | Tipo de conteúdo | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | | Link | Contém os links a seguir para navegar pelos resultados da consulta. * primeiro * último * avançar * anterior {#tmf_prod_order-GET-productorder__ul_zzk_sdm_lsb} | | X-Total-Contagem | Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor. | [Tabela 17. Cabeçalhos de resposta] {#tmf_prod_order-GET-productorder__table_h4r_fxr_nsb} ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-GET-productorder__table_wdl_3xr_nsb__entry__2}{#tmf_prod_order-GET-productorder__tmf-get-status-200-p}{#tmf_prod_order-GET-productorder__tmf-get-status-206-entry}{#tmf_prod_order-GET-productorder__tmf-get-status-400-entry}{#tmf_prod_order-GET-productorder__tmf-get-status-404-entry} | Código de status | Descrição | |-|-| | 200 | Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação). | | 206 | Recurso parcial retornado em resposta (com paginação). | | 400 | Solicitação incorreta. Possíveis motivos: * Parâmetro de caminho inválido * URI inválido {#tmf_prod_order-GET-productorder__ul_rys_1gy_fsb} | | 404 | Registro não encontrado. Nenhum registro correspondente aos parâmetros de consulta foi encontrado na tabela. | [Tabela 18. Códigos de status] {#tmf_prod_order-GET-productorder__table_wdl_3xr_nsb} ### Parâmetros do corpo da resposta (JSON) {#tmf_prod_order-GET-productorder__section_hnf_kxr_nsb} {#tmf_prod_order-GET-productorder__table_inf_kxr_nsb__entry__2} | Nome | Descrição | |-|-| | canal | Matriz de objetos que descreve os canais a serem usados para vender os produtos. Tipo de dados: matriz "channel": [ { "id": "String", "name": "String" } ] | | canal.id | Identificador exclusivo do canal a ser usado para vender os produtos associados. Os valores de ID de 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 | | canal.nome | Nome do canal a ser usado para vender os produtos associados. Tipo de dados: cadeia de caracteres | | DataDeConclusão esperada | Data em que o pedido será concluído. Tipo de dados: cadeia de caracteres | | anotação | Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz "note": { "author": "String", "date": "String", "text": "String" } | | anotação.autor | Nome de usuário da pessoa que criou a anotação associada. Tipo de dados: cadeia de caracteres | | anotação.data | Data em que a anotação foi criada. Tipo de dados: cadeia de caracteres | | anotação.texto | Anotaçõ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 válidos: * verdadeiro: o ponto sem retorno do pedido foi atingido. * falso: o ponto sem retorno do pedido não foi atingido. {#tmf_prod_order-GET-productorder__ul_tdq_rw1_hqb} Tipo de dados: booliano | | productOrderItem | Lista que descreve itens associados ao pedido de produto e sua ação associada. Tipo de dados: matriz "productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.ação | Ação a ser executada no produto. As ações possíveis são definidas na guia Lista de seleção na Entrada do Dicionário de Ação da tabela sn_ind_tmt_orm_order_line_item. Tipo de dados: cadeia de caracteres | | productOrderItem.actionReason | O motivo para adicionar o item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.id | Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\]. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice | Matriz de objetos que descreve o preço associado ao produto. Tipo de dados: matriz "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} } | | produtoPedidoItem.itemPreço.preço.impostoValorincluído | 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 em que o preço é representado. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice.Price.TaxIncludedAmount.value | Preço do produto, incluindo impostos. 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 month. Tipo de dados: cadeia de caracteres | | productOrderItem.ponr | Sinalizador que indica se o ponto sem retorno do pedido foi atingido. Valores válidos: * verdadeiro: o ponto sem retorno do pedido foi atingido. * falso: o ponto sem retorno do pedido não foi atingido. {#tmf_prod_order-GET-productorder__d2876e2599} 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 | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre Place. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto | Matriz de objetos que descreve as características do produto associado. Somente as características do produto cujos value são diferentes de previousValue são retornadas. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica \[sn_prd_pm_characteristic\]. Tipo de dados: cadeia de caracteres | | productOrderItem.product.productCharacteristic.previousValue | A opção de característica anterior será válida se a atualização for para uma ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro productOrderItem.action for diferente de add. Para obter informações adicionais sobre valores de opção de característica, consulte [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto.valor | 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](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). 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. O 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 "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 de item de linha do pedido \[sn_ind_tmt_orm_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 | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.productOferta | 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. O 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.quantity | Número de itens de produto comprados. Tipo de dados: número | | productOrderItem.productOrderItemRelationship | Matriz de objetos que descreve os relacionamentos entre itens de linha do pedido. Tipo de dados: matriz "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_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: * TemSecundário * Tem pai * Requer {#tmf_prod_order-GET-productorder__ul_yqf_2ty_54b} `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.estado | Estado da ordem do item de produto associado. Tipo de dados: cadeia de caracteres | | productOrderItem.version | Versão do pedido. Tipo de dados: cadeia de caracteres | | productOrderItem.@type | Parte do padrão TMF Open API. Anotação do 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 contenha informações da conta do cliente ou da conta do consumidor. Tipo de dados: matriz "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.@referredType | Tipo de cliente. Valores possíveis: * Consumidor * Cliente * CustomerContact {#tmf_prod_order-GET-productorder__ul_lcq_jwm_t4b} Tipo de dados: cadeia de caracteres | | relatedParty.@tipo | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | requestCompletionDate | Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres | | requestStartDate | 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 | | @tipo | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre ProductOrder. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | [ ] {#tmf_prod_order-GET-productorder__table_inf_kxr_nsb} ### 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 aberta de pedido de produto - GET /sn_ind_tmt_orm/productorder/{id} {#ariaid-title5} Recupera o pedido de produto especificado. Importante: A partir da versão Tokyo, este endpoint está obsoleto. A nova versão deste endpoint é [API aberta de pedido de produto - GET /sn_ind_tmt_orm/order/productOrder/{id}](https://servicenow-prod.fluidtopics.net/FRGX3jDFdlGt~NrxolgqRg#tmf_prod_order-GET-ord-productOrder-id "Recupera o pedido de produto especificado."). Este endpoint recupera informações de pedido das seguintes tabelas: * Pedido do cliente \[sn_ind_tmt_orm_order\] * Característica do pedido \[sn_ind_tmt_orm_order_characteristic_value\] * Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\] * Contato do item de linha do pedido \[sn_ind_tmt_orm_order_line_item_contact\] {#tmf_prod_order-GET-productOrder-id__ul_lxc_kxm_t4b} ### Formato da URL {#tmf_prod_order-GET-productOrder-id__section_mbm_2ct_t4b} URL padrão: /api/sn_ind_tmt_orm/productorder/{id} ### Parâmetros de solicitação compatíveis {#tmf_prod_order-GET-productOrder-id__entry__2} | Nome | Descrição | |-|-| | ID | Sys_id ou external_id do pedido do cliente a ser recuperado. Localizado na tabela Pedido do cliente \[sn_ind_tmt_orm_order\]. Tipo de dados: cadeia de caracteres | [Tabela 19. Parâmetros de caminho] {#tmf_prod_order-GET-productOrder-id__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 20. Parâmetros de consulta] {#tmf_prod_order-GET-productOrder-id__entry__10} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 21. Parâmetros do corpo da solicitação (JSON)] ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-GET-productOrder-id__table_kqy_wgy_fsb__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 22. Cabeçalhos da solicitação] {#tmf_prod_order-GET-productOrder-id__table_kqy_wgy_fsb} {#tmf_prod_order-GET-productOrder-id__table_tzy_thy_ksb__entry__2} | Cabeçalho | Descrição | |-|-| | Tipo de conteúdo | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 23. Cabeçalhos de resposta] {#tmf_prod_order-GET-productOrder-id__table_tzy_thy_ksb} ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-GET-productOrder-id__entry__22}{#tmf_prod_order-GET-productOrder-id__entry-404-status-code} | Código de 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. | [Tabela 24. Códigos de status] ### Parâmetros do corpo da resposta (JSON) {#tmf_prod_order-GET-productOrder-id__entry__30} | Nome | Descrição | |-|-| | canal | Matriz de objetos que descreve os canais a serem usados para vender os produtos. Tipo de dados: matriz "channel": [ { "id": "String", "name": "String" } ] | | canal.id | Identificador exclusivo do canal a ser usado para vender os produtos associados. Os valores de ID de 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 | | canal.nome | Nome do canal a ser usado para vender os produtos associados. Tipo de dados: cadeia de caracteres | | DataDeConclusão esperada | Data em que o pedido será concluído. Tipo de dados: cadeia de caracteres | | anotação | Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz "note": { "author": "String", "date": "String", "text": "String" } | | anotação.autor | Nome de usuário da pessoa que criou a anotação associada. Tipo de dados: cadeia de caracteres | | anotação.data | Data em que a anotação foi criada. Tipo de dados: cadeia de caracteres | | anotação.texto | Anotaçõ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 válidos: * verdadeiro: o ponto sem retorno do pedido foi atingido. * falso: o ponto sem retorno do pedido não foi atingido. {#tmf_prod_order-GET-productOrder-id__ul_tdq_rw1_hqb} Tipo de dados: booliano | | productOrderItem | Lista que descreve itens associados ao pedido de produto e sua ação associada. Tipo de dados: matriz "productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.ação | Ação a ser executada no produto. As ações possíveis são definidas na guia Lista de seleção na Entrada do Dicionário de Ação da tabela sn_ind_tmt_orm_order_line_item. Tipo de dados: cadeia de caracteres | | productOrderItem.actionReason | O motivo para adicionar o item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.id | Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\]. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice | Matriz de objetos que descreve o preço associado ao produto. Tipo de dados: matriz "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} } | | produtoPedidoItem.itemPreço.preço.impostoValorincluído | 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 em que o preço é representado. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice.Price.TaxIncludedAmount.value | Preço do produto, incluindo impostos. 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 month. Tipo de dados: cadeia de caracteres | | productOrderItem.ponr | Sinalizador que indica se o ponto sem retorno do pedido foi atingido. Valores válidos: * verdadeiro: o ponto sem retorno do pedido foi atingido. * falso: o ponto sem retorno do pedido não foi atingido. {#tmf_prod_order-GET-productOrder-id__d2876e2599} 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 | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre Place. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto | Matriz de objetos que descreve as características do produto associado. Somente as características do produto cujos value são diferentes de previousValue são retornadas. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica \[sn_prd_pm_characteristic\]. Tipo de dados: cadeia de caracteres | | productOrderItem.product.productCharacteristic.previousValue | A opção de característica anterior será válida se a atualização for para uma ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro productOrderItem.action for diferente de add. Para obter informações adicionais sobre valores de opção de característica, consulte [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto.valor | 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](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). 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. O 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 "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 de item de linha do pedido \[sn_ind_tmt_orm_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 | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.productOferta | 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. O 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 | Matriz de objetos que descreve os relacionamentos entre itens de linha do pedido. Tipo de dados: matriz "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_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: * TemSecundário * Tem pai * Requer {#tmf_prod_order-GET-productOrder-id__ul_yqf_2ty_54b} `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.estado | Estado da ordem do item de produto associado. Tipo de dados: cadeia de caracteres | | productOrderItem.version | Versão do pedido. Tipo de dados: cadeia de caracteres | | productOrderItem.@type | Parte do padrão TMF Open API. Anotação do 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 contenha informações da conta do cliente ou da conta do consumidor. Tipo de dados: matriz "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.@referredType | Tipo de cliente. Valores possíveis: * Consumidor * Cliente * CustomerContact {#tmf_prod_order-GET-productOrder-id__ul_lcq_jwm_t4b} Tipo de dados: cadeia de caracteres | | relatedParty.@type | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | requestCompletionDate | Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres | | requestStartDate | 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 | | @tipo | Parte do padrão TMF Open API. Anotação do 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 um pedido 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 aberta de pedido de produto - PATCH /sn_ind_tmt_orm/order/productOrder/{id} {#ariaid-title6} Atualiza o pedido do cliente especificado. ### Formato da URL URL padrão: /api/sn_ind_tmt_orm/order/productOrder/{id} ### Parâmetros de solicitação compatíveis {#tmf_prod_order-PATCH-ord-productOrder-id__entry__2} | Nome | Descrição | |-|-| | ID | Sys_id do pedido do cliente a ser atualizado. Localizado na tabela Pedido do cliente \[sn_ind_tmt_orm_order\]. Tipo de dados: cadeia de caracteres | [Tabela 25. Parâmetros de caminho] {#tmf_prod_order-PATCH-ord-productOrder-id__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 26. Parâmetros de consulta] {#tmf_prod_order-PATCH-ord-productOrder-id__id_vk2_p5n_t4b__entry__2}{#tmf_prod_order-PATCH-ord-productOrder-id__channel-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__channel_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__channel_name-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__due-date-PATCH}{#tmf_prod_order-PATCH-ord-productOrder-id__externalId-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__note-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__note_text-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_action-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_actionReason-response-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__due-date-item-PATCH}{#tmf_prod_order-PATCH-ord-productOrder-id__externalProdInv-descr-PATCH}{#tmf_prod_order-PATCH-ord-productOrder-id__externalProdInvId-decsr}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt_unit-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt_value-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_priceType_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_recurringChargePeriod_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_place-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_place_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_place_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_name-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_previousValue-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_value-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_email-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_firstName-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_lastName-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_phone-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_refType_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_relatedParty_type_data_type-row-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__productOffer-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOffer_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOffer_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_quantity-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel_relType_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_type-entry-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty_refType_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__requestedCompletionDate-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__reqStartDate-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__type-entry-tmf622} | Nome | Descrição | |-|-| | canal | Matriz de objetos que descreve os canais a serem usados para vender os produtos. Tipo de dados: matriz{#tmf_prod_order-PATCH-ord-productOrder-id__channel_data_type-p-tmf622} "channel": [ { "id": "String", "name": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__channel_obj_def-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order | | canal.id | Obrigatório se o parâmetro channel for usado. Identificador exclusivo do canal a ser usado para vender os produtos associados. Os valores de ID de 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{#tmf_prod_order-PATCH-ord-productOrder-id__channel_id_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order/channel Padrão: cadeia de caracteres em branco | | canal.nome | 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 de Dicionário de Canal da tabela sn_ind_tmt_orm_order. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__channel_name_data_type-p-tmf622} Padrão: cadeia de caracteres em branco | | committedDueDate | Data e hora em que a ação deve ser realizada no pedido. Este valor deve ser igual ou posterior aos valores committedDueDate de 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 poderá ser atualizado. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/committed_due_date | | externalId | Identificador exclusivo do pedido do cliente. Este valor é determinado por um sistema externo. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__externalId_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order/external_id Padrão: cadeia de caracteres em branco | | anotação | Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz{#tmf_prod_order-PATCH-ord-productOrder-id__note_data_type-p-tmf622} "note": [ { "text": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__note-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order | | anotação.texto | Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__note_text_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order/comments Padrão: cadeia de caracteres em branco | | orderCurrency | Código da moeda para o pedido e itens de linha do pedido. Não há suporte para atualização do código da moeda de um pedido existente. 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 itens associados ao pedido de produto e sua ação associada. Tipo de dados: matriz{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_data_type-p-tmf622} "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" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.ação | Obrigatório se o parâmetro productOrderItem for usado. Ação a ser executada no produto. As ações possíveis são definidas na guia Lista de seleção na Entrada do Dicionário de Ação da tabela sn_ind_tmt_orm_order_line_item. Valores possíveis: * adicionar * mudança * excluir * sem mudança * resume * suspender {#tmf_prod_order-PATCH-ord-productOrder-id__ul_zwn_nxp_ysb} Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_action_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action Padrão: adicionar | | productOrderItem.actionReason | O motivo para adicionar o item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Data e hora em que a ação deve ser realizada no item de linha do pedido. Se a ação do item for suspender ou retomar, este parâmetro não poderá ser atualizado. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/committed_due_date | | productOrderItem.externalProductInventory | Matriz de objetos que contém IDs externas a serem mapeadas para os inventários de produtos criados para o pedido. Tipo de dados: matriz "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 a versão 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 de produtos. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/external_inventory_id e sn_prd_invt_product_inventory/sn_prd_invt_external_id | | productOrderItem.id | Obrigatório se o parâmetro productOrderItem for usado. Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\]. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_id_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/external_id Tamanho máximo: 40 Padrão: cadeia de caracteres em branco | | productOrderItem.itemPrice | Matriz de objetos que descreve o preço associado ao produto. Tipo de dados: matriz{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_data_type-p-tmf622} "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice-codeblock-tmf622} Tabela atualizada: sn_ind_tmt_orm_order Padrão: cadeia de caracteres em branco | | productOrderItem.itemPrice.Price | Descrição do preço do produto associado. Tipo de dados: objeto{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_data_type-p-tmf622} "price": { "taxIncludedAmount": {Object} } {#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price-codeblock-tmf622} Tabela atualizada: sn_ind_tmt_orm_order_line_item Padrão: cadeia de caracteres em branco | | produtoPedidoItem.itemPreço.preço.impostoValorincluído | Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: objeto{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt_data_type-p-tmf622} "taxIncludedAmount": { "unit": "String", "value": Number } {#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt-codeblock-tmf622} Tabela atualizada: sn_ind_tmt_orm_order_line_item | | productOrderItem.itemPrice.Price.TaxIncludedAmount.unit | Código da moeda em que o preço é representado. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt_unit_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/mrc ou nrc | | productOrderItem.itemPrice.Price.TaxIncludedAmount.value | Preço do produto, incluindo impostos. Tipo de dados: número{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt_value_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/mrc ou nrc | | 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 month. Tipo de dados: cadeia de caracteres | | productOrderItem.product | Obrigatório se productOrderItem.action for mudança ou exclusão. Descrição dos detalhes da instância do produto comprado pelo cliente. Tipo de dados: objeto{#tmf_prod_order-PATCH-ord-productOrder-id__product_data_type-p-tmf622} "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } {#tmf_prod_order-PATCH-ord-productOrder-id__product-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.id | Obrigatório se productOrderItem.action for mudança ou exclusão. Identificador exclusivo do produto vendido. Localizado no campo sys_id ou sn_ind_tmt_orm_external_id da tabela Inventário de produtos \[sn_ind_tmt_orm_product_inventory\]. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__product_id_data_type-p-tmf622} Padrão: cadeia de caracteres em branco | | productOrderItem.product.place | Mapas dos locais nos quais o produto será instalado. Tipo de dados: objeto{#tmf_prod_order-PATCH-ord-productOrder-id__product_place_data_type-p-tmf622} "place": { "id": "String", "@type": "String" } {#tmf_prod_order-PATCH-ord-productOrder-id__product_place-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.place.id | Obrigatório se o parâmetro productOrderItem.product.place for usado. Sys_id do registro de local associado na tabela Local \[cmn_location\]. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__product_place_id_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/location Padrão: cadeia de caracteres em branco | | productOrderItem.product.place.@type | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre Place. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto | Matriz de objetos que descreve as características do produto associado. Tipo de dados: matriz{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_data_type-p-tmf622} "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value | | produtoPedidoItem.produto.característicadoproduto.nome | Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica \[sn_prd_pm_characteristic\]. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_name_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value/characteristics Padrão: cadeia de caracteres em branco | | productOrderItem.product.productCharacteristic.previousValue | A opção de característica anterior será válida se a atualização for para uma ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro productOrderItem.action for diferente de add. Para obter informações adicionais sobre valores de opção de característica, consulte [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_previousValue_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value Padrão: cadeia de caracteres em branco | | produtoPedidoItem.produto.característicadoproduto.valor | 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](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_value_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Padrão: cadeia de caracteres em branco | | productOrderItem.product.productSpecification | Descrição da especificação do produto associada ao produto. Nota: As ordens de mudança (productOrderItem.action é `mudança`) são processadas de forma diferente com base no valor da propriedade do sistema sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder. O valor desta propriedade do sistema determina como o pedido será processado se o inventário do produto for de 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 referenciada. Isso permite que o pedido seja processado com sucesso. * Quando esta propriedade do sistema estiver definida como falsa, se o inventário do produto tiver uma versão diferente da indicada no pedido, o pedido falhará devido à incompatibilidade de versão. {#tmf_prod_order-PATCH-ord-productOrder-id__ul_sgb_q5y_hbc} Tipo de dados: objeto{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec_data_type-p-tmf622} "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } {#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.productSpecification.id | Obrigatório se o parâmetro productOrderItem.product.productSpecification for usado. Initial_version ou external_id da especificação do produto. O 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. Localizado na 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.version | External_version da especificação do produto. Localizado na tabela Especificação do produto \[sn_prd_pm_product_specification\]. Tipo de dados: cadeia de caracteres | | 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{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_data_type-p-tmf622} "relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact | | productOrderItem.product.relatedParty.e-mail | Endereço de e-mail do contato. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_email_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/email Padrão: cadeia de caracteres em branco | | productOrderItem.product.relatedParty.firstName | Nome do contato. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_firstName_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/first_name Padrão: 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 de item de linha do pedido \[sn_ind_tmt_orm_order_line_item_contact\]. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_id_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/sys_id Padrão: cadeia de caracteres em branco | | productOrderItem.product.relatedParty.lastName | Sobrenome do contato. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_lastName_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/lastName Padrão: cadeia de caracteres em branco | | productOrderItem.product.relatedParty.phone | Número de telefone comercial do contato. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_phone_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/business_phone Padrão: cadeia de caracteres em branco | | productOrderItem.product.relatedParty.@referredType | Tipo de cliente. Valor possível: OrderLineItemContact{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_refType-p-tmf622} Tipo de dados: cadeia de caracteres | | productOrderItem.product.relatedParty.@type | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.product.@type | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre Product. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.productOferta | Descrição da oferta de produto associada ao produto. Tipo de dados: objeto{#tmf_prod_order-PATCH-ord-productOrder-id__prodOffer_data_type-p-tmf622} "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } {#tmf_prod_order-PATCH-ord-productOrder-id__prodOffer-codeblock-tmf622} Tabela atualizada: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOffering.id | Obrigatório se o parâmetro productOrderItem.productOffering for usado. Initial_version ou external_id da oferta de produto. O 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 de produto. Localizado na 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.productOferta.versão | External_version da oferta de produto. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | productOrderItem.productOrderItem.quantity | Número de itens associados a serem solicitados. Tipo de dados: número{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_quantity_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order/quantity Padrão: nulo | | productOrderItem.productOrderItemRelationship | Matriz de objetos que descreve os relacionamentos entre itens de linha do pedido. Tipo de dados: matriz{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel_data_type-p-tmf622} "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOrderItemRelationship.id | Obrigatório se o parâmetro productOrderItem.productOrderItemRelationship for usado. Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\]. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel_id_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/parent_line_item Padrão: 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: * TemSecundário * Tem pai * Requer {#tmf_prod_order-PATCH-ord-productOrder-id__ul_yqf_2ty_54b} `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.quantity | Número de itens solicitados. Tipo de dados: número Tabela/campo atualizado: sn_ind_tmt_orm_order/quantity Padrão: 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, caso ainda não exista. Se este valor for cancel, o item de linha será cancelado. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco | | productOrderItem.@type | Parte do padrão TMF Open API. Anotação do 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 contenha informações da conta do cliente ou da conta do consumidor. Tipo de dados: matriz{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty_data_type-p-tmf622} "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty-codeblock-tmf622} | | 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.@referredType | Tipo de cliente. Valores possíveis: * Consumidor * Cliente * CustomerContact {#tmf_prod_order-PATCH-ord-productOrder-id__ul_lcq_jwm_t4b} Tipo de dados: cadeia de caracteres | | relatedParty.@type | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | requestCompletionDate | Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__reqCompDate_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order/expected_end_date Padrão: cadeia de caracteres em branco | | requestStartDate | Data de início do pedido solicitada pelo cliente. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-ord-productOrder-id__reqStartDate_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order/expected_start_date Padrão: cadeia de caracteres em branco | | @tipo | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre ProductOrder. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | [Tabela 27. Parâmetros do corpo da solicitação (JSON)] {#tmf_prod_order-PATCH-ord-productOrder-id__id_vk2_p5n_t4b} ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-PATCH-ord-productOrder-id__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-PATCH-ord-productOrder-id__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-PATCH-ord-productOrder-id__content_type-JSON-only-entry-RESTAPI} | 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 28. Cabeçalhos da solicitação] {#tmf_prod_order-PATCH-ord-productOrder-id__table_omb_dvk_5rb} {#tmf_prod_order-PATCH-ord-productOrder-id__table_tzy_thy_ksb__entry__2} | Cabeçalho | Descrição | |-|-| | Tipo de conteúdo | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 29. Cabeçalhos de resposta] {#tmf_prod_order-PATCH-ord-productOrder-id__table_tzy_thy_ksb} ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-PATCH-ord-productOrder-id__table_xfv_2vk_5rb__entry__2} | Código de status | Descrição | |-|-| | 201 | Bem-sucedido. Se houver problemas com as características ou informações de 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 do pedido do cliente associado: * As seguintes características do item do pedido não existem: revise a especificação \ 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: \ com valor de característica: \é inválido. Corrija os valores da característica antes de aprovar o pedido. {#tmf_prod_order-PATCH-ord-productOrder-id__ul_xtx_xym_t4b} | | 400 | Solicitação Incorreta. Pode ser qualquer um dos seguintes motivos: * Cargainvá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 do pedido de produto ou JSON está ausente. * Carga inválida: id de productOrderItem está ausente - O parâmetro id está ausente no item de linha do pedido de produto da carga. * Carga inválida: a ação productOrderItem está ausente - O parâmetro action está ausente no item de linha do pedido de 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: id productOffering está ausente - O parâmetro id está ausente no item de linha do pedido de produto do objeto de oferta de produto na carga útil. * Carga inválida: a oferta de produto não existe - A oferta de produto no item de linha do pedido de produto não é válida. * Carga inválida: produto productOrderItem está ausente - O objeto do produto ou JSON no item de linha do pedido do produto está ausente na carga útil. * Carga inválida: produto productSpecification está ausente - O objeto de especificação do produto ou JSON no item de linha do pedido de produto está ausente na carga útil. * Carga inválida: id productSpecification está ausente - O parâmetro id no item de linha do pedido de produto do objeto de especificação do produto está ausente na carga útil. * 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 uma ordem de mudança (ação = mudança), a quantidade de um item é maior do que o que está no estoque. * Carga inválida: o ID de inventário do produto está ausente - Em uma ordem de mudança, o product.id está ausente na carga útil. * Carga inválida: o produto vendido está inativo - Em uma ordem de mudança, um produto especificado na carga está inativo. * Carga inválida: relatedParty está ausente - O objeto de parte relacionada está ausente na carga. * A conta do cliente ou o consumidor está ausente - o cliente ou o objeto do consumidor da parte relacionada está ausente na carga útil. * Carga inválida: o consumidor não existe --- O consumidor de parte relacionada especificado não existe na instância ServiceNow. * Carga inválida: a conta do cliente não existe - O cliente da parte relacionada especificado não existe na instância ServiceNow. * Carga inválida: falha na criação do pedido - Não é possível criar o pedido solicitado. * Revisão em curso para a moeda do pedido não é compatível - O parâmetro orderCurrency não pode ser atualizado depois que o pedido é criado. * Este pedido ainda não foi criado na tabela de pedidos do cliente. Verifique a fila de entrada para obter mais detalhes. -- o ID do pedido fornecido não está na tabela de pedidos do cliente. * A solicitação de patch não pode ser feita porque o tipo de execução do pedido não é "entrega". -- A solicitação de patch foi feita em um pedido que tem um tipo de execução diferente de entrega. {#tmf_prod_order-PATCH-ord-productOrder-id__ul_g2v_rzm_t4b} | [Tabela 30. Códigos de status] {#tmf_prod_order-PATCH-ord-productOrder-id__table_xfv_2vk_5rb} ### Parâmetros do corpo da resposta (JSON) {#tmf_prod_order-PATCH-ord-productOrder-id__section_b1v_xpk_5rb} {#tmf_prod_order-PATCH-ord-productOrder-id__table_c1v_xpk_5rb__entry__2}{#tmf_prod_order-PATCH-ord-productOrder-id__d2876e1605}{#tmf_prod_order-PATCH-ord-productOrder-id__externalProdInvId-resp-descr} | Nome | Descrição | |-|-| | canal | Matriz de objetos que descreve os canais a serem usados para vender os produtos. Tipo de dados: matriz "channel": [ { "id": "String", "name": "String" } ] | | canal.id | Identificador exclusivo do canal a ser usado para vender os produtos associados. Os valores de ID de 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 | | canal.nome | 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 realizada no pedido. Este valor deve ser igual ou posterior aos valores committedDueDate de cada item de linha do pedido. Tipo de dados: cadeia de caracteres | | externalId | Identificador externo do pedido do cliente, como um número de ordem de compra. Tipo de dados: cadeia de caracteres | | href | Link relativo ao registro do pedido do produto. Tipo de dados: cadeia de caracteres | | ID | Sys_id do pedido do cliente atualizado para esta solicitação. Tipo de dados: cadeia de caracteres | | anotação | Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz "note": [ { "text": "String" } ] | | anotação.texto | Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres | | orderCurrency | Código da moeda para o pedido e itens de linha do pedido. Tipo de dados: cadeia de caracteres | | productOrderItem | Lista que descreve itens associados ao pedido de produto e sua ação associada. Tipo de dados: matriz "productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.ação | Ação a ser executada no produto. As ações possíveis são definidas na guia Lista de seleção na Entrada do Dicionário de Ação da tabela sn_ind_tmt_orm_order_line_item. Tipo de dados: cadeia de caracteres | | productOrderItem.actionReason | O motivo para adicionar o item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Data e hora em que a ação deve ser realizada no item de linha do pedido. Tipo de dados: cadeia de caracteres | | productOrderItem.externalProductInventory | Matriz de objetos que contém IDs externas a serem mapeadas para os inventários de produtos criados para o pedido. Tipo de dados: matriz "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 a versão 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 de produtos. Tipo de dados: cadeia de caracteres | | productOrderItem.id | Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\]. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice | Matriz de objetos que descreve o preço associado ao produto. Tipo de dados: matriz "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 em que o preço é representado. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice.Price.TaxIncludeAmount.value | Preço do produto, incluindo impostos. 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 month. 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_orm_external_id da tabela Inventário de produtos \[sn_ind_tmt_orm_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 | | produtoPedidoItem.produto.característicadoproduto | Matriz de objetos que descreve as características do produto associado. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica \[sn_prd_pm_characteristic\]. Tipo de dados: cadeia de caracteres | | productOrderItem.product.productCharacteristic.previousValue | A opção de característica anterior será válida se a atualização for para uma ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro productOrderItem.action for diferente de add. Para obter informações adicionais sobre valores de opção de característica, consulte [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto.valor | 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](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). 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. O 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 | Initial_version da especificação do produto. O initial_version é o sys_id da primeira versão da especificação. Localizado na 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. Localizado na 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.version | External_version da especificação do produto. Localizado na tabela Especificação do produto \[sn_prd_pm_product_specification\]. Tipo de dados: cadeia de caracteres | | 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 "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 de item de linha do pedido \[sn_ind_tmt_orm_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 | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.product.@type | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre Product. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.productOferta | 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. O 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 | Initial_version da oferta de produto. O initial_version é o sys_id da primeira versão da oferta. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | productOrderItem.productOffering.internalVersion | Versão da oferta de produto. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | 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.productOferta.versão | External_version da oferta de produto. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | productOrderItem.productOrderItemRelationship | Matriz de objetos que descreve os relacionamentos entre itens de linha do pedido. Tipo de dados: matriz "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_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.quantity | Número de itens associados a serem solicitados. Tipo de dados: número | | productOrderItem.estado | Estado atual do item do pedido de produto. Tipo de dados: cadeia de caracteres | | productOrderItem.@type | Parte do padrão TMF Open API. Anotação do 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 contenha informações da conta do cliente ou da conta do consumidor. Tipo de dados: matriz "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: * Consumidor * Cliente * CustomerContact {#tmf_prod_order-PATCH-ord-productOrder-id__d2876e2462} Tipo de dados: cadeia de caracteres | | requestCompletionDate | Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres | | requestStartDate | 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 | | @tipo | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre ProductOrder. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | [ ] {#tmf_prod_order-PATCH-ord-productOrder-id__table_c1v_xpk_5rb} ### Solicitação de cURL {#tmf_prod_order-PATCH-ord-productOrder-id__example_jsc_1dc_vrb} 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 aberta de pedido de produto - PATCH /sn_ind_tmt_orm/productorder/{id} {#ariaid-title7} Atualiza o pedido do cliente especificado. Importante: A partir da versão Tokyo, este endpoint está obsoleto. A nova versão deste endpoint é [API aberta de pedido de produto - PATCH /sn_ind_tmt_orm/order/productOrder/{id}](https://servicenow-prod.fluidtopics.net/FRGX3jDFdlGt~NrxolgqRg#tmf_prod_order-PATCH-ord-productOrder-id "Atualiza o pedido do cliente especificado."). ### Formato da URL URL padrão: /api/sn_ind_tmt_orm/productorder/{id} ### Parâmetros de solicitação compatíveis {#tmf_prod_order-PATCH-productorder-id__entry__2} | Nome | Descrição | |-|-| | ID | Sys_id do pedido do cliente a ser atualizado. Localizado na tabela Pedido do cliente \[sn_ind_tmt_orm_order\]. Tipo de dados: cadeia de caracteres | [Tabela 31. Parâmetros de caminho] {#tmf_prod_order-PATCH-productorder-id__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 32. Parâmetros de consulta] {#tmf_prod_order-PATCH-productorder-id__id_vk2_p5n_t4b__entry__2}{#tmf_prod_order-PATCH-productorder-id__channel-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__channel_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__channel_name-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__due-date-PATCH}{#tmf_prod_order-PATCH-productorder-id__externalId-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__note-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__note_text-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_action-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_actionReason-response-tmf622}{#tmf_prod_order-PATCH-productorder-id__due-date-item-PATCH}{#tmf_prod_order-PATCH-productorder-id__externalProdInv-descr-PATCH}{#tmf_prod_order-PATCH-productorder-id__externalProdInvId-decsr}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_price-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt_unit-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt_value-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_priceType_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_recurringChargePeriod_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__product-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_place-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_place_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_place_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodChar-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_name-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_previousValue-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_value-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodSpec-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodSpec_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodSpec_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodSpec_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_email-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_firstName-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_lastName-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_phone-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_refType_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_relatedParty_type_data_type-row-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__productOffer-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOffer_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOffer_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_quantity-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel_relType_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_type-entry-tmf622}{#tmf_prod_order-PATCH-productorder-id__relatedParty-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__relatedParty_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__relatedParty_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__relatedParty_refType_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__relatedParty_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__requestedCompletionDate-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__reqStartDate-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__type-entry-tmf622} | Nome | Descrição | |-|-| | canal | Matriz de objetos que descreve os canais a serem usados para vender os produtos. Tipo de dados: matriz{#tmf_prod_order-PATCH-productorder-id__channel_data_type-p-tmf622} "channel": [ { "id": "String", "name": "String" } ] {#tmf_prod_order-PATCH-productorder-id__channel_obj_def-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order | | canal.id | Obrigatório se o parâmetro channel for usado. Identificador exclusivo do canal a ser usado para vender os produtos associados. Os valores de ID de 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{#tmf_prod_order-PATCH-productorder-id__channel_id_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order/channel Padrão: cadeia de caracteres em branco | | canal.nome | 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 de Dicionário de Canal da tabela sn_ind_tmt_orm_order. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__channel_name_data_type-p-tmf622} Padrão: cadeia de caracteres em branco | | committedDueDate | Data e hora em que a ação deve ser realizada no pedido. Este valor deve ser igual ou posterior aos valores committedDueDate de 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 poderá ser atualizado. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/committed_due_date | | externalId | Identificador exclusivo do pedido do cliente. Este valor é determinado por um sistema externo. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__externalId_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order/external_id Padrão: cadeia de caracteres em branco | | anotação | Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz{#tmf_prod_order-PATCH-productorder-id__note_data_type-p-tmf622} "note": [ { "text": "String" } ] {#tmf_prod_order-PATCH-productorder-id__note-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order | | anotação.texto | Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__note_text_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order/comments Padrão: cadeia de caracteres em branco | | orderCurrency | Código da moeda para o pedido e itens de linha do pedido. Não há suporte para atualização do código da moeda de um pedido existente. 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 itens associados ao pedido de produto e sua ação associada. Tipo de dados: matriz{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_data_type-p-tmf622} "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" } ] {#tmf_prod_order-PATCH-productorder-id__prodOrdItem-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.ação | Obrigatório se o parâmetro productOrderItem for usado. Ação a ser executada no produto. As ações possíveis são definidas na guia Lista de seleção na Entrada do Dicionário de Ação da tabela sn_ind_tmt_orm_order_line_item. Valores possíveis: * adicionar * mudança * excluir * sem mudança * resume * suspender {#tmf_prod_order-PATCH-productorder-id__ul_zwn_nxp_ysb} Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_action_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action Padrão: adicionar | | productOrderItem.actionReason | O motivo para adicionar o item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Data e hora em que a ação deve ser realizada no item de linha do pedido. Se a ação do item for suspender ou retomar, este parâmetro não poderá ser atualizado. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/committed_due_date | | productOrderItem.externalProductInventory | Matriz de objetos que contém IDs externas a serem mapeadas para os inventários de produtos criados para o pedido. Tipo de dados: matriz "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 a versão 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 de produtos. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/external_inventory_id e sn_prd_invt_product_inventory/sn_prd_invt_external_id | | productOrderItem.id | Obrigatório se o parâmetro productOrderItem for usado. Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\]. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_id_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/external_id Tamanho máximo: 40 Padrão: cadeia de caracteres em branco | | productOrderItem.itemPrice | Matriz de objetos que descreve o preço associado ao produto. Tipo de dados: matriz{#tmf_prod_order-PATCH-productorder-id__itemPrice_data_type-p-tmf622} "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] {#tmf_prod_order-PATCH-productorder-id__itemPrice-codeblock-tmf622} Tabela atualizada: sn_ind_tmt_orm_order Padrão: cadeia de caracteres em branco | | productOrderItem.itemPrice.Price | Descrição do preço do produto associado. Tipo de dados: objeto{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_data_type-p-tmf622} "price": { "taxIncludedAmount": {Object} } {#tmf_prod_order-PATCH-productorder-id__itemPrice_price-codeblock-tmf622} Tabela atualizada: sn_ind_tmt_orm_order_line_item Padrão: cadeia de caracteres em branco | | produtoPedidoItem.itemPreço.preço.impostoValorincluído | Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: objeto{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt_data_type-p-tmf622} "taxIncludedAmount": { "unit": "String", "value": Number } {#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt-codeblock-tmf622} Tabela atualizada: sn_ind_tmt_orm_order_line_item | | productOrderItem.itemPrice.Price.TaxIncludedAmount.unit | Código da moeda em que o preço é representado. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt_unit_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/mrc ou nrc | | productOrderItem.itemPrice.Price.TaxIncludedAmount.value | Preço do produto, incluindo impostos. Tipo de dados: número{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt_value_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/mrc ou nrc | | 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 month. Tipo de dados: cadeia de caracteres | | productOrderItem.product | Obrigatório se productOrderItem.action for mudança ou exclusão. Descrição dos detalhes da instância do produto comprado pelo cliente. Tipo de dados: objeto{#tmf_prod_order-PATCH-productorder-id__product_data_type-p-tmf622} "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } {#tmf_prod_order-PATCH-productorder-id__product-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.id | Obrigatório se productOrderItem.action for mudança ou exclusão. Identificador exclusivo do produto vendido. Localizado no campo sys_id ou sn_ind_tmt_orm_external_id da tabela Inventário de produtos \[sn_ind_tmt_orm_product_inventory\]. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__product_id_data_type-p-tmf622} Padrão: cadeia de caracteres em branco | | productOrderItem.product.place | Mapas dos locais nos quais o produto será instalado. Tipo de dados: objeto{#tmf_prod_order-PATCH-productorder-id__product_place_data_type-p-tmf622} "place": { "id": "String", "@type": "String" } {#tmf_prod_order-PATCH-productorder-id__product_place-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.place.id | Obrigatório se o parâmetro productOrderItem.product.place for usado. Sys_id do registro de local associado na tabela Local \[cmn_location\]. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__product_place_id_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/location Padrão: cadeia de caracteres em branco | | productOrderItem.product.place.@type | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre Place. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto | Matriz de objetos que descreve as características do produto associado. Tipo de dados: matriz{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_data_type-p-tmf622} "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] {#tmf_prod_order-PATCH-productorder-id__prod_prodChar-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value | | produtoPedidoItem.produto.característicadoproduto.nome | Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica \[sn_prd_pm_characteristic\]. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_name_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value/characteristics Padrão: cadeia de caracteres em branco | | productOrderItem.product.productCharacteristic.previousValue | A opção de característica anterior será válida se a atualização for para uma ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro productOrderItem.action for diferente de add. Para obter informações adicionais sobre valores de opção de característica, consulte [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_previousValue_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value Padrão: cadeia de caracteres em branco | | produtoPedidoItem.produto.característicadoproduto.valor | 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](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_value_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Padrão: cadeia de caracteres em branco | | productOrderItem.product.productSpecification | Descrição da especificação do produto associada ao produto. Nota: As ordens de mudança (productOrderItem.action é `mudança`) são processadas de forma diferente com base no valor da propriedade do sistema sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder. O valor desta propriedade do sistema determina como o pedido será processado se o inventário do produto for de 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 referenciada. Isso permite que o pedido seja processado com sucesso. * Quando esta propriedade do sistema estiver definida como falsa, se o inventário do produto tiver uma versão diferente da indicada no pedido, o pedido falhará devido à incompatibilidade de versão. {#tmf_prod_order-PATCH-productorder-id__ul_sgb_q5y_hbc} Tipo de dados: objeto{#tmf_prod_order-PATCH-productorder-id__prod_prodSpec_data_type-p-tmf622} "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } {#tmf_prod_order-PATCH-productorder-id__prod_prodSpec-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.productSpecification.id | Obrigatório se o parâmetro productOrderItem.product.productSpecification for usado. Initial_version ou external_id da especificação do produto. O 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. Localizado na 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.version | External_version da especificação do produto. Localizado na tabela Especificação do produto \[sn_prd_pm_product_specification\]. Tipo de dados: cadeia de caracteres | | 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{#tmf_prod_order-PATCH-productorder-id__prod_relParty_data_type-p-tmf622} "relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-productorder-id__prod_relParty-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact | | productOrderItem.product.relatedParty.e-mail | Endereço de e-mail do contato. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__prod_relParty_email_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/email Padrão: cadeia de caracteres em branco | | productOrderItem.product.relatedParty.firstName | Nome do contato. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__prod_relParty_firstName_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/first_name Padrão: 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 de item de linha do pedido \[sn_ind_tmt_orm_order_line_item_contact\]. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__prod_relParty_id_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/sys_id Padrão: cadeia de caracteres em branco | | productOrderItem.product.relatedParty.lastName | Sobrenome do contato. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__prod_relParty_lastName_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/lastName Padrão: cadeia de caracteres em branco | | productOrderItem.product.relatedParty.phone | Número de telefone comercial do contato. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__prod_relParty_phone_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/business_phone Padrão: cadeia de caracteres em branco | | productOrderItem.product.relatedParty.@referredType | Tipo de cliente. Valor possível: OrderLineItemContact{#tmf_prod_order-PATCH-productorder-id__prod_relParty_refType-p-tmf622} Tipo de dados: cadeia de caracteres | | productOrderItem.product.relatedParty.@type | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.product.@type | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre Product. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.productOferta | Descrição da oferta de produto associada ao produto. Tipo de dados: objeto{#tmf_prod_order-PATCH-productorder-id__prodOffer_data_type-p-tmf622} "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } {#tmf_prod_order-PATCH-productorder-id__prodOffer-codeblock-tmf622} Tabela atualizada: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOffering.id | Obrigatório se o parâmetro productOrderItem.productOffering for usado. Initial_version ou external_id da oferta de produto. O 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 de produto. Localizado na 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.productOferta.versão | External_version da oferta de produto. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | productOrderItem.productOrderItem.quantity | Número de itens associados a serem solicitados. Tipo de dados: número{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_quantity_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order/quantity Padrão: nulo | | productOrderItem.productOrderItemRelationship | Matriz de objetos que descreve os relacionamentos entre itens de linha do pedido. Tipo de dados: matriz{#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel_data_type-p-tmf622} "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] {#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel-codeblock-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOrderItemRelationship.id | Obrigatório se o parâmetro productOrderItem.productOrderItemRelationship for usado. Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\]. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel_id_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/parent_line_item Padrão: 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: * TemSecundário * Tem pai * Requer {#tmf_prod_order-PATCH-productorder-id__ul_yqf_2ty_54b} `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.quantity | Número de itens solicitados. Tipo de dados: número Tabela/campo atualizado: sn_ind_tmt_orm_order/quantity Padrão: 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, caso ainda não exista. Se este valor for cancel, o item de linha será cancelado. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco | | productOrderItem.@type | Parte do padrão TMF Open API. Anotação do 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 contenha informações da conta do cliente ou da conta do consumidor. Tipo de dados: matriz{#tmf_prod_order-PATCH-productorder-id__relatedParty_data_type-p-tmf622} "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-productorder-id__relatedParty-codeblock-tmf622} | | 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.@referredType | Tipo de cliente. Valores possíveis: * Consumidor * Cliente * CustomerContact {#tmf_prod_order-PATCH-productorder-id__ul_lcq_jwm_t4b} Tipo de dados: cadeia de caracteres | | relatedParty.@type | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | requestCompletionDate | Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__reqCompDate_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order/expected_end_date Padrão: cadeia de caracteres em branco | | requestStartDate | Data de início do pedido solicitada pelo cliente. Tipo de dados: cadeia de caracteres{#tmf_prod_order-PATCH-productorder-id__reqStartDate_data_type-p-tmf622} Tabela/campo atualizado: sn_ind_tmt_orm_order/expected_start_date Padrão: cadeia de caracteres em branco | | @tipo | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre ProductOrder. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | [Tabela 33. Parâmetros do corpo da solicitação (JSON)] {#tmf_prod_order-PATCH-productorder-id__id_vk2_p5n_t4b} ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-PATCH-productorder-id__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-PATCH-productorder-id__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-PATCH-productorder-id__content_type-JSON-only-entry-RESTAPI} | 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 34. Cabeçalhos da solicitação] {#tmf_prod_order-PATCH-productorder-id__table_omb_dvk_5rb} {#tmf_prod_order-PATCH-productorder-id__table_tzy_thy_ksb__entry__2} | Cabeçalho | Descrição | |-|-| | Tipo de conteúdo | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 35. Cabeçalhos de resposta] {#tmf_prod_order-PATCH-productorder-id__table_tzy_thy_ksb} ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-PATCH-productorder-id__table_xfv_2vk_5rb__entry__2} | Código de status | Descrição | |-|-| | 201 | Bem-sucedido. Se houver problemas com as características ou informações de 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 do pedido do cliente associado: * As seguintes características do item do pedido não existem: revise a especificação \ 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: \ com valor de característica: \é inválido. Corrija os valores da característica antes de aprovar o pedido. {#tmf_prod_order-PATCH-productorder-id__ul_xtx_xym_t4b} | | 400 | Solicitação Incorreta. Pode ser qualquer um dos seguintes motivos: * Cargainvá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 do pedido de produto ou JSON está ausente. * Carga inválida: id de productOrderItem está ausente - O parâmetro id está ausente no item de linha do pedido de produto da carga. * Carga inválida: a ação productOrderItem está ausente - O parâmetro action está ausente no item de linha do pedido de 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: id productOffering está ausente - O parâmetro id está ausente no item de linha do pedido de produto do objeto de oferta de produto na carga útil. * Carga inválida: a oferta de produto não existe - A oferta de produto no item de linha do pedido de produto não é válida. * Carga inválida: produto productOrderItem está ausente - O objeto do produto ou JSON no item de linha do pedido do produto está ausente na carga útil. * Carga inválida: produto productSpecification está ausente - O objeto de especificação do produto ou JSON no item de linha do pedido de produto está ausente na carga útil. * Carga inválida: id productSpecification está ausente - O parâmetro id no item de linha do pedido de produto do objeto de especificação do produto está ausente na carga útil. * 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 uma ordem de mudança (ação = mudança), a quantidade de um item é maior do que o que está no estoque. * Carga inválida: o ID de inventário do produto está ausente - Em uma ordem de mudança, o product.id está ausente na carga útil. * Carga inválida: o produto vendido está inativo - Em uma ordem de mudança, um produto especificado na carga está inativo. * Carga inválida: relatedParty está ausente - O objeto de parte relacionada está ausente na carga. * Carga inválida: a conta do cliente ou o consumidor está ausente - o cliente ou o objeto do consumidor da parte relacionada está ausente na carga útil. * Carga inválida: o consumidor não existe --- O consumidor de parte relacionada especificado não existe na instância ServiceNow. * Carga inválida: a conta do cliente não existe - O cliente da parte relacionada especificado não existe na instância ServiceNow. * Carga inválida: falha na criação do pedido - Não é possível criar o pedido solicitado. * Carga inválida: este pedido ainda não foi criado na tabela de pedidos do cliente. Verifique a 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 o programador selecionar 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 é "entrega". - A solicitação de patch foi feita para um pedido que tem um tipo de execução diferente de deliver. {#tmf_prod_order-PATCH-productorder-id__ul_g2v_rzm_t4b} | [Tabela 36. Códigos de status] {#tmf_prod_order-PATCH-productorder-id__table_xfv_2vk_5rb} ### Parâmetros do corpo da resposta (JSON) {#tmf_prod_order-PATCH-productorder-id__section_b1v_xpk_5rb} {#tmf_prod_order-PATCH-productorder-id__table_c1v_xpk_5rb__entry__2} | Nome | Descrição | |-|-| | canal | Matriz de objetos que descreve os canais a serem usados para vender os produtos. Tipo de dados: matriz "channel": [ { "id": "String", "name": "String" } ] | | canal.id | Identificador exclusivo do canal a ser usado para vender os produtos associados. Os valores de ID de 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 | | canal.nome | Nome do canal a ser usado para vender os produtos associados. Tipo de dados: cadeia de caracteres | | ID | Sys_id do pedido do cliente atualizado para esta solicitação. Tipo de dados: cadeia de caracteres | | externalId | Identificador externo do pedido do cliente, como um número de ordem de compra. Tipo de dados: cadeia de caracteres | | anotação | Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz "note": [ { "text": "String" } ] | | anotação.texto | Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres | | productOrderItem | Lista que descreve itens associados ao pedido de produto e sua ação associada. Tipo de dados: matriz "productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.ação | Ação a ser executada no produto. As ações possíveis são definidas na guia Lista de seleção na Entrada do Dicionário de Ação da tabela sn_ind_tmt_orm_order_line_item. Tipo de dados: cadeia de caracteres | | productOrderItem.actionReason | O motivo para adicionar o item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.id | Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\]. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice | Matriz de objetos que descreve o preço associado ao produto. Tipo de dados: matriz "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 em que o preço é representado. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice.Price.TaxIncludeAmount.value | Preço do produto, incluindo impostos. 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 month. 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_orm_external_id da tabela Inventário de produtos \[sn_ind_tmt_orm_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 | | produtoPedidoItem.produto.característicadoproduto | Matriz de objetos que descreve as características do produto associado. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica \[sn_prd_pm_characteristic\]. Tipo de dados: cadeia de caracteres | | productOrderItem.product.productCharacteristic.previousValue | A opção de característica anterior será válida se a atualização for para uma ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro productOrderItem.action for diferente de add. Para obter informações adicionais sobre valores de opção de característica, consulte [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto.valor | 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](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). 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. O 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 "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 de item de linha do pedido \[sn_ind_tmt_orm_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 | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.product.@type | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre Product. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.productOferta | 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. O 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 | Matriz de objetos que descreve os relacionamentos entre itens de linha do pedido. Tipo de dados: matriz "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_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.quantity | Número de itens associados a serem solicitados. Tipo de dados: número | | productOrderItem.estado | Estado atual do item do pedido de produto. Tipo de dados: cadeia de caracteres | | productOrderItem.@type | Parte do padrão TMF Open API. Anotação do 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 contenha informações da conta do cliente ou da conta do consumidor. Tipo de dados: matriz "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: * Consumidor * Cliente * CustomerContact {#tmf_prod_order-PATCH-productorder-id__d2876e2462} Tipo de dados: cadeia de caracteres | | requestCompletionDate | Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres | | requestStartDate | 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 | | @tipo | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre ProductOrder. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | [ ] {#tmf_prod_order-PATCH-productorder-id__table_c1v_xpk_5rb} ### Solicitação de cURL {#tmf_prod_order-PATCH-productorder-id__example_jsc_1dc_vrb} O exemplo de código a seguir atualiza o canal de um pedido do 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", "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", "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 aberta de pedido de produto - POST /sn_ind_tmt_orm/cancelproductorder {#ariaid-title8} Cancela o pedido do cliente especificado. ### Formato da URL URL padrão: /api/sn_ind_tmt_orm/cancelproductorder ### Parâmetros de solicitação compatíveis {#tmf_prod_order-POST-cancelproductorder__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 37. Parâmetros de caminho] {#tmf_prod_order-POST-cancelproductorder__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 38. Parâmetros de consulta] {#tmf_prod_order-POST-cancelproductorder__entry__10} | Nome | Descrição | |-|-| | cancelReason | Motivo do cancelamento. Tipo de dados: cadeia de caracteres Padrão: 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 do pedido do cliente a ser cancelado. Localizado na tabela Pedido do cliente \[sn_ind_tmt_orm_order\]. Tipo de dados: cadeia de caracteres | | productOrder.href | URL do pedido do cliente a ser cancelado. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco | | productOrder.@referredType | O valor deste parâmetro deve ser `ProductOrder`. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco | | requestCancellationDate | Data para cancelar o pedido. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco | | @tipo | O valor deste parâmetro deve ser `CancelProductOrder`. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco | [Tabela 39. Parâmetros do corpo da solicitação (JSON)] ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-POST-cancelproductorder__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-POST-cancelproductorder__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-POST-cancelproductorder__content_type-JSON-only-entry-RESTAPI} | 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 40. Cabeçalhos da solicitação] {#tmf_prod_order-POST-cancelproductorder__table_omb_dvk_5rb} {#tmf_prod_order-POST-cancelproductorder__table_tzy_thy_ksb__entry__2} | Cabeçalho | Descrição | |-|-| | Tipo de conteúdo | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 41. Cabeçalhos de resposta] {#tmf_prod_order-POST-cancelproductorder__table_tzy_thy_ksb} ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-POST-cancelproductorder__entry__36} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 400 | Solicitação Incorreta. Pode ser qualquer um dos seguintes motivos: * Carga vazia. * Carga inválida. Campo obrigatório ausente:\ . * ID do pedido inválido. * ID de pedido inválido: este pedido ainda não foi criado na tabela de pedidos do cliente. 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 o programador selecionar o registro. {#tmf_prod_order-POST-cancelproductorder__ul_lg1_5vt_5rb} | [Tabela 42. Códigos de status] ### Parâmetros do corpo da resposta (JSON) {#tmf_prod_order-POST-cancelproductorder__entry__42} | Nome | Descrição | |-|-| | cancelReason | 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 | Contém 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.@referredType | O valor deste parâmetro é `ProductOrder`. Tipo de dados: cadeia de caracteres | | requestCancellationDate | 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 | | @tipo | 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 aberta de pedido de produto - POST /sn_ind_tmt_orm/order/productOrder {#ariaid-title9} Cria o pedido do cliente especificado e os itens de linha do pedido do cliente. Depois de processados, os registros são criados nas seguintes tabelas: * Pedido do cliente \[sn_ind_tmt_orm_order\] * Característica do pedido \[sn_ind_tmt_orm_order_characteristic_value\] * Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\] * Contato do item de linha do pedido \[sn_ind_tmt_orm_order_line_item_contact\] * Itens relacionados à linha do pedido \[sn_ind_tmt_orm_order_line_related_items\] {#tmf_prod_order-POST-ord-productOrder__ul_hxq_vdb_hqb} ### Formato da URL URL padrão: /api/sn_ind_tmt_orm/order/productOrder ### Parâmetros de solicitação compatíveis {#tmf_prod_order-POST-ord-productOrder__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 43. Parâmetros de caminho] {#tmf_prod_order-POST-ord-productOrder__entry__6} | Nome | Descrição | |-|-| | modo | Habilita o processamento de pedidos assíncronos.​ 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 possível: assíncrono Tipo de dados: cadeia de caracteres | [Tabela 44. Parâmetros de consulta] {#tmf_prod_order-POST-ord-productOrder__id_vk2_p5n_t4b__entry__2}{#tmf_prod_order-POST-ord-productOrder__due-date-entry}{#tmf_prod_order-POST-ord-productOrder__productOrder-href-request}{#tmf_prod_order-POST-ord-productOrder__productOrder-addReason-request}{#tmf_prod_order-POST-ord-productOrder__due-date-item-entry}{#tmf_prod_order-POST-ord-productOrder__externalProductInventory-GET-desc-request}{#tmf_prod_order-POST-ord-productOrder__externalProductInventoryId-desc} | Nome | Descrição | |-|-| | canal | Matriz de objetos que descreve os canais a serem usados para vender os produtos. Tipo de dados: matriz "channel": [ { "id": "String", "name": "String" } ] Tabela/campo atualizado: sn_ind_tmt_orm_order | | canal.id | Obrigatório. Identificador exclusivo do canal a ser usado para vender os produtos associados. Os valores de ID de 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 Tabela/campo atualizado: sn_ind_tmt_orm_order/channel Padrão: cadeia de caracteres em branco | | canal.nome | 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 de Dicionário de Canal da tabela sn_ind_tmt_orm_order. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco | | committedDueDate | Data e hora em que a ação deve ser realizada no pedido. Este valor deve ser igual ou posterior aos valores committedDueDate de cada item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/committed_due_date | | externalId | Identificador exclusivo do pedido do cliente. Este valor é determinado por um sistema externo. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/external_id Padrão: cadeia de caracteres em branco | | href | Um link relativo para o registro do recurso. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco | | anotação | Matriz de objetos que contém anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz "note": [ { "text": "String" } ] Tabela/campo atualizado: sn_ind_tmt_orm_order | | anotação.texto | Obrigatório. Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/comments Padrão: cadeia de caracteres em branco | | orderCurrency | Obrigatório. Código da moeda para o pedido e itens de linha do pedido. A moeda deve ser a mesma para todos os elementos do pedido e itens de linha do pedido, caso contrário, será retornado um erro 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. Matriz de objetos que descreve itens associados ao pedido do produto e sua ação associada. Tipo de dados: matriz "productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ] Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.ação | Obrigatório. Ação a ser executada no produto. As ações possíveis são definidas na guia Lista de seleção na Entrada do Dicionário de Ação da tabela sn_ind_tmt_orm_order_line_item. Valores possíveis: * adicionar * mudança * excluir * sem mudança * resume * suspender {#tmf_prod_order-POST-ord-productOrder__ul_qbd_dyp_ysb} Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action | | productOrderItem.actionReason | Opcional. Descrição do motivo do item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Data e hora em que a ação deve ser realizada no item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/committed_due_date | | productOrderItem.externalProductInventory | Matriz de objetos que contém IDs externas a serem mapeadas 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 de produtos. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/external_inventory_id e sn_prd_invt_product_inventory/sn_prd_invt_external_id | | productOrderItem.id | Obrigatório. Identificador exclusivo do item de linha. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/external_id Tamanho máximo: 40 Padrão: cadeia de caracteres em branco | | productOrderItem.itemPrice | Matriz de objetos que descreve o preço associado ao produto. Tipo de dados: matriz "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] Tabela atualizada: sn_ind_tmt_orm_order Padrão: cadeia de caracteres em branco | | productOrderItem.itemPrice.Price | Descrição do preço do produto associado. Tipo de dados: objeto "price": { "taxIncludedAmount": {Object} } Tabela atualizada: sn_ind_tmt_orm_order_line_item Padrão: cadeia de caracteres em branco | | produtoPedidoItem.itemPreço.preço.impostoValorincluído | Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: objeto "taxIncludedAmount": { "unit": "String", "value": Number } Tabela atualizada: sn_ind_tmt_orm_order_line_item | | productOrderItem.itemPrice.Price.TaxIncludedAmount.unit | Código da moeda em que o preço é representado. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/mrc ou nrc | | productOrderItem.itemPrice.Price.TaxIncludedAmount.value | Preço do produto, incluindo impostos. Tipo de dados: número Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/mrc ou nrc | | productOrderItem.itemPrice.PriceType | Especifica se o preço do item é recorrente ou não recorrente. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice.recurringChargePeriod | Se o preço for recorrente, especifica o período recorrente, como month. Tipo de dados: cadeia de caracteres | | productOrderItem.product | Obrigatório se productOrderItem.action for 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" } Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.id | Obrigatório se productOrderItem.action for mudança ou exclusão. Identificador exclusivo do produto vendido. Localizado no campo sys_id ou sn_ind_tmt_orm_external_id da tabela Inventário de produtos \[sn_ind_tmt_orm_product_inventory\]. Tipo de dados: cadeia de caracteres Padrão: 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" } Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.place.id | Obrigatório. Sys_id do registro de local associado na tabela Local \[cmn_location\]. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/location | | productOrderItem.product.place.@type | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre Place. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto | Matriz de objetos que descreve as características do produto associado. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value | | productOrderItem.product.productCharacteristic.name | Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica \[sn_prd_pm_characteristic\]. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value/characteristics Padrão: cadeia de caracteres em branco | | productOrderItem.product.productCharacteristic.previousValue | A opção da característica anterior será válida se a atualização for para a ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro productOrderItem.action for diferente de add. Para obter informações adicionais sobre valores de opção de característica, consulte [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value Padrão: cadeia de caracteres em branco | | produtoPedidoItem.produto.característicadoproduto.valor | 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](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Padrão: cadeia de caracteres em branco | | productOrderItem.product.productSpecification | Obrigatório. Descrição da especificação do produto associada ao produto. Nota: As ordens de mudança (productOrderItem.action é `mudança`) são processadas de forma diferente com base no valor da propriedade do sistema sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder. O valor desta propriedade do sistema determina como o pedido será processado se o inventário do produto for de 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 referenciada. Isso permite que o pedido seja processado com sucesso. * Quando esta propriedade do sistema estiver definida como falsa, se o inventário do produto tiver uma versão diferente da indicada no pedido, o pedido falhará devido à incompatibilidade de versão. {#tmf_prod_order-POST-ord-productOrder__ul_zbw_sdz_dbc} Tipo de dados: objeto "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.productSpecification.id | Obrigatório. Initial_version ou external_id da especificação do produto. O 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. Localizado na 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.version | External_version da especificação do produto. Localizado na tabela Especificação do produto \[sn_prd_pm_product_specification\]. Tipo de dados: cadeia de caracteres | | 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 | Matriz de objetos que descreve a função da parte vinculada a um OrderLineItemContact. Tipo de dados: matriz "relatedParty": [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact | | productOrderItem.product.relatedParty.email | Endereço de e-mail do contato. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/email Padrão: cadeia de caracteres em branco | | productOrderItem.product.relatedParty.firstName | Nome do contato. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/first_name Padrão: cadeia de caracteres em branco | | productOrderItem.product.relatedParty.lastName | Sobrenome do contato. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/lastName Padrão: cadeia de caracteres em branco | | productOrderItem.product.relatedParty.phone | Número de telefone comercial do contato. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/business_phone Padrão: 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 | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.product.@type | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre Product. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.productOferta | Obrigatório. Descrição da oferta de produto associada ao produto. Tipo de dados: objeto "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } Tabela atualizada: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOffering.id | Obrigatório. Initial_version ou external_id da oferta de produto. O 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 de produto. Localizado na 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.productOferta.versão | External_version da oferta de produto. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | productOrderItem.productOrderItem.quantity | Número de itens associados a serem solicitados. Tipo de dados: número Tabela/campo atualizado: sn_ind_tmt_orm_order/quantity Padrão: nulo | | productOrderItem.productOrderItemRelationship | Obrigatório. Matriz de objetos que descreve o relacionamento primário/secundário entre itens do pedido. Tipo de dados: matriz "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOrderItemRelationship.id | Obrigatório. Igual ao valor productOrderItem.id. Usado para relacionamento primário/secundário Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/parent_line_item Padrão: 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: * TemSecundário * Tem pai {#tmf_prod_order-POST-ord-productOrder__ul_rmq_vrk_5rb} Tipo de dados: cadeia de caracteres | | productOrderItem.quantity | Número de itens solicitados. Tipo de dados: número Tabela/campo atualizado: sn_ind_tmt_orm_order/quantity Padrão: cadeia de caracteres em branco | | productOrderItem.@type | Parte do padrão TMF Open API. Anotação do 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 contenha informações da conta do cliente ou da conta do consumidor. Tipo de dados: matriz "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. 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.@referredType | Obrigatório. Tipo de cliente. Valores possíveis: * Consumidor * Cliente * CustomerContact {#tmf_prod_order-POST-ord-productOrder__ul_smq_vrk_5rb} Tipo de dados: cadeia de caracteres | | relatedParty.@type | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | requestCompletionDate | Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/expected_end_date Padrão: cadeia de caracteres em branco | | requestStartDate | Data de início do pedido solicitada pelo cliente. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/expected_start_date Padrão: cadeia de caracteres em branco | | @tipo | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre ProductOrder. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | [Tabela 45. Parâmetros do corpo da solicitação (JSON)] {#tmf_prod_order-POST-ord-productOrder__id_vk2_p5n_t4b} ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-POST-ord-productOrder__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-POST-ord-productOrder__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-POST-ord-productOrder__content_type-JSON-only-entry-RESTAPI} | 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 46. Cabeçalhos da solicitação] {#tmf_prod_order-POST-ord-productOrder__table_omb_dvk_5rb} {#tmf_prod_order-POST-ord-productOrder__table_tzy_thy_ksb__entry__2} | Cabeçalho | Descrição | |-|-| | Tipo de conteúdo | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 47. Cabeçalhos de resposta] {#tmf_prod_order-POST-ord-productOrder__table_tzy_thy_ksb} ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-POST-ord-productOrder__entry__152} | Código de status | Descrição | |-|-| | 201 | Bem-sucedido. Se houver problemas com as características ou informações de 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 do pedido do cliente associado: * As seguintes características do item do pedido não existem: revise a especificação \ 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: \ com valor de característica: \é inválido. Corrija os valores da característica antes de aprovar o pedido. {#tmf_prod_order-POST-ord-productOrder__ul_xtx_xym_t4b} | | 202 | Aceito. Solicitação bem-sucedida de um pedido no modo assíncrono. Ou seja, a solicitação foi feita com o parâmetro mode 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. Pode ser qualquer um dos seguintes motivos: * Cargainvá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 do pedido de produto ou JSON está ausente. * Carga inválida: id de productOrderItem está ausente - O parâmetro id está ausente no item de linha do pedido de produto da carga. * Carga inválida: a ação productOrderItem está ausente - O parâmetro action está ausente no item de linha do pedido de 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: id productOffering está ausente - O parâmetro id está ausente no item de linha do pedido de produto do objeto de oferta de produto na carga útil. * Carga inválida: a oferta de produto não existe - A oferta de produto no item de linha do pedido de produto não é válida. * Carga inválida: produto productOrderItem está ausente - O objeto do produto ou JSON no item de linha do pedido do produto está ausente na carga útil. * Carga inválida: produto productSpecification está ausente - O objeto de especificação do produto ou JSON no item de linha do pedido de produto está ausente na carga útil. * Carga inválida: id productSpecification está ausente - O parâmetro id no item de linha do pedido de produto do objeto de especificação do produto está ausente na carga útil. * 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 uma ordem de mudança (ação = mudança), a quantidade de um item é maior do que o que está no estoque. * Carga inválida: o ID de inventário do produto está ausente - Na ordem de mudança, o product.id está ausente na carga útil. * Carga inválida: o produto vendido está inativo - Em uma ordem de mudança, um produto especificado na carga está inativo. * Carga inválida: relatedParty está ausente - O objeto de parte relacionada está ausente na carga. * Carga inválida: a conta do cliente ou o consumidor está ausente - o cliente ou o objeto do consumidor da parte relacionada está ausente na carga útil. * Carga inválida: o consumidor não existe --- O consumidor de parte relacionada especificado não existe na instância ServiceNow. * Carga inválida: a conta do cliente não existe - O cliente da parte relacionada especificado não existe na instância ServiceNow. * Carga inválida: falha na criação do pedido - Não é possível criar o pedido solicitado. * Carga inválida: orderCurrency é obrigatório - o parâmetro orderCurrency está ausente na carga. * Código de moeda inativa: \ - A moeda fornecida está inativa na instância ServiceNow. * Um ou mais itens de linha têm um código de moeda diferente da moeda do pedido - Nem todos os itens de linha têm o mesmo código de moeda que a moeda do pedido. * Revisão em curso para a moeda do pedido não é compatível - O parâmetro orderCurrency não pode ser atualizado depois que o pedido é criado. {#tmf_prod_order-POST-ord-productOrder__ul_g2v_rzm_t4b} | [Tabela 48. Códigos de status] ### Parâmetros do corpo da resposta (JSON) {#tmf_prod_order-POST-ord-productOrder__entry__160}{#tmf_prod_order-POST-ord-productOrder__externalProdInv-resp-descr}{#tmf_prod_order-POST-ord-productOrder__externalProdInvId-resp-descr} | Nome | Descrição | |-|-| | canal | Matriz de objetos que descreve os canais a serem usados para vender os produtos. Tipo de dados: matriz "channel": [ { "id": "String", "name": "String" } ] | | canal.id | Identificador exclusivo do canal a ser usado para vender os produtos associados. Os valores de ID de 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 | | canal.nome | 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 realizada no pedido. Este valor deve ser igual ou posterior aos valores committedDueDate de cada item de linha do pedido. Tipo de dados: cadeia de caracteres | | externalId | Identificador externo do pedido do cliente, como um número de ordem de compra. Tipo de dados: cadeia de caracteres | | href | Link relativo ao registro do pedido do produto. Tipo de dados: cadeia de caracteres | | ID | Sys_id do pedido do cliente criado para esta solicitação. Tipo de dados: cadeia de caracteres | | anotação | Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz "note": [ { "text": "String" } ] | | anotação.texto | Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres | | orderCurrency | Código da moeda para o pedido e itens de linha do pedido. Tipo de dados: cadeia de caracteres | | orderId | Sys_id do pedido a ser criado. Mediante solicitação bem-sucedida, o pedido é adicionado à tabela Fila de entrada \[sn_tmt_core_inbound_queue\] em uma programação para ser processado. Nota: Este valor será o único resultado se o pedido for criado de forma assíncrona usando o parâmetro de consulta mode. { "orderId": "b0fc877ac3ab5110856d73ce3640dde0" } Tipo de dados: cadeia de caracteres | | productOrderItem | Lista que descreve itens associados ao pedido de produto e sua ação associada. Tipo de dados: matriz "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 executada no produto. As ações possíveis são definidas na guia Lista de seleção na Entrada do Dicionário de Ação da tabela sn_ind_tmt_orm_order_line_item. Tipo de dados: cadeia de caracteres | | productOrderItem.actionReason | O motivo para adicionar o item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Data e hora em que a ação deve ser realizada no item de linha do pedido. Tipo de dados: cadeia de caracteres | | productOrderItem.externalProductInventory | Matriz de objetos que contém IDs externos mapeados para os inventários de produtos criados para o pedido. Tipo de dados: matriz "externalProductInventory": [ { "externalProductInventoryId": "String" } ] | | productOrderItem.externalProductInventory.externalProductInventoryId | ID externo mapeado para o inventário de produtos. Tipo de dados: cadeia de caracteres | | productOrderItem.id | Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\]. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice | Matriz de objetos que descreve o preço associado ao produto. Tipo de dados: matriz "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 em que o preço é representado. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice.Price.TaxIncludeAmount.value | Preço do produto, incluindo impostos. 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 month. 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_orm_external_id da tabela Inventário de produtos \[sn_ind_tmt_orm_product_inventory\]. Este parâmetro só será retornado se productOrderItem.action for mudança ou exclusão. Se sys_id e external_id estiverem presentes, o 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 | | produtoPedidoItem.produto.característicadoproduto | Matriz de objetos que descreve as características do produto associado. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica \[sn_prd_pm_characteristic\]. Tipo de dados: cadeia de caracteres | | productOrderItem.product.productCharacteristic.previousValue | A opção de característica anterior será válida se a atualização for para uma ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro productOrderItem.action for diferente de add. Para obter informações adicionais sobre valores de opção de característica, consulte [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto.valor | 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](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres | | productOrderItem.product.productRelationship | Lista de detalhes do relacionamento do produto para um item de linha do 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 de produtos. Localizado no campo sys_id ou sn_prd_invt_external_id da tabela Inventário de produtos \[sn_prd_invt_product_inventory\]. Tipo de dados: cadeia de caracteres | | 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. O 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, o external_id será retornado. Tipo de dados: cadeia de caracteres | | productOrderItem.product.productSpecification.internalId | Initial_version da especificação do produto. O initial_version é o sys_id da primeira versão da especificação. Localizado na 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. Localizado na 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.version | External_version da especificação do produto. Localizado na tabela Especificação do produto \[sn_prd_pm_product_specification\]. Tipo de dados: cadeia de caracteres | | 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 "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 | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.product.@type | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre Product. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.productOferta | 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. O 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, o external_id será retornado. Tipo de dados: cadeia de caracteres | | productOrderItem.productOffering.internalId | Initial_version da oferta de produto. O initial_version é o sys_id da primeira versão da oferta. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | productOrderItem.productOffering.internalVersion | Versão da oferta de produto. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | 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.productOferta.versão | External_version da oferta de produto. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | productOrderItem.productOrderItemRelationship | Matriz de objetos que descreve os relacionamentos entre itens de linha do pedido. Tipo de dados: matriz "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_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: * TemSecundário * Tem pai * Requer {#tmf_prod_order-POST-ord-productOrder__ul_yqf_2ty_54b} `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.quantity | Número de itens associados a serem solicitados. Tipo de dados: número | | productOrderItem.estado | Estado atual do item do pedido de produto. Este valor é sempre novo. Tipo de dados: cadeia de caracteres | | productOrderItem.@type | Parte do padrão TMF Open API. Anotação do 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 contenha informações da conta do cliente ou da conta do consumidor. Tipo de dados: matriz "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: * Consumidor * Cliente * CustomerContact {#tmf_prod_order-POST-ord-productOrder__ul_lcq_jwm_t4b} Tipo de dados: cadeia de caracteres | | requestCompletionDate | Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres | | requestStartDate | 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 | | @tipo | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre ProductOrder. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | [ ] ### Processando de forma assíncrona {#tmf_prod_order-POST-ord-productOrder__example_ynv_vhx_fwb} Este exemplo mostra como usar o parâmetro de consulta mode 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", "recurringChargePeriod": "month", "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 aberta de pedido de produto - POST /sn_ind_tmt_orm/productorder {#ariaid-title10} Cria o pedido do cliente especificado e os itens de linha do pedido do cliente. Importante: A partir da versão Tokyo, este endpoint está obsoleto. A nova versão deste endpoint é [API aberta de pedido de produto - POST /sn_ind_tmt_orm/order/productOrder](https://servicenow-prod.fluidtopics.net/FRGX3jDFdlGt~NrxolgqRg#tmf_prod_order-POST-ord-productOrder "Cria o pedido do cliente especificado e os itens de linha do pedido do cliente."). Depois de processados, novos registros são criados nas seguintes tabelas: * Pedido do cliente \[sn_ind_tmt_orm_order\] * Característica do pedido \[sn_ind_tmt_orm_order_characteristic_value\] * Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\] * Contato do item de linha do pedido \[sn_ind_tmt_orm_order_line_item_contact\] {#tmf_prod_order-POST-productOrder__ul_hxq_vdb_hqb} ### Formato da URL URL padrão: /api/sn_ind_tmt_orm/productorder ### Parâmetros de solicitação compatíveis {#tmf_prod_order-POST-productOrder__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 49. Parâmetros de caminho] {#tmf_prod_order-POST-productOrder__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 50. Parâmetros de consulta] {#tmf_prod_order-POST-productOrder__id_vk2_p5n_t4b__entry__2}{#tmf_prod_order-POST-productOrder__due-date-entry}{#tmf_prod_order-POST-productOrder__productOrder-href-request}{#tmf_prod_order-POST-productOrder__productOrder-addReason-request}{#tmf_prod_order-POST-productOrder__due-date-item-entry}{#tmf_prod_order-POST-productOrder__externalProductInventory-GET-desc-request}{#tmf_prod_order-POST-productOrder__externalProductInventoryId-desc} | Nome | Descrição | |-|-| | canal | Matriz de objetos que descreve os canais a serem usados para vender os produtos. Tipo de dados: matriz "channel": [ { "id": "String", "name": "String" } ] Tabela/campo atualizado: sn_ind_tmt_orm_order | | canal.id | Obrigatório. Identificador exclusivo do canal a ser usado para vender os produtos associados. Os valores de ID de 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 Tabela/campo atualizado: sn_ind_tmt_orm_order/channel Padrão: cadeia de caracteres em branco | | canal.nome | 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 de Dicionário de Canal da tabela sn_ind_tmt_orm_order. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco | | committedDueDate | Data e hora em que a ação deve ser realizada no pedido. Este valor deve ser igual ou posterior aos valores committedDueDate de cada item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/committed_due_date | | externalId | Identificador exclusivo do pedido do cliente. Este valor é determinado por um sistema externo. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/external_id Padrão: cadeia de caracteres em branco | | href | Um link relativo para o registro do recurso. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco | | anotação | Matriz de objetos que contém anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz "note": [ { "text": "String" } ] Tabela/campo atualizado: sn_ind_tmt_orm_order | | anotação.texto | Obrigatório. Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/comments Padrão: cadeia de caracteres em branco | | orderCurrency | Obrigatório. Código da moeda para o pedido e itens de linha do pedido. A moeda deve ser a mesma para todos os elementos do pedido e itens de linha do pedido, caso contrário, será retornado um erro 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. Matriz de objetos que descreve itens associados ao pedido do produto e sua ação associada. Tipo de dados: matriz "productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ] Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.ação | Obrigatório. Ação a ser executada no produto. As ações possíveis são definidas na guia Lista de seleção na Entrada do Dicionário de Ação da tabela sn_ind_tmt_orm_order_line_item. Valores possíveis: * adicionar * mudança * excluir * sem mudança * resume * suspender {#tmf_prod_order-POST-productOrder__ul_qbd_dyp_ysb} Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action | | productOrderItem.actionReason | Opcional. Descrição do motivo do item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Data e hora em que a ação deve ser realizada no item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/committed_due_date | | productOrderItem.externalProductInventory | Matriz de objetos que contém IDs externas a serem mapeadas 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 de produtos. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/external_inventory_id e sn_prd_invt_product_inventory/sn_prd_invt_external_id | | productOrderItem.id | Obrigatório. Identificador exclusivo do item de linha. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/external_id Tamanho máximo: 40 Padrão: cadeia de caracteres em branco | | productOrderItem.itemPrice | Matriz de objetos que descreve o preço associado ao produto. Tipo de dados: matriz "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] Tabela atualizada: sn_ind_tmt_orm_order Padrão: cadeia de caracteres em branco | | productOrderItem.itemPrice.Price | Descrição do preço do produto associado. Tipo de dados: objeto "price": { "taxIncludedAmount": {Object} } Tabela atualizada: sn_ind_tmt_orm_order_line_item Padrão: cadeia de caracteres em branco | | produtoPedidoItem.itemPreço.preço.impostoValorincluído | Descrição do preço do produto associado, incluindo o imposto. Tipo de dados: objeto "taxIncludedAmount": { "unit": "String", "value": Number } Tabela atualizada: sn_ind_tmt_orm_order_line_item | | productOrderItem.itemPrice.Price.TaxIncludedAmount.unit | Código da moeda em que o preço é representado. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/mrc ou nrc | | productOrderItem.itemPrice.Price.TaxIncludedAmount.value | Preço do produto, incluindo impostos. Tipo de dados: número Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/mrc ou nrc | | productOrderItem.itemPrice.PriceType | Especifica se o preço do item é recorrente ou não recorrente. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice.recurringChargePeriod | Se o preço for recorrente, especifica o período recorrente, como month. Tipo de dados: cadeia de caracteres | | productOrderItem.product | Obrigatório se productOrderItem.action for 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" } Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.id | Obrigatório se productOrderItem.action for mudança ou exclusão. Identificador exclusivo do produto vendido. Localizado no campo sys_id ou sn_ind_tmt_orm_external_id da tabela Inventário de produtos \[sn_ind_tmt_orm_product_inventory\]. Tipo de dados: cadeia de caracteres Padrão: 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" } Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.place.id | Obrigatório. Sys_id do registro de local associado na tabela Local \[cmn_location\]. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/location | | productOrderItem.product.place.@type | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre Place. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto | Matriz de objetos que descreve as características do produto associado. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value | | productOrderItem.product.productCharacteristic.name | Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica \[sn_prd_pm_characteristic\]. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value/characteristics Padrão: cadeia de caracteres em branco | | productOrderItem.product.productCharacteristic.previousValue | A opção da característica anterior será válida se a atualização for para a ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro productOrderItem.action for diferente de add. Para obter informações adicionais sobre valores de opção de característica, consulte [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value Padrão: cadeia de caracteres em branco | | produtoPedidoItem.produto.característicadoproduto.valor | 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](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Padrão: cadeia de caracteres em branco | | productOrderItem.product.productSpecification | Obrigatório. Descrição da especificação do produto associada ao produto. Nota: As ordens de mudança (productOrderItem.action é `mudança`) são processadas de forma diferente com base no valor da propriedade do sistema sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder. O valor desta propriedade do sistema determina como o pedido será processado se o inventário do produto for de 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 referenciada. Isso permite que o pedido seja processado com sucesso. * Quando esta propriedade do sistema estiver definida como falsa, se o inventário do produto tiver uma versão diferente da indicada no pedido, o pedido falhará devido à incompatibilidade de versão. {#tmf_prod_order-POST-productOrder__ul_zbw_sdz_dbc} Tipo de dados: objeto "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.productSpecification.id | Obrigatório. Initial_version ou external_id da especificação do produto. O 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. Localizado na 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.version | External_version da especificação do produto. Localizado na tabela Especificação do produto \[sn_prd_pm_product_specification\]. Tipo de dados: cadeia de caracteres | | 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 | Matriz de objetos que descreve a função da parte vinculada a um OrderLineItemContact. Tipo de dados: matriz "relatedParty": [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact | | productOrderItem.product.relatedParty.email | Endereço de e-mail do contato. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/email Padrão: cadeia de caracteres em branco | | productOrderItem.product.relatedParty.firstName | Nome do contato. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/first_name Padrão: cadeia de caracteres em branco | | productOrderItem.product.relatedParty.lastName | Sobrenome do contato. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/lastName Padrão: cadeia de caracteres em branco | | productOrderItem.product.relatedParty.phone | Número de telefone comercial do contato. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item_contact/business_phone Padrão: 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 | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.product.@type | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre Product. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.productOferta | Obrigatório. Descrição da oferta de produto associada ao produto. Tipo de dados: objeto "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } Tabela atualizada: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOffering.id | Obrigatório. Initial_version ou external_id da oferta de produto. O 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 de produto. Localizado na 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.productOferta.versão | External_version da oferta de produto. Localizado na tabela Oferta de produto \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres | | productOrderItem.productOrderItem.quantity | Número de itens associados a serem solicitados. Tipo de dados: número Tabela/campo atualizado: sn_ind_tmt_orm_order/quantity Padrão: nulo | | productOrderItem.productOrderItemRelationship | Obrigatório. Matriz de objetos que descreve o relacionamento primário/secundário entre itens do pedido. Tipo de dados: matriz "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOrderItemRelationship.id | Obrigatório. Igual ao valor productOrderItem.id. Usado para relacionamento primário/secundário Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/parent_line_item Padrão: 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: * TemSecundário * Tem pai {#tmf_prod_order-POST-productOrder__ul_rmq_vrk_5rb} Tipo de dados: cadeia de caracteres | | productOrderItem.quantity | Número de itens solicitados. Tipo de dados: número Tabela/campo atualizado: sn_ind_tmt_orm_order/quantity Padrão: cadeia de caracteres em branco | | productOrderItem.@type | Parte do padrão TMF Open API. Anotação do 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 contenha informações da conta do cliente ou da conta do consumidor. Tipo de dados: matriz "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. 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.@referredType | Obrigatório. Tipo de cliente. Valores possíveis: * Consumidor * Cliente * CustomerContact {#tmf_prod_order-POST-productOrder__ul_smq_vrk_5rb} Tipo de dados: cadeia de caracteres | | relatedParty.@type | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | requestCompletionDate | Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/expected_end_date Padrão: cadeia de caracteres em branco | | requestStartDate | Data de início do pedido solicitada pelo cliente. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/expected_start_date Padrão: cadeia de caracteres em branco | | @tipo | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre ProductOrder. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | [Tabela 51. Parâmetros do corpo da solicitação (JSON)] {#tmf_prod_order-POST-productOrder__id_vk2_p5n_t4b} ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-POST-productOrder__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-POST-productOrder__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-POST-productOrder__content_type-JSON-only-entry-RESTAPI} | 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 52. Cabeçalhos da solicitação] {#tmf_prod_order-POST-productOrder__table_omb_dvk_5rb} {#tmf_prod_order-POST-productOrder__table_tzy_thy_ksb__entry__2} | Cabeçalho | Descrição | |-|-| | Tipo de conteúdo | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 53. Cabeçalhos de resposta] {#tmf_prod_order-POST-productOrder__table_tzy_thy_ksb} ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#tmf_prod_order-POST-productOrder__entry__152} | Código de status | Descrição | |-|-| | 201 | Bem-sucedido. Se houver problemas com as características ou informações de 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 do pedido do cliente associado: * As seguintes características do item do pedido não existem: revise a especificação \ 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: \ com valor de característica: \é inválido. Corrija os valores da característica antes de aprovar o pedido. {#tmf_prod_order-POST-productOrder__ul_xtx_xym_t4b} | | 400 | Solicitação Incorreta. Pode ser qualquer um dos seguintes motivos: * Cargainvá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 do pedido de produto ou JSON está ausente. * Carga inválida: id de productOrderItem está ausente - O parâmetro id está ausente no item de linha do pedido de produto da carga. * Carga inválida: a ação productOrderItem está ausente - O parâmetro action está ausente no item de linha do pedido de 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: id productOffering está ausente - O parâmetro id está ausente no item de linha do pedido de produto do objeto de oferta de produto na carga útil. * Carga inválida: a oferta de produto não existe - A oferta de produto no item de linha do pedido de produto não é válida. * Carga inválida: produto productOrderItem está ausente - O objeto do produto ou JSON no item de linha do pedido do produto está ausente na carga útil. * Carga inválida: produto productSpecification está ausente - O objeto de especificação do produto ou JSON no item de linha do pedido de produto está ausente na carga útil. * Carga inválida: id productSpecification está ausente - O parâmetro id no item de linha do pedido de produto do objeto de especificação do produto está ausente na carga útil. * 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 uma ordem de mudança (ação = mudança), a quantidade de um item é maior do que o que está no estoque. * Carga inválida: o ID de inventário do produto está ausente - Na ordem de mudança, o product.id está ausente na carga útil. * Carga inválida: o produto vendido está inativo - Em uma ordem de mudança, um produto especificado na carga está inativo. * Carga inválida: relatedParty está ausente - O objeto de parte relacionada está ausente na carga. * Carga inválida: a conta do cliente ou o consumidor está ausente - o cliente ou o objeto do consumidor da parte relacionada está ausente na carga útil. * Carga inválida: o consumidor não existe --- O consumidor de parte relacionada especificado não existe na instância ServiceNow. * Carga inválida: a conta do cliente não existe - O cliente da parte relacionada especificado não existe na instância ServiceNow. * Carga inválida: falha na criação do pedido - Não é possível criar o pedido solicitado. {#tmf_prod_order-POST-productOrder__ul_g2v_rzm_t4b} | [Tabela 54. Códigos de status] ### Parâmetros do corpo da resposta (JSON) {#tmf_prod_order-POST-productOrder__entry__158} | Nome | Descrição | |-|-| | canal | Matriz de objetos que descreve os canais a serem usados para vender os produtos. Tipo de dados: matriz "channel": [ { "id": "String", "name": "String" } ] | | canal.id | Identificador exclusivo do canal a ser usado para vender os produtos associados. Os valores de ID de 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 | | canal.nome | Nome do canal a ser usado para vender os produtos associados. Tipo de dados: cadeia de caracteres | | ID | Sys_id do pedido do cliente criado para esta solicitação. Tipo de dados: cadeia de caracteres | | externalId | Identificador externo do pedido do cliente, como um número de ordem de compra. Tipo de dados: cadeia de caracteres | | anotação | Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz "note": [ { "text": "String" } ] | | anotação.texto | Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres | | productOrderItem | Lista que descreve itens associados ao pedido de produto e sua ação associada. Tipo de dados: matriz "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 executada no produto. As ações possíveis são definidas na guia Lista de seleção na Entrada do Dicionário de Ação da tabela sn_ind_tmt_orm_order_line_item. Tipo de dados: cadeia de caracteres | | productOderItem.actionReason | O motivo para adicionar o item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.id | Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_order_line_item\]. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice | Matriz de objetos que descreve o preço associado ao produto. Tipo de dados: matriz "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 em que o preço é representado. Tipo de dados: cadeia de caracteres | | productOrderItem.itemPrice.Price.TaxIncludeAmount.value | Preço do produto, incluindo impostos. 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 month. 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_orm_external_id da tabela Inventário de produtos \[sn_ind_tmt_orm_product_inventory\]. Este parâmetro só será retornado se productOrderItem.action for mudança ou exclusão. Se sys_id e external_id estiverem presentes, o 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 | | produtoPedidoItem.produto.característicadoproduto | Matriz de objetos que descreve as características do produto associado. Tipo de dados: matriz "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Nome do registro de característica a ser associado ao produto. Localizado na tabela Característica \[sn_prd_pm_characteristic\]. Tipo de dados: cadeia de caracteres | | productOrderItem.product.productCharacteristic.previousValue | A opção de característica anterior será válida se a atualização for para uma ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro productOrderItem.action for diferente de add. Para obter informações adicionais sobre valores de opção de característica, consulte [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres | | produtoPedidoItem.produto.característicadoproduto.valor | 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](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). 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. O 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, o 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 "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 | Parte do padrão TMF Open API. Anotação para contato do item de linha do pedido. Este valor é sempre RelatedParty. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.product.@type | Parte do padrão TMF Open API. Anotação do produto. Este valor é sempre Product. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres | | productOrderItem.productOferta | 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. O 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, o 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 | Matriz de objetos que descreve os relacionamentos entre itens de linha do pedido. Tipo de dados: matriz "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido \[sn_ind_tmt_orm_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.estado | Estado atual do item do pedido de produto. Este valor é sempre novo. Tipo de dados: cadeia de caracteres | | productOrderItem.@type | Parte do padrão TMF Open API. Anotação do 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 contenha informações da conta do cliente ou da conta do consumidor. Tipo de dados: matriz "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: * Consumidor * Cliente * CustomerContact {#tmf_prod_order-POST-productOrder__ul_lcq_jwm_t4b} Tipo de dados: cadeia de caracteres | | requestCompletionDate | Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres | | requestStartDate | 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 | | @tipo | Parte do padrão TMF Open API. Anotação do 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 um pedido de 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", "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", "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", "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", "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" }