---
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


---

# OrderGuide - com escopo

# OrderGuide - com escopo {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 min. de leitura

A API OrderGuide permite inicializar e exibir detalhes do guia de pedido.

Para usar esta classe em uma aplicação com escopo, use o identificador de namespace `sn_sc`. O plug-in API com escopo do Catálogo de serviços (com.glideapp.servicecatalog.scoped.api) habilitado por padrão é necessário para acessar a API OrderGuide.

## OrderGuide - OrderGuide(cadeia de caracteres sys_id) {#ariaid-title2}

Cria uma instância da classe OrderGuide com o sys_id especificado.
{#OG-OrderGuide_S__table_bbt_ccc_5bb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sys_id | Cadeia de caracteres | sys_id do OrderGuide. |
[Tabela 1. Parâmetros]

{#OG-OrderGuide_S__table_bbt_ccc_5bb}  
Exemplo:

    var cart=new sn_sc.OrderGuide("6690750f4f7b4200086eeed18110c761");

## OrderGuide -- getID() {#ariaid-title3}

Retorna o sys_id do guia de pedido.
{#OG-getID__table_o2r_tyz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 2. Parâmetros]

{#OG-getID__table_o2r_tyz_sbb} {#OG-getID__table_p2r_tyz_sbb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | sys_id do guia de pedido. |
[Tabela 3. Retorna]

{#OG-getID__table_p2r_tyz_sbb}  
Exemplo:

    var cart=new sn_sc.OrderGuide("6690750f4f7b4200086eeed18110c761");	
    	console.log(cart.getID());

Saída:

    6690750f4f7b4200086eeed18110c761

## OrderGuide - init(Mapear solicitação) {#ariaid-title4}

Inicializa o guia de pedido com os itens do catálogo especificados e as variáveis e retorna o guia de pedido.
{#OG-init_M__table_ym2_4zz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| solicitação | Mapa | Um objeto JSON com o item do catálogo e os detalhes da variável. |
[Tabela 4. Parâmetros]

{#OG-init_M__table_ym2_4zz_sbb} {#OG-init_M__table_zm2_4zz_sbb__entry__2}

| Tipo | Descrição |
|-|-|
| Mapa | Um objeto JSON com os detalhes do guia de pedido inicializado. |
[Tabela 5. Retorna]

{#OG-init_M__table_zm2_4zz_sbb}  
Exemplo:

    var guide = new sn_sc.OrderGuide('6690750f4f7b4200086eeed18110c761');
     
    var map = {};
    map.variables = {};
    //map.sysparm_id = '6690750f4f7b4200086eeed18110c761';
    map.variables['IOce433d0f4f7b4200086eeed18110c74d'] = '221f3db5c6112284009f4becd3039cc9'; //Here ce433d0f4f7b4200086eeed18110c74d is the sys_id of the variable and 221f3db5c6112284009f4becd3039cc9 is its value
    var includedItems = guide.init(map)

Saída:

    {
    "cascade_variable_map":{
    },
    "items":[
    {
    "order":"-1",
    "quantity":"1",
    "show_quantity":false,
    "sys_id":"a4022d7b87c20300e3010cf888cb0bb2"
    },
    {
    "order":"300",
    "quantity":"1",
    "show_quantity":false,
    "sys_id":"186d917a6fab7980575967ddbb3ee4f2"
    },
    {
    "order":"600",
    "quantity":"1",
    "show_quantity":false,
    "sys_id":"8b3ae7fedc1be1004ece5c08239e522b"
    }
    ],
    "variable_assignments":{
    }
    }

## OrderGuide - isIncludeItems() {#ariaid-title5}

Especifica se a caixa de seleção Mostrar alternância de inclusão (include_items) está marcada para o guia de pedido especificado.
Nota:  
O campo Mostrar Alternância de Inclusão não aparece no formulário Guia de pedido por padrão. {#OG-isIncludeItems__table_ewn_tsd_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 6. Parâmetros]

{#OG-isIncludeItems__table_ewn_tsd_sbb} {#OG-isIncludeItems__table_fwn_tsd_sbb__entry__2}

| Tipo | Descrição |
|-|-|
| Booliano | Retorna verdadeiro se a caixa de seleção Mostrar alternância de inclusão estiver marcada para o guia de pedido especificado. Else, retorna falso. |
[Tabela 7. Retorna]

{#OG-isIncludeItems__table_fwn_tsd_sbb}  

    var orderGuide=new sn_sc.OrderGuide("6690750f4f7b4200086eeed18110c761");	
    	console.log(orderGuide.isIncludeItems());

Saída:

    true

## OrderGuide - isTwoStep() {#ariaid-title6}

Especifica se a finalização de compra em duas etapas está habilitada.
{#OG-isTwoStep__table_zjf_3yz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 8. Parâmetros]

{#OG-isTwoStep__table_zjf_3yz_sbb} {#OG-isTwoStep__table_akf_3yz_sbb__entry__2}

| Tipo | Descrição |
|-|-|
| Booliano | Retorna verdadeiro se a finalização de compra em duas etapas estiver habilitada. Else retorna falso. |
[Tabela 9. Retorna]

{#OG-isTwoStep__table_akf_3yz_sbb}  
Exemplo:

    var orderGuide=new sn_sc.OrderGuide("6690750f4f7b4200086eeed18110c761");	
    	console.log(orderGuide.isTwoStep());

Saída:

    false

## OrderGuide - isUseCustomCart() {#ariaid-title7}

Especifica se o uso de um carrinho separado (diferente do para itens do catálogo) está habilitado para um guia de pedido de duas etapas.
{#OG-isUseCustomCart__table_xtd_vsd_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 10. Parâmetros]

{#OG-isUseCustomCart__table_xtd_vsd_sbb} {#OG-isUseCustomCart__table_ytd_vsd_sbb__entry__2}

| Tipo | Descrição |
|-|-|
| Booliano | Retorna verdadeiro se um uso de carrinho separado estiver habilitado para um guia de pedido de duas etapas. Else, retorna falso. |
[Tabela 11. Retorna]

{#OG-isUseCustomCart__table_ytd_vsd_sbb}  
Exemplo:

    var orderGuide=new sn_sc.OrderGuide("6690750f4f7b4200086eeed18110c761");	
    	console.log (orderGuide.isUseCustomCart());

Saída:

    false

## OrderGuide - navegarFromMap (mapear itemDetails) {#ariaid-title8}

Navega até os itens do catálogo de um guia de pedido.
{#OG-navigateFromMap_M__table_xtm_czz_sbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| itemDetails | Mapa | Um objeto JSON com detalhes de itens do catálogo no guia de pedido. |
[Tabela 12. Parâmetros]

{#OG-navigateFromMap_M__table_xtm_czz_sbb} {#OG-navigateFromMap_M__table_ytm_czz_sbb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 13. Retorna]

{#OG-navigateFromMap_M__table_ytm_czz_sbb}  
Exemplo:

    var orderGuide=new sn_sc.OrderGuide.navigateFromMap(itemdetails);