OrderUtil - com escopo

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 1 min. de leitura
  • A inclusão de script OrderUtil permite exibir e recuperar detalhes do pedido.

    Para acessar os métodos nesta inclusão de script, use o identificador de namespace sn_ind_tmt_orm. O plug-in Gestão de pedidos (com.sn_ind_tmt_orm) é necessário para acessar a inclusão de script OrderUtil.

    OrderUtil - OrderUtil()

    Cria uma instância da classe OrderUtil.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como instanciar um objeto OrderUtil chamado myOrder.

    var myOrder = new sn_ind_tmt_orm.OrderUtil();

    OrderUtil – getStateFromOrder(cadeia de caracteres orderSysId)

    Obtém o estado de um pedido especificado.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    orderSysId Cadeia de caracteres O sys_id do pedido localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order].
    Tabela 3. Retornos
    Tipo Descrição
    Cadeia de caracteres Retorna o valor do estado do registro do pedido. Se houver um problema ao obter o registro do pedido ou não houver nenhum sys_id do pedido aprovado, o método retornará nulo.

    O exemplo a seguir mostra como obter o valor do estado de um pedido especificado.

    var orderId = "<order_sys_id>"; // order sys_id, with state draft
    var state = new sn_ind_tmt_orm.OrderUtil().getStateFromOrder(orderId);
    gs.info(state);

    Saída:

    draft

    OrderUtil – isOrderInDraftState(cadeia de caracteres orderSysId)

    Retorna se o estado de um pedido especificado estiver no estado de rascunho.

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    orderSysId Cadeia de caracteres O sys_id do pedido localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order].
    Tabela 5. Retornos
    Tipo Descrição
    Booliano Sinalizador que indica se o estado de um pedido especificado está no estado de rascunho.
    Valores válidos:
    • verdadeiro: o pedido especificado está no estado de rascunho.
    • falso: o pedido especificado não está no estado de rascunho, há um problema ao recuperar o registro do pedido ou nenhum sys_id foi aprovado.

    O exemplo a seguir mostra como determinar que um pedido especificado está no estado de rascunho.

    var orderId = "<order_sys_id>"; // order sys_id, with state draft
    var state = new sn_ind_tmt_orm.OrderUtil().isOrderInDraftState(orderId);
    gs.info(state);

    Saída:

    true