Home > Aria Crescendo Documentation > Aria Crescendo core api > get_order_m

get_order_m

Returns information about the orders associated with a specified account.

For information on error messages generated by this API, see get_order_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
  order_no long 22 This is the order number. If this value is not null, then information about this specific order number will be retrieved. If null, then all orders for the given acct_no will be retrieved unless another filter is used.
  OR      
  client_order_id string 100 Client specified order ID.
  master_plan_instance_no long 22 The master subscription plan instance number. If this value is not null, then information about all order numbers belonging to this MPI will be retrieved. If null, then all orders for the given acct_no will be retrieved unless another filter is used.
  OR      
  client_master_plan_instance_id string 100 Client specified master plan ID.
Start of order_status_filter array
  order_status_filter hash   Array of status filters to be used to define which orders to be returned.
  Field Name Field Type Max Length Description
  brd_arrow.gifstatus_filter_cd long 1 Filters order(s) to be returned based on selected input. If this value is not null, then information about all order numbers in this status (or statuses) will be retrieved. If null, then all orders for the given acct_no will be retrieved unless another filter is used. 

Allowable values for status_filter_cd:

Values Description
0 (null) (Default) Returns All Orders
1 Order Held
2 Order Placed
3 Order Filled
4 Order Billed
5 Order Cancelled
End of order_status_filter array
  limit_records long   Limits the number of records which are returned.
  details_flag long 1 If 1, also returns the order line items  

Allowable values for details_flag:

Values Description
0 Do not return order line items. (default)
1 Return order line items.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
 

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
orders hash An array containing the order record
brd_arrow.gif order_no long Unique order number for this order
brd_arrow.gif amount double Monetary amount for this order
brd_arrow.gif currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
brd_arrow.gif status_label string Status label for this order  

Allowable values for status_label:

Values Description
0 Order Entry in Progress
1 Order Entered
2 Order Placed
-1 Order Rejected
-2 Order Cancelled
3 Order Filled
4 Order Billed
5 Order Held
brd_arrow.gif plan_instance_no long Plan instance number. DEPRECATED
brd_arrow.gif plan_instance_no_2 long Plan instance number.
brd_arrow.gif client_plan_instance_id string Client plan instance id
brd_arrow.gif invoice_no long The Aria-assigned unique identifier of a given invoice.
brd_arrow.gif create_date string Date the order was created
brd_arrow.gif update_date string Date the order was modified
brd_arrow.gif comments string Comments for this order
brd_arrow.gif client_order_id string Client assigned ID for this order
brd_arrow.gif transaction_id long Unique transaction ID for this order.
brd_arrow.gif order_create_client_receipt_id string When calling create_order, it accepts a client receipt ID. If the order has such an ID, it is returned here
brd_arrow.gif order_status_client_receipt_id string The API receipt ID associated with the most recent status change on the order
brd_arrow.gif statement_message string Alternate contact details for orders.
brd_arrow.gif po_num string Purchase order number assigned to the one-time order.
Start of order_qualifiers array
brd_arrow.gif qualifier_name string Name of the field you want to associate with this API call.
brd_arrow.gif qualifier_value string Corresponding value of the field you want to associate with this API call.
End of order_qualifiers array
brd_arrow.gif order_items hash  
brd_arrow.gif line_no long Line number of this particular row of the order
brd_arrow.gif client_sku string Client SKU of the NSO/Inventory item.
brd_arrow.gif label string Label or short description of this item
brd_arrow.gif alt_label string Alternate label to use during invoicing
brd_arrow.gif long_desc string Long description of this order item
brd_arrow.gif units double The number of units of this order item placed on this particular order
brd_arrow.gif unit_amount double The charge per unit
brd_arrow.gif line_amount double The total charge for this line
brd_arrow.gif line_comments string Any client-defined comments, from a CSR or automated system, for this particular line item
brd_arrow.gif item_svc_location_no long The Aria-assigned unique identifier for the origin location for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
brd_arrow.gif client_item_svc_location_id string The client-defined unique identifier for the origin location for the service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
brd_arrow.gif item_dest_contact_no long The Aria-assigned unique identifier for the destination contact for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
brd_arrow.gif fulfilled_date string

Date on which the order is fulfilled.

This can be a past, present, or future date. 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®