API do pedido

Versão de lançamento: Washingtondc

Atualizado 1 de fev. de 2024

29 min. de leitura

A API de pedido permite recuperar e criar pedidos com itens de linha de pedido para a aplicação Customer Service Management (CSM).

Esta API requer a aplicação da loja Gestão de pedidos for Customer Service Management (app-csm-order-mgmt) e é fornecida no namespace sn_csm_order_mgmt. Para obter informações, consulte Sales and Order Management.

Esta API requer sn_csm_om.order_integrator para acesso e um dos seguintes:

sn_csm_om.consumer_agent – acesso de gravação de API restrito a pedidos B2C.
sn_csm_om.customer_agent – acesso de gravação de API restrito a pedidos B2B.
sn_csm_om.order_admin – acesso de gravação de API para pedidos B2B ou B2C.

Para obter informações sobre pedidos B2B e B2C, consulte Modelos de dados do cliente para B2B2C.

API de pedido – GET /sn_csm_order_mgmt/order/{id}

Recupera os detalhes completos do pedido especificando o sys_id ou o número do pedido.

Formato de URL

URL com controle de versões: /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

Tabela 1. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, `v1` ou `v2`. Especifique este valor somente 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 Orders [sn_csm_om_order]. Tipo de dados: cadeia de caracteres

Tabela 2. Parâmetros de consulta
Nome	Descrição
sysparm_display_value	Sinalizador que indica se o valor de exibição dos campos de referência deve ser exibido. Valores válidos: verdadeiro: mostre o valor de exibição dos campos de referência, de escolha e de data na resposta. falso: mostre o valor real dos campos de referência, de opção e de data na resposta. Padrão: falso

Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
Nome	Descrição
Nenhum

Cabeçalhos

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

Tabela 4. Cabeçalhos da solicitação
Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json

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

Códigos de status

Os códigos de status a seguir 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 da REST API.

Tabela 6. Códigos de status
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. Esta API requer sn_csm_om.order_integrator para acesso e um dos seguintes: sn_csm_om.consumer_agent – acesso de gravação de API restrito a pedidos B2C. sn_csm_om.customer_agent – acesso de gravação de API restrito a pedidos B2B. sn_csm_om.order_admin – acesso de gravação de API para pedidos B2B ou B2C.

