---
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 de pedido
# API de pedido {#ariaid-title1}
* Versão de lançamento: Xanadu
*
* Atualizado 1 de ago. de 2024
*
*  29 min. de leitura
A API Order fornece endpoints para recuperar e criar pedidos com itens de linha de pedido para a aplicação Customer Service Management.
Esta API requer a aplicação da loja Gestão de pedidos (app-csm-order-mgmt) e é fornecida no namespace `sn_csm_order_mgmt`. Para obter informações, consulte [Sales Customer Relationship Management](https://www.servicenow.com/docs/access?context=order-mgt-overview&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US).
Esta API requer sn_csm_om.order_integrator para acesso e um dos seguintes:
* sn_csm_om.consumer_agent -- Acesso de gravação à API restrito a pedidos B2C.
* sn_csm_om.customer_agent -- Acesso de gravação à API restrito a pedidos B2B.
* sn_csm_om.order_admin -- Acesso de gravação à API para pedidos B2B ou B2C.
{#order_csm-api__ul_gfd_tfn_ctb}
Para obter informações sobre pedidos B2B e B2C, consulte [Modelos de dados do cliente para B2B2C](https://www.servicenow.com/docs/access?context=customer-data-model-b2b2c&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US).
## API de pedido -- GET /sn_csm_order_mgmt/order/{id} {#ariaid-title2}
Recupera detalhes completos do pedido especificando o sys_id ou o número do pedido.
### Formato da URL
URL com controle de versão: /api/sn_csm_order_mgmt/{api_version}/order/{id}
URL padrão: /api/sn_csm_order_mgmt/order/{id}
### Parâmetros de solicitação compatíveis
{#order_csm-GET__entry__2}{#order_csm-GET__version-RESTAPI}
| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| ID | Sys_id ou número do pedido (order_id) do registro a ser recuperado localizado na tabela Pedidos \[sn_csm_om_order\]. Tipo de dados: cadeia de caracteres |
[Tabela 1. Parâmetros de caminho]
{#order_csm-GET__entry__8}
| Nome | Descrição |
|-|-|
| sysparm_display_value | Sinalizador que indica se o valor de exibição dos campos de referência deve ser mostrado. Valores válidos: * verdadeiro: mostra o valor de exibição dos campos de referência, campos de opção e campo de data na resposta. * falso: mostra o valor real dos campos de referência, campos de opção e campo de data na resposta. {#order_csm-GET__ul_hn1_jdp_1tb} Padrão: falso |
[Tabela 2. Parâmetros de consulta]
{#order_csm-GET__entry__12}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 3. Parâmetros do corpo da solicitação (XML ou 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.").
{#order_csm-GET__entry__16}{#order_csm-GET__accept-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
[Tabela 4. Cabeçalhos da solicitação]
{#order_csm-GET__entry__20}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 5. Cabeçalhos de resposta]
### 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.").
{#order_csm-GET__entry__24}{#order_csm-GET__entry-200-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 401 | O usuário não está autenticado. |
| 403 | O usuário não está autorizado. * O usuário não tem as funções necessárias para acessar a API. * O usuário não tem autorização para ler o pedido. {#order_csm-GET__ul_ktg_jfp_1tb} Esta API requer sn_csm_om.order_integrator para acesso e um dos seguintes: * sn_csm_om.consumer_agent -- Acesso de gravação à API restrito a pedidos B2C. * sn_csm_om.customer_agent -- Acesso de gravação à API restrito a pedidos B2B. * sn_csm_om.order_admin -- Acesso de gravação à API para pedidos B2B ou B2C. {#order_csm-GET__ul_gfd_tfn_ctb} |
[Tabela 6. Códigos de status]
### Parâmetros do corpo da resposta (JSON ou XML)
{#order_csm-GET__entry__32}{#order_csm-GET__ordr-ph-order_li}{#order_csm-GET__ordr-ph-order_li-account}{#order_csm-GET__ordr-ph-unit_of_meas}
| Nome | Descrição |
|-|-|
| conta | Sys_id de um registro localizado na tabela Contas \[customer_account\]. Identifica a conta para pedidos B2B. Tipo de dados: cadeia de caracteres |
| data_término_real | Data de término do pedido. Formato: formato UTC, aaaa-MM-dd HH:mm:ss Tipo de dados: cadeia de caracteres |
| data_início_real | Data de início do pedido. Formato: formato UTC, aaaa-MM-dd HH:mm:ss Tipo de dados: cadeia de caracteres |
| faturamento_cidade | Nome da cidade de faturamento. Tipo de dados: cadeia de caracteres |
| faturamento_país | Abreviação do país de faturamento. Tipo de dados: cadeia de caracteres |
| faturamento_estado | Abreviação do estado ou da província de faturamento. Tipo de dados: cadeia de caracteres |
| faturamento_rua | Endereço de faturamento. Tipo de dados: cadeia de caracteres |
| zip_faturamento | CEP ou código postal de faturamento. Tipo de dados: cadeia de caracteres |
| comentários | Informações adicionais do pedido. Tipo de dados: cadeia de caracteres |
| cliente | Sys_id de um registro localizado na tabela Consumidores \[csm_consumer\]. Identifica o consumidor para pedidos B2C. Tipo de dados: cadeia de caracteres |
| contato | Sys_id do contato do cliente relacionado à conta. Listado na tabela Contatos \[customer_contact\]. Tipo de dados: cadeia de caracteres |
| contrato | Sys_id do contrato Atendimento ao cliente listado na tabela Contratos \[ast_contract\]. Tipo de dados: cadeia de caracteres |
| erro | Detalhes que descrevem um erro encontrado durante o processo de solicitação. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Detalhes do erro encontrado durante o processo de solicitação. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem do erro encontrado durante o processo de solicitação. Cada mensagem de erro tem uma descrição correspondente na propriedade detail. Tipo de dados: cadeia de caracteres |
| data_término_prevista | Data de término esperada do pedido. Formato: formato UTC, aaaa-MM-dd HH:mm:ss Tipo de dados: cadeia de caracteres |
| data_início_prevista | Data de início esperada do pedido. Formato: formato UTC, aaaa-MM-dd HH:mm:ss Tipo de dados: cadeia de caracteres |
| external_id | ID externo que representa um registro relacionado no sistema de terceiros. Tipo de dados: cadeia de caracteres |
| sistema_externo | Nome do sistema do cliente. Tipo de dados: cadeia de caracteres |
| pedido_categoria | Tipo de pedido do cliente. Valores possíveis: * Produto * serviço {#order_csm-GET__d3782e287} Tipo de dados: cadeia de caracteres |
| pedido_moeda | Código da moeda que representa a moeda na qual o pedido foi comprado. Por exemplo, USD para dólares dos Estados Unidos. Esta moeda é usada para todos os campos de valor nas ordens de pedido e de linha. Os códigos de moeda são listados na tabela Moedas \[fx_currency\]. Nota: Esta propriedade pode não estar disponível em versões anteriores de Gestão de pedidos. Tipo de dados: cadeia de caracteres |
| data_pedido | Data e hora da criação do pedido. Formato: formato UTC, aaaa-MM-dd HH:mm:ss Tipo de dados: cadeia de caracteres |
| order_id | Número do pedido listado na tabela Pedidos \[sn_csm_om_order\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem | Obrigatório. Lista de objetos que definem cada item de linha do pedido no pedido. Localizado na tabela Itens de linha do pedido \[sn_csm_om_order_line_item\]. Tipo de dados: matriz Propriedades necessárias em cada objeto de item de linha do pedido: * account para pedidos B2B ou consumer para pedidos B2C.{#order_csm-GET__ordr-ph-order_li-acct-cons} * product_offering -- * quantity * unit_of_measurements * order_line_characteristics {#order_csm-GET__ordr-ul-order_li} "order_line_items": [ { "account": "String", "action": "String", "comments": "String", "consumer": "String", "contact": "String", "delivered_quantity": "String", "effective_date": "String", "expiration_date": "String", "external_id": "String", "external_system": "String", "list_price": "String", "location": "String", "order_line_characteristics": [Array], "order_line_id": "String", "order": "String", "parent_line_item": "String", "previous_product_model": "String", "price_list": "String", "product_offering": "String", "product_specification": "String", "product": "String", "quantity": "String", "shipping_city": "String", "shipping_country": "String", "shipping_state": "String", "shipping_street": "String", "shipping_zip": "String", "short_description": "String", "sku": "String", "sold_product": "String", "specification": "String", "state": "String", "status": "String", "sys_class_name": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "top_line_item": "String", "total_price": "String", "unit_of_measurement": "String", "unit_price": "String", "work_notes": "String" } ] {#order_csm-GET__ordr-code-order_li} |
| itens_de_linha_de_ordem | Lista de objetos que definem cada item de linha do pedido no pedido. Localizado na tabela Itens de linha do pedido \[sn_csm_om_order_line_item\]. Tipo de dados: matriz "order_line_items": [ { "account": "String", "action": "String", "comments": "String", "consumer": "String", "contact": "String", "delivered_quantity": "String", "effective_date": "String", "expiration_date": "String", "external_id": "String", "external_system": "String", "list_price": "String", "location": "String", "order_line_characteristics": [Array], "order_line_id": "String", "order": "String", "parent_line_item": "String", "previous_product_model": "String", "price_list": "String", "product_offering": "String", "product_specification": "String", "product": "String", "quantity": "String", "shipping_city": "String", "shipping_country": "String", "shipping_state": "String", "shipping_street": "String", "shipping_zip": "String", "short_description": "String", "sku": "String", "sold_product": "String", "specification": "String", "state": "String", "status": "String", "sys_class_name": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "top_line_item": "String", "total_price": "String", "unit_of_measurement": "String", "unit_price": "String", "work_notes": "String" } ] |
| itens_de_linha_de_ordem.conta | Necessário para pedidos B2B. Sys_id da conta corporativa atribuída a este item de linha do pedido. Localizado na tabela Contas \[customer_account\]. A propriedade do consumidor é necessária para pedidos B2C. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem.conta | Sys_id da conta corporativa atribuída a este item de linha do pedido. Localizado na tabela Contas \[customer_account\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.ação | Ação que determina como a linha do pedido é adicionada ao pedido. Valores possíveis: * adicionar * mudança {#order_csm-GET__ul_sqs_t5h_ctb} Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.comentários | Informações adicionais para o item de linha do pedido. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.consumidor | Sys_id do consumidor atribuído a este item de linha do pedido. Localizado na tabela Consumidores \[csm_consumer\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.contato | sys_id de contato relacionado à conta. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.quantidade_entregue | Número de itens no pedido entregue. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.data_efetiva | Data de efetivação da linha do pedido. Formato: aaaa-MM-dd HH:mm:ss no fuso horário UTC Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.data_de_expiração | Data de vencimento da linha do pedido. Formato: aaaa-MM-dd HH:mm:ss no fuso horário UTC Tipo de dados: cadeia de caracteres |
| order_line_items.external_id | ID externo do item de linha do pedido. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.sistema_externo | sys_id externo do item de linha do pedido. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.preço_de_lista | Preço de lista da oferta de produto por unidade. Nota: Esta propriedade pode não estar disponível em versões anteriores de Gestão de pedidos. Tipo de dados: cadeia de caracteres |
| itens_linha_pedido.local | Sys_id de um local de envio listado na tabela Locais \[cmn_location\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.ordem | O número do pedido deste item de linha conforme listado na tabela Pedidos \[sn_csm_om_order\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem. caracteres_de_linha_de_ordem | Lista de objetos que definem as características da linha de pedido associadas. As características da linha do pedido estão localizadas na tabela Características da linha do pedido \[sn_csm_om_order_characteristic_value\]. "order_line_characteristics": [ { "characteristic": "String", "characteristic_option": "String" } ] Tipo de dados: matriz |
| order_line_items.order_line_characteristics.characterstic_option | Opção exclusiva da característica do produto que aciona a regra de exclusão. Por exemplo, tamanho ou cor do produto. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem. order_line_characteristics. caracter_option_value | Valor de uma opção de característica. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem. order_line_characteristics. external_id | ID externo da característica da linha do pedido. Tipo de dados: objeto |
| itens_de_linha_de_ordem. order_line_characteristics. número | Número da característica da linha de pedido listado na tabela Características da linha de pedido \[sn_csm_om_order_characteristic_value\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem. order_line_characteristics. item_de_linha_de_ordem | Sys_id do item de linha de pedido desta característica na tabela Itens de linha do pedido \[sn_csm_om_order_line_item\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem. order_line_characteristics. valor_de_opção_característica_anterior | Nome da opção de característica anterior associada ao modelo de produto na linha do pedido. Tipo de dados: objeto |
| itens_de_linha_de_ordem. pedido_linha_características.especificação | Especificação de serviço associada à característica da ordem de serviço. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem. order_line_characteristics. sys_class_name | Nome do sistema da tabela na qual este registro de característica de linha de pedido está localizado. Tipo de dados: cadeia de caracteres |
| order_line_characteristics. sys_created_by | Nome do sistema do usuário que criou este registro. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem. order_line_characteristics. sys_created_on | Data e hora em que o registro foi criado originalmente. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem. order_line_characteristics. sys_domain | Escopo do domínio no qual o registro do pedido está acessível. Por exemplo, global. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem. order_line_characteristics. sys_domain_path | Caminho de domínio para o registro. Tipo de dados: cadeia de caracteres Padrão: / (global) |
| itens_de_linha_de_ordem. order_line_characteristics. sys_id | Sys_id do registro do pedido localizado na tabela Características da linha do pedido \[sn_csm_om_order_characteristic_value\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem. order_line_characteristics. sys_mod_count | Número de vezes que este registro foi modificado. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem. order_line_characteristics. sys_tags | Marcadores do sistema para o conteúdo. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem. order_line_characteristics. sys_updated_by | Nome do sistema do usuário que atualizou este registro mais recentemente. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem. order_line_characteristics. sys_updated_on | Data e hora em que o registro foi atualizado mais recentemente. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem. order_line_characteristics.type | Tipo de característica de linha de pedido. Valores possíveis: * Produto * serviço {#order_csm-GET__ul_j3l_4qg_ctb} Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem.id_de_linha_de_ordem | Número do pedido associado a este item de linha do pedido. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.item_de_linha_primário | Se aplicável, identifica um item de linha primário para este item de linha. Tipo de dados: cadeia de caracteres |
| order_line_items.previous_product_model | Identifica o modelo do produto listado antes deste item na linha do pedido. Sys_id do produto listado na tabela Modelos de produto \[cmdb_model\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.lista_de_preços | Sys_id de um registro de lista de preços na tabela Listas de preços \[sn_csm_pricing_price_list\]. Nota: Esta propriedade pode não estar disponível em versões anteriores de Gestão de pedidos. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.produto | Sys_id do produto listado na tabela Modelos de produto \[cmdb_model\]. Tipo de dados: cadeia de caracteres |
| order_line_items.product_offering | Sys_id do produto listado na tabela Ofertas de produtos \[sn_prd_pm_product_offering\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.produto | Sys_id do modelo de produto listado na tabela Modelos de produto \[cmdb_model\]. Deve ser fornecido com o item de linha do pedido correspondente Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.especificação_do_produto | Sys_id da especificação do produto associada ao item de linha do pedido. Listado na tabela Especificações do produto \[sn_prd_pm_product_specification\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.quantidade | Número de modelos de produto solicitados. Tipo de dados: cadeia de caracteres |
| order_line_items.shipping_city | Nome da cidade de destino. Tipo de dados: cadeia de caracteres |
| order_line_items.shipping_country | Abreviação do país de destino. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.estado_de_envio | Abreviatura do estado ou província de destino. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.rua_de_envio | Endereço de destino. Tipo de dados: cadeia de caracteres |
| order_line_items.shipping_zip | CEP ou código postal de destino. Tipo de dados: cadeia de caracteres |
| order_line_items.short_description | Descrição resumida do item de linha do pedido. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.sku | Número gerado por um fornecedor que identifica exclusivamente um produto vendido por esse fornecedor. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.produto_vendido | Sys_id de um produto vendido de base de instalação listado na tabela Produtos vendidos \[sn_install_base_sold_product\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.especificação | Especificação do item de linha do pedido. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem.estado | Estado da linha de pedido. Por exemplo, rascunho, novo, in_progress ou concluído. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.status | Status do item de linha do pedido. Valores possíveis: * êxito * falha {#order_csm-GET__ul_qkt_w2m_ctb} Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.sys_class_name | Nome do sistema da tabela na qual este registro de item de linha do pedido está localizado. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem.sys_created_by | Nome do sistema do usuário que criou este registro. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem.sys_created_on | Data e hora em que o registro foi criado originalmente. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.sys_domain | Escopo do domínio no qual o registro do pedido está acessível. Por exemplo, global. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem.sys_domain_path | Caminho de domínio para o registro. Tipo de dados: cadeia de caracteres Padrão: / (global) |
| itens_de_linha_de_ordem.sys_id | Sys_id do registro do item de linha localizado na tabela Itens de linha do pedido \[sn_csm_om_order_line_item\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.sys_mod_count | Número de vezes que este registro foi modificado. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem.sys_tags | Marcadores do sistema para o conteúdo. Tipo de dados: cadeia de caracteres |
| order_line_items.sys_updated_by | Nome do sistema do usuário que atualizou este registro mais recentemente. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem.sys_updated_on | Data e hora em que o registro foi atualizado mais recentemente. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem.item_de_linha_de_top | Preço total de todos os itens de linha do pedido acumulados neste pedido. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_pedido.preço_total | Preço total da linha de pedido. A API não calcula o total com base no preço líquido e na quantidade. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.unidade_de_medida | Sys_id da unidade de medida ordenada listada na tabela Unidade de medidas \[sn_prd_pm_uom\]. Nota: Esta propriedade pode não estar disponível em versões anteriores de Gestão de pedidos. Tipo de dados: cadeia de caracteres |
| order_line_items.unit_of_measurement | Obrigatório. Sys_id da unidade de medida ordenada listada na tabela Unidade de medidas \[sn_prd_pm_uom\]. Nota: Esta propriedade pode não estar disponível em versões anteriores de Gestão de pedidos. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.preço_de_unidade | Preço líquido da oferta de produto por unidade listada na tabela Instâncias de moeda \[fx_currency_instance\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.anotações_de_trabalho | Anotações de trabalho internas de forma livre para o item de linha do pedido. Tipo de dados: cadeia de caracteres |
| pedido_tipo | Ação de pedido que determina como o pedido é adicionado. Valores possíveis: * adicionar * mudança Tipo de dados: cadeia de caracteres |
| parceiro | Para pedidos B2B, sys_id do parceiro associado a uma conta listada na tabela Contas \[customer_account\]. Tipo de dados: cadeia de caracteres |
| parceiro_contato | Para pedidos B2B, sys_id do contato primário do parceiro para a conta do parceiro. Listado na tabela Contatos \[customer_contact\]. Tipo de dados: cadeia de caracteres |
| pagamento_ref_id | Identificador exclusivo do pagamento. Por exemplo, número de cheque. Tipo de dados: cadeia de caracteres |
| lista_de_preços | Sys_id da lista de preços associada listada na tabela Listas de preços \[sn_csm_pricing_Pricing_Pricing_list\]. O preço não é calculado com base no preço líquido e na quantidade por esta API. Nota: Esta propriedade pode não estar disponível em versões anteriores de Gestão de pedidos. Tipo de dados: cadeia de caracteres |
| quote_id | ID exclusivo da cotação de preço do pedido. Tipo de dados: cadeia de caracteres |
| same_as_shipping_address | Sinalizador que indica se o endereço do comprador é igual ao endereço de envio. Valores válidos: * verdadeiro: o endereço do comprador é o mesmo que o endereço de envio. * falso: o endereço do comprador é diferente do endereço de envio. {#order_csm-GET__ul_ygx_zsq_btb} Tipo de dados: booliano |
| cidade_envio | Nome da cidade de destino. Tipo de dados: cadeia de caracteres |
| país_envio | Abreviação do país de destino. Tipo de dados: cadeia de caracteres |
| envio_local | Sys_id de um local de envio listado na tabela Locais \[cmn_location\]. Tipo de dados: cadeia de caracteres |
| estado_envio | Abreviatura do estado ou província de destino. Tipo de dados: cadeia de caracteres |
| rua_envio | Endereço de destino. Tipo de dados: cadeia de caracteres |
| zip_envio | CEP ou código postal de destino. Tipo de dados: cadeia de caracteres |
| short_description | Descrição resumida do pedido. Tipo de dados: cadeia de caracteres |
| instruções_especiais | Instruções especiais para o pedido. Tipo de dados: cadeia de caracteres |
| estado | Estado do pedido. Por exemplo, novo, in_progress ou concluído. Tipo de dados: cadeia de caracteres |
| status | Status do pedido. Valores possíveis: * êxito * falha {#order_csm-GET__ul_vmw_prm_ctb} Tipo de dados: cadeia de caracteres |
| sys_class_name | Nome do sistema da tabela na qual este registro de pedido está localizado. Tipo de dados: cadeia de caracteres |
| sys_created_by | Nome do sistema do usuário que criou este registro. Tipo de dados: cadeia de caracteres |
| sys_created_on | Data e hora em que o registro foi criado originalmente. Tipo de dados: cadeia de caracteres |
| sys_domain | Escopo do domínio no qual o registro do pedido está acessível. Por exemplo, global. Tipo de dados: cadeia de caracteres |
| sys_domain_path | Caminho de domínio para o registro. Tipo de dados: cadeia de caracteres Padrão: / (global) |
| sys_id | Sys_id do pedido listado na tabela Pedidos \[sn_csm_om_order\]. Tipo de dados: cadeia de caracteres |
| sys_mod_count | Número de vezes que este registro foi modificado. Tipo de dados: cadeia de caracteres |
| sys_tags | Marcadores do sistema para o conteúdo. Tipo de dados: cadeia de caracteres |
| sys_updated_by | Nome do sistema do usuário que atualizou este registro mais recentemente. Tipo de dados: cadeia de caracteres |
| sys_updated_on | Data e hora em que o registro foi atualizado mais recentemente. Tipo de dados: cadeia de caracteres |
| total_valor | Custo total do pedido inteiro. Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
O exemplo a seguir mostra como obter um pedido pelo número do pedido.
curl "https://instance.service-now.com/api/sn_csm_order_mgmt/order/ORD0001034" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Resposta:
{
"result": {
"actual_start_date": "",
"payment_ref_id": null,
"shipping_city": null,
"channel": "api",
"expected_end_date": "",
"sys_updated_on": "2022-03-30 21:59:41",
"price_list": null,
"sys_updated_by": "username",
"sys_created_on": "2022-03-30 21:59:41",
"contact": "96d0461553ab70101aaeddeeff7b120b",
"sys_domain": "global",
"state": "draft",
"order_type": "add",
"sys_created_by": "eseruser",
"shipping_street": null,
"special_instructions": null,
"contract": null,
"quote_id": null,
"expected_start_date": "",
"sys_domain_path": "/",
"billing_street": null,
"billing_city": null,
"total_amount": "2000",
"order_id": "ORD0001034",
"shipping_country": "USA",
"status": "new",
"short_description": null,
"shipping_state": null,
"external_id": null,
"sys_class_name": "sn_csm_om_order",
"sys_id": "24fdf5bd75eec510f877f30c01a15aa0",
"shipping_zip": null,
"billing_state": null,
"billing_zip": null,
"same_as_shipping_address": "0",
"consumer": null,
"comments": "",
"order_currency": "USD",
"billing_country": "USA",
"sys_mod_count": "1",
"billing_location": null,
"shipping_location": null,
"sys_tags": "",
"order_date": "2022-03-30 21:59:41",
"order_category": "product",
"actual_end_date": "",
"partner": null,
"partner_contact": null,
"account": "c480021553ab70101aaeddeeff7b120f",
"external_system": null,
"order_line_items": [
{
"short_description": null,
"shipping_state": "CA",
"shipping_city": "Santa Clara",
"product_offering": "2d4376760f740110603bf634a7767e46",
"external_id": null,
"sys_updated_on": "2022-03-30 21:59:41",
"expiration_date": "",
"sys_class_name": "sn_csm_om_order_line_item",
"sold_product": null,
"sys_id": "ecfdf5bd75eec510f877f30c01a15aa3",
"unit_of_measurement": "cb2795d553020110286eddeeff7b12ff",
"price_list": null,
"sys_updated_by": "username",
"shipping_zip": "94560",
"sys_created_on": "2022-03-30 21:59:41",
"contact": "96d0461553ab70101aaeddeeff7b120b",
"sys_domain": "global",
"effective_date": "",
"action": "add",
"order_line_id": "ORDL0001060",
"state": "draft",
"sku": null,
"consumer": null,
"sys_created_by": "username",
"order": "24fdf5bd75eec510f877f30c01a15aa0",
"previous_product_model": null,
"shipping_street": "222 Star St",
"product": "561dba7e0f740110603bf634a7767ebe",
"quantity": "1",
"comments": "",
"total_price": "2000",
"parent_line_item": null,
"sys_mod_count": "1",
"specification": "104f66720f740110603bf634a7767e7d",
"list_price": "2000",
"unit_price": "2000",
"sys_domain_path": "/",
"sys_tags": "",
"delivered_quantity": null,
"top_line_item": null,
"product_specification": "104f66720f740110603bf634a7767e7d",
"location": null,
"work_notes": "",
"shipping_country": "USA",
"account": "c480021553ab70101aaeddeeff7b120f",
"external_system": null,
"status": "new",
"order_line_characteristics": [
{
"characteristic_option": "1c6ceabe0f340110603bf634a7767e97",
"sys_mod_count": "0",
"specification": "104f66720f740110603bf634a7767e7d",
"external_id": null,
"sys_updated_on": "2022-03-30 21:59:41",
"type": "1",
"sys_domain_path": "/",
"sys_tags": "",
"characteristic": "4e76f1b20fb00110603bf634a7767ee3",
"sys_class_name": "sn_csm_om_order_characteristic_value",
"previous_characteristic_option_value": null,
"number": "ORC000001041",
"sys_id": "acfd79bd75eec510f877f30c01a15a94",
"sys_updated_by": "username",
"sys_created_on": "2022-03-30 21:59:41",
"sys_domain": "global",
"characteristic_option_value": "1.2 cu",
"order_line_item": "ecfdf5bd75eec510f877f30c01a15aa3",
"sys_created_by": "user"
},
{
"characteristic_option": "2d0d66fe0f340110603bf634a7767ef6",
"sys_mod_count": "0",
"specification": "104f66720f740110603bf634a7767e7d",
"external_id": null,
"sys_updated_on": "2022-03-30 21:59:41",
"type": "1",
"sys_domain_path": "/",
"sys_tags": "",
"characteristic": "11e639b20fb00110603bf634a7767e17",
"sys_class_name": "sn_csm_om_order_characteristic_value",
"previous_characteristic_option_value": null,
"number": "ORC000001042",
"sys_id": "e0fd79bd75eec510f877f30c01a15a95",
"sys_updated_by": "username",
"sys_created_on": "2022-03-30 21:59:41",
"sys_domain": "global",
"characteristic_option_value": "Stainless steel",
"order_line_item": "ecfdf5bd75eec510f877f30c01a15aa3",
"sys_created_by": "user"
}
]
}
]
}
}
## API de pedido -- POST /sn_csm_order_mgmt/order {#ariaid-title3}
Cria um novo pedido com itens de linha e características.
Pedidos com itens de linha são definidos usando parâmetros do corpo da solicitação. As propriedades a seguir são necessárias na maioria das versões de Gestão de pedidos:
* account para pedidos B2B ou consumer para pedidos B2C.
* account -- Sys_id de um registro localizado na tabela Contas \[customer_account\].
* consumer -- Sys_id de um registro localizado na tabela Consumidores \[csm_consumer\].
{#order_csm-POST__ul_h5j_my1_dtb}
* order_currency -- Código da moeda que representa a moeda na qual o pedido foi comprado. Por exemplo, USD para dólares dos Estados Unidos. Esta moeda é usada para todos os campos de valor nas ordens de pedido e de linha. Os códigos de moeda são listados na tabela Moedas \[fx_currency\].
* order_line_items -- Lista de objetos que definem cada item de linha do pedido no pedido. Localizado na tabela Itens de linha do pedido \[sn_csm_om_order_line_item\]. Propriedades necessárias em cada objeto de item de linha do pedido:
* account para pedidos B2B ou consumer para pedidos B2C.
* account -- Sys_id da conta corporativa atribuída a este item de linha do pedido. Localizado na tabela Contas \[customer_account\].
* consumer -- Sys_id do consumidor atribuído a este item de linha do pedido. Localizado na tabela Consumidores \[csm_consumer\].
{#order_csm-POST__ul_dqm_qbb_dtb}
* order_line_characteristics -- Lista de objetos que definem as características da linha de pedido associadas. As características da linha do pedido estão localizadas na tabela Características da linha do pedido \[sn_csm_om_order_characteristic_value\].
* product_offering -- Sys_id do produto listado na tabela Ofertas de produtos \[sn_prd_pm_product_offering\].
* quantity -- Número de modelos de produto solicitados.
* unit_of_measurements -- Sys_id da unidade de medida ordenada listada na tabela Unidade de medidas \[sn_prd_pm_uom\].
A tabela Parâmetros do corpo da solicitação contém mais detalhes.
### Formato da URL
URL com controle de versão: /api/sn_csm_order_mgmt/{api_version}/order
URL padrão: /api/sn_csm_order_mgmt/order
### Parâmetros de solicitação compatíveis
{#order_csm-POST__entry__2}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 7. Parâmetros de caminho]
{#order_csm-POST__entry__6}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 8. Parâmetros de consulta]
{#order_csm-POST__entry__10}{#order_csm-POST__order_ph_account}{#order_csm-POST__order_ph_consumer}{#order_csm-POST__ordr-ph-order_currency}{#order_csm-POST__ordr-ph-order_li}{#order_csm-POST__ordr-ph-order_li-account}{#order_csm-POST__ordr-ph-order_li-consumer}{#order_csm-POST__ordr-ph-order_li-char}{#order_csm-POST__ordr-ph-order_li-product}{#order_csm-POST__ordr-ph-order_li-product_offering}{#order_csm-POST__ordr-row-order_li-product_spec}{#order_csm-POST__ordr-ph-order_li-quantity}{#order_csm-POST__ordr-ph-unit_of_meas}
| Nome | Descrição |
|-|-|
| conta | Necessário para pedidos B2B. Sys_id de um registro localizado na tabela Contas \[customer_account\]. A propriedade do consumidor é necessária para pedidos B2C. Tipo de dados: cadeia de caracteres |
| data_término_real | Data de término do pedido. Formato: formato UTC, aaaa-MM-dd HH:mm:ss Tipo de dados: cadeia de caracteres |
| data_início_real | Data de início do pedido. Formato: formato UTC, aaaa-MM-dd HH:mm:ss Tipo de dados: cadeia de caracteres |
| faturamento_cidade | Nome da cidade de faturamento. Tipo de dados: cadeia de caracteres |
| faturamento_país | Abreviação do país de faturamento. Tipo de dados: cadeia de caracteres |
| faturamento_estado | Abreviação do estado ou da província de faturamento. Tipo de dados: cadeia de caracteres |
| faturamento_rua | Endereço de faturamento. Tipo de dados: cadeia de caracteres |
| zip_faturamento | CEP ou código postal de faturamento. Tipo de dados: cadeia de caracteres |
| comentários | Informações adicionais do pedido. Tipo de dados: cadeia de caracteres |
| cliente | Necessário para pedidos B2C. Sys_id de um registro localizado na tabela Consumidores \[csm_consumer\]. A propriedade da conta é necessária para pedidos B2B. Tipo de dados: cadeia de caracteres |
| contato | Sys_id do contato do cliente relacionado à conta. Listado na tabela Contatos \[customer_contact\]. Tipo de dados: cadeia de caracteres |
| contrato | Sys_id do contrato Atendimento ao cliente listado na tabela Contratos \[ast_contract\]. Tipo de dados: cadeia de caracteres |
| data_término_prevista | Data de término esperada do pedido. Formato: formato UTC, aaaa-MM-dd HH:mm:ss Tipo de dados: cadeia de caracteres |
| data_início_prevista | Data de início esperada do pedido. Formato: formato UTC, aaaa-MM-dd HH:mm:ss Tipo de dados: cadeia de caracteres |
| external_id | ID externo que representa um registro relacionado no sistema de terceiros. Tipo de dados: cadeia de caracteres |
| sistema_externo | Nome do sistema do cliente. Tipo de dados: cadeia de caracteres |
| pedido_categoria | Tipo de pedido do cliente. Valores possíveis: * Produto * serviço {#order_csm-POST__ul_j3l_4qg_ctb} Tipo de dados: cadeia de caracteres |
| pedido_moeda | Obrigatório. Código da moeda que representa a moeda na qual o pedido foi comprado. Por exemplo, USD para dólares dos Estados Unidos. Esta moeda é usada para todos os campos de valor nas ordens de pedido e de linha. Os códigos de moeda são listados na tabela Moedas \[fx_currency\]. Nota: Esta propriedade pode não estar disponível em versões anteriores de Gestão de pedidos. Tipo de dados: cadeia de caracteres |
| data_pedido | Data e hora da criação do pedido. Formato: formato UTC, aaaa-MM-dd HH:mm:ss Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem | Obrigatório. Lista de objetos que definem cada item de linha do pedido no pedido. Localizado na tabela Itens de linha do pedido \[sn_csm_om_order_line_item\]. Tipo de dados: matriz Propriedades necessárias em cada objeto de item de linha do pedido: * account para pedidos B2B ou consumer para pedidos B2C.{#order_csm-POST__ordr-ph-order_li-acct-cons} * product_offering -- * quantity * unit_of_measurements * order_line_characteristics {#order_csm-POST__ordr-ul-order_li} "order_line_items": [ { "account": "String", "action": "String", "comments": "String", "consumer": "String", "contact": "String", "delivered_quantity": "String", "effective_date": "String", "expiration_date": "String", "external_id": "String", "external_system": "String", "list_price": "String", "location": "String", "order_line_characteristics": [Array], "order_line_id": "String", "order": "String", "parent_line_item": "String", "previous_product_model": "String", "price_list": "String", "product_offering": "String", "product_specification": "String", "product": "String", "quantity": "String", "shipping_city": "String", "shipping_country": "String", "shipping_state": "String", "shipping_street": "String", "shipping_zip": "String", "short_description": "String", "sku": "String", "sold_product": "String", "specification": "String", "state": "String", "status": "String", "sys_class_name": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "top_line_item": "String", "total_price": "String", "unit_of_measurement": "String", "unit_price": "String", "work_notes": "String" } ] {#order_csm-POST__ordr-code-order_li} |
| itens_de_linha_de_ordem.conta | Necessário para pedidos B2B. Sys_id da conta corporativa atribuída a este item de linha do pedido. Localizado na tabela Contas \[customer_account\]. A propriedade do consumidor é necessária para pedidos B2C. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.ação | Ação que determina como a linha do pedido é adicionada ao pedido. Valores possíveis: * adicionar * mudança {#order_csm-POST__ul_sqs_t5h_ctb} Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.comentários | Informações adicionais para o item de linha do pedido. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.consumidor | Necessário para pedidos B2C. Sys_id do consumidor atribuído a este item de linha do pedido. Localizado na tabela Consumidores \[csm_consumer\]. A propriedade da conta é necessária para pedidos B2B. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.contato | sys_id de contato relacionado à conta. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.quantidade_entregue | Número de itens no pedido entregue. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.data_efetiva | Data de efetivação da linha do pedido. Formato: aaaa-MM-dd HH:mm:ss no fuso horário UTC Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.data_de_expiração | Data de vencimento da linha do pedido. Formato: aaaa-MM-dd HH:mm:ss no fuso horário UTC Tipo de dados: cadeia de caracteres |
| order_line_items.external_id | ID externo do item de linha do pedido. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.sistema_externo | sys_id externo do item de linha do pedido. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.preço_de_lista | Preço de lista da oferta de produto por unidade. Nota: Esta propriedade pode não estar disponível em versões anteriores de Gestão de pedidos. Tipo de dados: cadeia de caracteres |
| order_line_items.order_line_characteristics | Obrigatório. Lista de objetos que definem as características da linha de pedido associadas. As características da linha do pedido estão localizadas na tabela Características da linha do pedido \[sn_csm_om_order_characteristic_value\]. Na versão mais recente, se a oferta estiver associada à especificação do produto, as características do pedido deverão ser incluídas para determinar o modelo do produto. Em versões anteriores, essa propriedade só era necessária para pedidos simples com o conjunto de propriedades order_line_items.product_specification. Tipo de dados: matriz "order_line_characteristics": [ { "characteristic": "String", "characteristic_option": "String" } ] {#order_csm-POST__ordr-code-order_li-char} |
| order_line_items.order_line_characteristics.característica | Nome da característica associada ao modelo do produto. Por exemplo, Tamanho da máquina de limpar. Tipo de dados: cadeia de caracteres |
| order_line_items.order_line_characteristics.characterstic_option | Opção exclusiva da característica do produto que aciona a regra de exclusão. Por exemplo, tamanho ou cor do produto. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.lista_de_preços | Sys_id de um registro de lista de preços na tabela Listas de preços \[sn_csm_pricing_price_list\]. Nota: Esta propriedade pode não estar disponível em versões anteriores de Gestão de pedidos. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.produto | Sys_id do modelo de produto listado na tabela Modelos de produto \[cmdb_model\]. Se incluído no corpo da solicitação, as características da linha do pedido associadas devem corresponder. Tipo de dados: cadeia de caracteres |
| order_line_items.product_offering | Obrigatório. Sys_id do produto listado na tabela Ofertas de produtos \[sn_prd_pm_product_offering\]. Se a oferta estiver associada ao modelo de produto, o modelo de produto será determinado pelo pedido. Se a oferta estiver associada à especificação do produto, as características do pedido deverão ser incluídas para determinar o modelo do produto. Tipo de dados: cadeia de caracteres |
| order_line_items.product_specification | Obrigatório. Sys_id da especificação do produto associada ao item de linha do pedido. Listado na tabela Especificações do produto \[sn_prd_pm_product_specification\]. Nota: Esta propriedade não era necessária em versões anteriores de Gestão de pedidos. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.quantidade | Obrigatório. Número de modelos de produto solicitados. Nota: Esta propriedade era necessária em versões anteriores do Gestão de pedidos. Tipo de dados: cadeia de caracteres |
| order_line_items.shipping_city | Nome da cidade de destino. Tipo de dados: cadeia de caracteres |
| order_line_items.shipping_country | Abreviação do país de destino. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.estado_de_envio | Abreviatura do estado ou província de destino. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.rua_de_envio | Endereço de destino. Tipo de dados: cadeia de caracteres |
| order_line_items.shipping_zip | CEP ou código postal de destino. Tipo de dados: cadeia de caracteres |
| order_line_items.short_description | Descrição resumida do item de linha do pedido. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.sku | Número gerado por um fornecedor que identifica exclusivamente um produto vendido por esse fornecedor. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.produto_vendido | Sys_id de um produto vendido de base de instalação listado na tabela Produtos vendidos \[sn_install_base_sold_product\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.especificação | Especificação do item de linha do pedido. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_ordem.estado | Estado da linha de pedido. Por exemplo, rascunho, novo, in_progress ou concluído. Tipo de dados: cadeia de caracteres |
| itens_de_linha_de_pedido.preço_total | Preço total da linha de pedido. O preço total não é calculado com base no preço líquido e na quantidade por esta API. Tipo de dados: cadeia de caracteres |
| order_line_items.unit_of_measurement | Obrigatório. Sys_id da unidade de medida ordenada listada na tabela Unidade de medidas \[sn_prd_pm_uom\]. Nota: Esta propriedade pode não estar disponível em versões anteriores de Gestão de pedidos. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.preço_de_unidade | Preço líquido da oferta de produto por unidade listada na tabela Instâncias de moeda \[fx_currency_instance\]. Tipo de dados: cadeia de caracteres |
| itens_de_linha_ordem.anotações_de_trabalho | Anotações de trabalho internas de forma livre para o item de linha do pedido. Tipo de dados: cadeia de caracteres |
| pedido_tipo | Ação de pedido que determina como o pedido é adicionado. Valores possíveis: * adicionar * mudança Tipo de dados: cadeia de caracteres |
| parceiro | Para pedidos B2B, sys_id do parceiro associado a uma conta listada na tabela Contas \[customer_account\]. Tipo de dados: cadeia de caracteres |
| parceiro_contato | Para pedidos B2B, sys_id do contato primário do parceiro para a conta do parceiro. Listado na tabela Contatos \[customer_contact\]. Tipo de dados: cadeia de caracteres |
| lista_de_preços | Sys_id da lista de preços associada listada na tabela Listas de preços \[sn_csm_pricing_Pricing_Pricing_list\]. O preço não é calculado com base no preço líquido e na quantidade por esta API. Nota: Esta propriedade pode não estar disponível em versões anteriores de Gestão de pedidos. Tipo de dados: cadeia de caracteres |
| quote_id | ID exclusivo da cotação de preço do pedido. Tipo de dados: cadeia de caracteres |
| cidade_envio | Nome da cidade de destino. Tipo de dados: cadeia de caracteres |
| país_envio | Abreviação do país de destino. Tipo de dados: cadeia de caracteres |
| estado_envio | Abreviatura do estado ou província de destino. Tipo de dados: cadeia de caracteres |
| rua_envio | Endereço de destino. Tipo de dados: cadeia de caracteres |
| zip_envio | CEP ou código postal de destino. Tipo de dados: cadeia de caracteres |
| short_description | Descrição resumida do pedido. Tipo de dados: cadeia de caracteres |
| instruções_especiais | Instruções especiais para o pedido. Tipo de dados: cadeia de caracteres |
| estado | Estado do pedido. Por exemplo, novo, in_progress ou concluído. Tipo de dados: cadeia de caracteres |
| total_valor | Custo total do pedido inteiro. Tipo de dados: cadeia de caracteres |
[Tabela 9. Parâmetros do corpo da solicitação (XML ou 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.").
{#order_csm-POST__entry__146}{#order_csm-POST__accept-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
[Tabela 10. Cabeçalhos da solicitação]
{#order_csm-POST__entry__150}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 11. Cabeçalhos de resposta]
### 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.").
{#order_csm-POST__entry__154}{#order_csm-POST__entry-200-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação incorreta. A carga não está no formato esperado. |
| 401 | O usuário não está autenticado. |
| 403 | O usuário não está autorizado. * O usuário não tem as funções necessárias para acessar a API. * O usuário não tem autorização para ler o pedido. {#order_csm-POST__ul_ktg_jfp_1tb} Esta API requer sn_csm_om.order_integrator para acesso e um dos seguintes: * sn_csm_om.consumer_agent -- Acesso de gravação à API restrito a pedidos B2C. * sn_csm_om.customer_agent -- Acesso de gravação à API restrito a pedidos B2B. * sn_csm_om.order_admin -- Acesso de gravação à API para pedidos B2B ou B2C. {#order_csm-POST__ul_gfd_tfn_ctb} |
| 500 | Erro interno do servidor. Uma ou mais validações falharam. Possíveis problemas: * O parâmetroAccount ou consumer está ausente. Esses campos são obrigatórios no cabeçalho e no item. * Os parâmetrosAccount/contact e consumer foram passados. Esses parâmetros não podem ser passados juntos. * Parâmetros de opção: valores de opção inválidos passados. * Parâmetro de quantidade: valor inválido. * Campo de referência inválido. * Campos obrigatórios ausentes. * Formato de data e hora inválido. * A data de início é posterior à data de término. * Característica inválida. * Opção de característica inválida. * Mais de um modelo de produto foi encontrado para as características fornecidas. * Modelo de produto não encontrado para as características fornecidas. * O usuário não tem acesso para criar um pedido. * O pedido B2B contém linhas de pedido do consumidor. * O pedido B2C contém parâmetros de conta, contato, parceiro ou contato de parceiro. * A moeda dos campos de valor não corresponde à moeda do pedido. * Order_line_characteristics foram passados para uma linha de pedido com product_offering associado ao modelo de produto. * A unidade de medida especificada para um tipo de oferta=configuration não pertence às unidades de medida permitidas definidas na oferta de produto. * Nenhuma característica foi passada para um tipo de oferta de configuração quando a oferta de produto esperava configuração. * Não é possível criar pedidos que tenham um item de pacote mais configurações simples na linha do pedido. * Os parâmetros aprovados contêm características para uma oferta de pacote. * Não é possível criar a linha de pedido primária e/ou a linha de pedido secundária. Somente itens de pacote primário são válidos em chamadas de oferta de pacote. * O registro unit_of_measurement especificado para uma oferta de pacote contém um valor diferente de "EACH". |
[Tabela 12. Códigos de status]
### Parâmetros do corpo da resposta (JSON ou XML)
{#order_csm-POST__entry__166}
| Nome | Descrição |
|-|-|
| erro | Detalhes que descrevem um erro encontrado durante o processo de solicitação. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Detalhes do erro encontrado durante o processo de solicitação. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem do erro encontrado durante o processo de solicitação. Cada mensagem de erro tem uma descrição correspondente na propriedade detail. Tipo de dados: cadeia de caracteres |
| order_id | Número do pedido listado na tabela Pedidos \[sn_csm_om_order\]. Tipo de dados: cadeia de caracteres |
| status | Mensagem de falha incluída além do objeto de erro. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id do pedido listado na tabela Pedidos \[sn_csm_om_order\]. Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
O exemplo a seguir mostra como criar um pedido de item único para um micro-ondas de aço inox.
curl "https://instance.service-now.com/api/sn_csm_order_mgmt/order" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"account\": \"c480021553ab70101aaeddeeff7b120f\",
\"contact\":\"96d0461553ab70101aaeddeeff7b120b\",
\"order_currency\": \"USD\",
\"order_line_items\": [
{
\"account\": \"c480021553ab70101aaeddeeff7b120f\",
\"action\": \"add\",
\"contact\": \"96d0461553ab70101aaeddeeff7b120b\",
\"list_price\": \"2000\",
\"order_line_characteristics\": [
{
\"characteristic\" : \"Solana color\",
\"characteristic_option\" : \"Stainless steel\"
},
{
\"characteristic\" :\"Microvawe Capacity\",
\"characteristic_option\" : \"1.2 cu\"
}
],
\"product_offering\": \"2d4376760f740110603bf634a7767e46\",
\"quantity\": \"1\",
\"shipping_city\": \"Santa Clara\",
\"shipping_country\": \"USA\",
\"shipping_state\": \"CA\",
\"shipping_street\": \"222 Star St\",
\"shipping_zip\": \"94560\",
\"state\": \"draft\",
\"status\": \"new\",
\"total_price\": \"2000\",
\"unit_of_measurement\": \"cb2795d553020110286eddeeff7b12ff\",
\"unit_price\": \"2000\"
}
]
}" \
--user 'user':'password'
Resposta:
{
"result": {
"sys_id": "24fdf5bd75eec510f877f30c01a15aa0",
"order_id": "ORD0001034"
}
}