Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria Crescendo core api > get_order_m

get_order_m

Returns information about the orders associated with a specified account.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
  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   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.
  OR      
  client_order_id string   Client specified order ID.
  limit_records long   Limits the number of records which are returned.
  details_flag long   If 1, also returns the 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.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  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
order_no long Unique order number for this order
amount double Monetary amount for this order
currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
status_label string Status label for this order
plan_instance_no string plan instance no
client_plan_instance_id string Client plan instance id
invoice_no long The unique identifier of a given invoice.
create_date string Date the order was created
update_date string Date the order was modified
comments string Comments for this order
client_order_id string Client assigned ID for this order
transaction_id long Unique transaction ID for this order.
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
order_status_client_receipt_id string The API receipt ID associated with the most recent status change on the order
statement_message string Alternate contact details for orders.
po_num string Purchase order number assigned to the one-time order.
order_items hash  
line_no long Line number of this particular row of the order
client_sku string Client-defined item identifier
label string Label or short description of this item
alt_label string Alternate label to use during invoicing
long_desc string Long description of this order item
units double The number of units of this order item placed on this particular order
unit_amount double The charge per unit
line_amount double The total charge for this line
line_comments string Any client-defined comments, from a CSR or automated system, for this particular line item
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.
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.
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.

You must to post a comment.
Last modified
10:42, 9 May 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.