Parâmetros do corpo da resposta (JSON ou XML)


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
billing_country	Abreviação do país de faturamento. Tipo de dados: cadeia de caracteres
billing_state	Abreviação do estado ou província de faturamento. Tipo de dados: cadeia de caracteres
billing_street	Endereço de faturamento. Tipo de dados: cadeia de caracteres
billing_zip	CEP ou código postal de faturamento. Tipo de dados: cadeia de caracteres
comentários	Informações adicionais para o 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
erro.mensagem	Mensagem para o 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
external_system	Nome do sistema do cliente. Tipo de dados: cadeia de caracteres
order_category	Tipo de pedido do cliente. Valores possíveis: Produto serviço Tipo de dados: cadeia de caracteres
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]. 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_date	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_linha_pedido	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. product_offering – quantity unit_of_measurements order_line_characteristics "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_linha_pedido	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_linha_pedido.conta	Obrigatório para pedidos B2B. Sys_id da conta do negócio 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_linha_pedido.conta	Sys_id da conta do negócio atribuída a este item de linha do pedido. Localizado na tabela Contas [customer_account]. Tipo de dados: cadeia de caracteres
order_line_items.action	Ação que determina como a linha do pedido é adicionada ao pedido. Valores possíveis: adicionar mudança Tipo de dados: cadeia de caracteres
order_line_items.comentários	Informações adicionais para o item de linha do pedido. Tipo de dados: cadeia de caracteres
itens_linha_pedido.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
order_line_items.contato	sys_id de contato relacionado à conta. Tipo de dados: cadeia de caracteres
itens_linha_pedido.quantidade_entregue	Número de itens no pedido entregue. Tipo de dados: cadeia de caracteres
itens_linha_pedido.data_efetiva	Data de vigência da linha do pedido. Formato: aaaa-MM-dd HH:mm:ss no fuso horário UTC Tipo de dados: cadeia de caracteres
itens_linha_pedido.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
order_line_items.external_system	sys_id externo do item da linha do pedido. Tipo de dados: cadeia de caracteres
itens_da_linha_pedido.preço_da_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.location	Sys_id de um local de envio listado na tabela Locais [cmn_location]. Tipo de dados: cadeia de caracteres
order_line_items.order	O número do pedido deste item de linha conforme listado na tabela Pedidos [sn_csm_om_order]. Tipo de dados: cadeia de caracteres
order_line_items. order_line_characteristics	Lista de objetos que definem as características da linha de ordem associada. 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.characteristic_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
order_line_items. order_line_characteristics. valor_opção_característica	Valor de uma opção de característica. Tipo de dados: cadeia de caracteres
order_line_items. order_line_characteristics. external_id	ID externo da característica da linha do pedido. Tipo de dados: objeto
order_line_items. order_line_characteristics. número	Número da característica da linha do pedido listado na tabela Características da linha do pedido [sn_csm_om_order_characteristic_value]. Tipo de dados: cadeia de caracteres
order_line_items. order_line_characteristics. item_linha_pedido	Sys_id do item de linha do pedido desta característica na tabela Itens de linha do pedido [sn_csm_om_order_line_item]. Tipo de dados: cadeia de caracteres
order_line_items. order_line_characteristics. valor_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
order_line_items. order_line_characteristics.specification	Especificação de serviço associada à característica do pedido de serviço. Tipo de dados: cadeia de caracteres
order_line_items. 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
order_line_items. order_line_characteristics. sys_created_on	Data e hora em que o registro foi criado originalmente. Tipo de dados: cadeia de caracteres
order_line_items. order_line_characteristics. sys_domain	Escopo de domínio no qual o registro do pedido pode ser acessado. Por exemplo, global. Tipo de dados: cadeia de caracteres
order_line_items. order_line_characteristics. sys_domain_path	Caminho de domínio para o registro. Tipo de dados: cadeia de caracteres Padrão: / (global)
order_line_items. 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
order_line_items. order_line_characteristics. sys_mod_count	Número de vezes que este registro foi modificado. Tipo de dados: cadeia de caracteres
order_line_items. order_line_characteristics. sys_tags	Marcadores do sistema para o conteúdo. Tipo de dados: cadeia de caracteres
order_line_items. order_line_characteristics. sys_atualizado_por	Nome do sistema do usuário que atualizou este registro mais recentemente. Tipo de dados: cadeia de caracteres
order_line_items. order_line_characteristics. sys_updated_on	Data e hora em que o registro foi atualizado mais recentemente. Tipo de dados: cadeia de caracteres
order_line_items. order_line_characteristics.type	Tipo de característica da linha de ordem. Valores possíveis: Produto serviço Tipo de dados: cadeia de caracteres
order_line_items.order_line_id	Número do pedido associado a este item de linha do pedido. Tipo de dados: cadeia de caracteres
itens_de_linha_pedido.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_linha_pedido.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_linha_pedido.produto	Sys_id do produto listado na tabela Modelos de produto [cmdb_model]. Tipo de dados: cadeia de caracteres
itens_linha_pedido.oferta_produto	Sys_id do produto listado na tabela Ofertas de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
itens_linha_pedido.produto	Sys_id do modelo de produto listado na tabela Modelos de produto [cmdb_model]. Deve ser fornecido com item de linha do pedido correspondente Tipo de dados: cadeia de caracteres
itens_linha_pedido.especificação_do_produto	Sys_id da especificação do produto associada ao item da linha do pedido. Listado na tabela Especificações do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
itens_linha_pedido.quantidade	Número de modelos de produto solicitados. Tipo de dados: cadeia de caracteres
itens_linha_pedido.cidade_envio	Nome da cidade de destino. Tipo de dados: cadeia de caracteres
itens_linha_pedido.país_envio	Abreviatura do país de destino. Tipo de dados: cadeia de caracteres
itens_linha_pedido.estado_envio	Abreviação do estado ou província de destino. Tipo de dados: cadeia de caracteres
itens_linha_pedido.rua_de_envio	Endereço de destino. Tipo de dados: cadeia de caracteres
itens_linha_pedido.zip_envio	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
order_line_items.sku	Número gerado por um fornecedor que identifica exclusivamente um produto vendido por esse fornecedor. Tipo de dados: cadeia de caracteres
itens_linha_pedido.produto_vendido	Sys_id de um produto base de instalação vendido listado na tabela Produtos Vendidos [sn_install_base_sold_product]. Tipo de dados: cadeia de caracteres
order_line_items.specification	Especificação do item de linha do pedido. Tipo de dados: cadeia de caracteres
itens_linha_pedido.estado	Estado da linha de ordem. Por exemplo, rascunho, novo, in_progress ou concluído. Tipo de dados: cadeia de caracteres
itens_linha_pedido.status	Status do item de linha do pedido. Valores possíveis: êxito falha Tipo de dados: cadeia de caracteres
order_line_items.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
order_line_items.sys_created_by	Nome do sistema do usuário que criou este registro. Tipo de dados: cadeia de caracteres
order_line_items.sys_created_on	Data e hora em que o registro foi criado originalmente. Tipo de dados: cadeia de caracteres
order_line_items.sys_domain	Escopo de domínio no qual o registro do pedido pode ser acessado. Por exemplo, global. Tipo de dados: cadeia de caracteres
order_line_items.sys_domain_path	Caminho de domínio para o registro. Tipo de dados: cadeia de caracteres Padrão: / (global)
order_line_items.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_linha_pedido.sys_mod_count	Número de vezes que este registro foi modificado. Tipo de dados: cadeia de caracteres
itens_linha_pedido.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
order_line_items.sys_updated_on	Data e hora em que o registro foi atualizado mais recentemente. Tipo de dados: cadeia de caracteres
itens_de_linha_pedido.item_de_top_linha	Preço total de todos os itens de linha do pedido acumulados neste pedido. Tipo de dados: cadeia de caracteres
itens_linha_pedido.preço_total	Preço total da linha do pedido. A API não calcula o total com base no preço líquido e na quantidade. Tipo de dados: cadeia de caracteres
order_line_items.unit_of_measurement	Sys_id da unidade de medida solicitada listada na tabela Unidade de medida [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 solicitada listada na tabela Unidade de medida [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_linha_pedido.preço_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_linha_pedido.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
order_type	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, verifique o número. Tipo de dados: cadeia de caracteres
lista_preço	Sys_id da lista de preços associada listada na tabela Listas de preços [sn_csm_pricing_price_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
id_cotação	ID exclusivo da cotação de preço do pedido. Tipo de dados: cadeia de caracteres
mesmo_como_endereço_de_envio	Sinalizador que indica se o endereço do comprador é igual ao endereço de envio. Valores válidos: verdadeiro: o endereço do comprador é igual ao endereço de envio. falso: o endereço do comprador é diferente do endereço de envio. Tipo de dados: booliano
envio_city	Nome da cidade de destino. Tipo de dados: cadeia de caracteres
envio_país	Abreviatura 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
envio_estado	Abreviação do estado ou província de destino. Tipo de dados: cadeia de caracteres
envio_street	Endereço de destino. Tipo de dados: cadeia de caracteres
envio_zip	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
especiais_instruções	Instruções especiais para o pedido. Tipo de dados: cadeia de caracteres
state	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 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 de domínio no qual o registro do pedido pode ser acessado. 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_amount	Custo total de todo o pedido. 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

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_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 do negócio 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_line_characteristics – Lista de objetos que definem as características da linha de ordem associada. 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 produto [sn_prd_pm_product_offering].
- quantity – Número de modelos de produto solicitados.
- unit_of_measurements – Sys_id da unidade de medida solicitada listada na tabela Unidade de medida [sn_prd_pm_uom].

A tabela Parâmetros do corpo da solicitação contém mais detalhes.