get_order_m Sample Call and Response
This example retrieves the order-level records for non-subscription orders (NSOs) on an account, filtered to a particular order status, rather than the line items within any single order. It is based on the get_order_m method as defined in plsql_m_r73.yml. Use get_order_items_m instead when you need only the line items for one specific order.
This example covers a multi-order lookup filtered by account and order status, with pagination. It does not cover looking up a single order by order_no or client_order_id, filtering by master plan instance, or including embedded line items.
Sample call
{
"rest_call": "get_order_m",
"output_format": "json",
"client_no": 100234,
"auth_key": "8f3d2a19c6b74e0a9d1f5c6e7a8b9c0d",
"acct_no": 5567890,
"order_status_filter": [
{
"status_filter_cd": 4
}
],
"details_flag": 0,
"limit": 10,
"offset": 0
}
The acct_no field is one of a pair of alternatives with client_acct_id; this example uses the Aria-assigned identifier. Rather than looking up a single order by order_no or client_order_id (also an alternative pair, both left out of this example), this call retrieves every order on the account that matches the order_status_filter array, here restricted to status code four, "Order Billed." The details_flag field is set to zero, its default, so this example does not return each order's embedded line items; set it to one, or call get_order_items_m separately, to retrieve those. The limit and offset fields request the first ten matching orders. The rest_call and output_format fields are added by the REST layer and are not part of the method's own argument list.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"orders": [
{
"order_no": 7788001,
"amount": 164.97,
"currency_cd": "usd",
"status_label": "Order Billed",
"client_plan_instance_id": null,
"invoice_no": 8823410,
"create_date": "2026-01-10",
"update_date": "2026-01-15",
"comments": "Customer requested black finish.",
"client_order_id": "ACME-ORD-7788001",
"order_create_client_receipt_id": "RCPT-ORD-001",
"order_status_client_receipt_id": "RCPT-ORD-001-BILL",
"statement_message": null,
"po_num": null,
"plan_instance_no_2": null,
"fulfilled_date": "2026-01-13",
"invoice_status_cd": 1,
"invoice_status_text": "Invoiced",
"master_plan_name": null
},
{
"order_no": 7788045,
"amount": 79.99,
"currency_cd": "usd",
"status_label": "Order Billed",
"client_plan_instance_id": "MPI-CLI-40021",
"invoice_no": 8845102,
"create_date": "2026-02-02",
"update_date": "2026-02-15",
"comments": null,
"client_order_id": "ACME-ORD-7788045",
"order_create_client_receipt_id": "RCPT-ORD-045",
"order_status_client_receipt_id": "RCPT-ORD-045-BILL",
"statement_message": null,
"po_num": "PO-559812",
"plan_instance_no_2": 400321,
"fulfilled_date": "2026-02-05",
"invoice_status_cd": 1,
"invoice_status_text": "Invoiced",
"master_plan_name": "Enterprise Gold"
}
],
"filtered_order_count": 2
}
An error_code of zero, paired with an error_msg of "OK", indicates the call succeeded. The orders array shown here contains two representative orders matching the "Order Billed" filter; an account with more billed orders could return additional entries up to the requested limit of ten, with filtered_order_count reporting the total number of matches regardless of the limit applied. The second order's plan_instance_no_2 and master_plan_name fields are populated because that order is tied to a master subscription plan instance, while the first order is a standalone NSO purchase with no such association. Because details_flag is zero, the order_items array is not included in either order in this response; the error_details field is also left out entirely because it is a nonpublic field not exposed to callers. The deprecated plan_instance_no field (deprecated as of version nineteen, superseded by plan_instance_no_2) and the deprecated transaction_id field (deprecated as of version fifty-three) are left out as well. This example also omits the order_qualifiers array, since no order qualifiers were defined for either order shown.