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



 

Home > Aria Crescendo Documentation > Aria Crescendo core api > get_order_items_m

get_order_items_m

Returns information about the items in a particular order associated with a specified account.

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 order_no long 22 The unique identifier for an order in the context of an client_no and account_no.
  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.
  nso_rate_schedule Array   This array contains the rate schedule information.
  brd_arrow.gif rate_schedule_name String   Name for the rate schedule. 
  brd_arrow.gif client_rate_schedule_id String   Client-defined unique identifier.
  brd_arrow.gif currency_cd String   Currency for the schedule. 
  brd_arrow.gif is_default Boolean   This flag denotes if this rate schedule is the default one for this plan. One and only one rate schedule can be marked as default. The value of 1 is defaulted for the first rate schedule for a given currency denoting it is the default. For subsequent rate schedules, the default is set to 0.
  tier Array   This array contains tiered pricing information for the given rate schedule.
  brd_arrow.gif rate_schedule_name String   Name of rate schedule this tier belongs to.
  brd_arrow.gif amount Float   Tiered pricing rule that specifies rate per unit.
  brd_arrow.gif from Int   Tiered pricing rule that specifies “from” units.
  brd_arrow.gif to Int   Tiered pricing rule that specifies “to” units.
  brd_arrow.gif description String   This field is used to display custom rate tier description. This will override the rate tier's description at service level. 

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.
order_items_list 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 schedule_no long The ID of this rate schedule (DEPRECATED)
brd_arrow.gif tier_no long Tier number of this rate schedule (DEPRECATED)
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.
nso_rate_schedule_no long Aria-assigned unique identifier for the rate schedule used for pricing this NSO.
client_nso_rate_schedule_id string Client-defined unique identifier for the rate schedule used for pricing this NSO.
rate_seq_no long Tier number of this rate schedule.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.