OrderUtil- Scoped

The OrderUtil script include enables you to view and retrieve order details.

To access the methods in this script include, use the sn_ind_tmt_orm namespace identifier. The Order Management (com.sn_ind_tmt_orm) plugin is required to access the OrderUtil script include.

Parent Topic:Server API reference

OrderUtil - OrderUtil()

Creates an instance of the OrderUtil class.

Name Type Description None    

The following example shows how to instantiate an OrderUtil object called myOrder.

var myOrder = new sn_ind_tmt_orm.OrderUtil();

OrderUtil - getStateFromOrder(String orderSysId)

Gets the state of a specified order.

Name Type Description orderSysId String The sys_id of the order located in the Customer Order [sn_ind_tmt_orm_order] table. Type Description String Returns the state value from the order record. If there’s an issue with getting the order record or there’s no order sys_id passed, then the method returns null.

The following example shows how to get the state value of a specified order.

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

Output:

draft

OrderUtil - isOrderInDraftState(String orderSysId)

Returns whether the state of a specified order is in draft state.

Name Type Description orderSysId String The sys_id of the order located in the Customer Order [sn_ind_tmt_orm_order] table.

<table id=“table_tcg_csh_b2c” class=“returns”><thead><tr><th>

Type

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Boolean

</td><td>

Flag that indicates whether the state of a specified order is in draft state.Valid values:

• true: The specified order is in draft state.

• false: The specified order is either not in draft state, there’s an issue retrieving the order record, or no sys_id was passed.

</td></tr></tbody> </table>The following example shows how to determine a specified order is in draft state.

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

Output:

true