get_order_items_m
Summary
| API Name | get_order_items_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 53 |
Description
Returns information about the items in a particular order associated with a specified account.
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
| order_no | long | 22 | Yes |
The unique identifier for an order in the context of an client_no and account_no. |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| order_items_list | object | No |
order_items_list.order_line_qualifier_list fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| qualifier_name | string | No |
Returns the qualifier name associated with the order line item. |
|
| qualifier_value | string | No |
Returns the qualifier value associated with the order line item. |
order_items_list.installment_term_summary fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_installment_term_id | string | No |
Specifies client installment term id |
|
| installment_term_name | string | No |
Specifies installment term name |
|
| installment_description | string | No |
Installment term description |
|
| aligned_installment | string | No |
Aligned installment schedule with existing master plan instance. If aligned, installment amount will be charged along with master plan instance anniversary invoice/statement. Allowable values are - Yes (Y) - Aligned with existing master plan instance OR No (N) - Its own installment schedule and due dates. |
|
| term_type | string | No |
M (Months), W (Weeks), D (Days). If Null, will be treated as Months |
|
| term_length | long | No |
Installment term length. For example if interval type is M (Monthly), if users enter 36, then installment period is 36 months. |
|
| installment_term_interval | long | No |
Installment interval, works jointly with terms type. For example - 2 on interval and months in terms type mean installment is due every 2 months. If defined, must be less than terms length. |
|
| days_to_start | long | No |
Applicable only when aligned_installment is No (N) - Its own installment schedule and due dates. Determines how many days after a purchase or subscription date that the first installment will start. For example: if 5 is passed, then 5 days after a purchase date 1st installment will start. If 0 is passed, then 1st installment will start on purchase date. |
order_items_list fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| line_no | long | No | ||
| client_sku | string | No | ||
| label | string | No | ||
| alt_label | string | No | ||
| long_desc | string | No | ||
| units | double | No | ||
| unit_amount | double | No | ||
| line_amount | double | No | ||
| line_comments | string | No |
Any client-defined comments, from a CSR or automated system, for this particular line item |
|
| schedule_no | long | No |
Note: This field is deprecated. Aria no longer supports schedule_no. |
|
| tier_no | long | No |
Note: This field is deprecated. Aria no longer supports tier_no. |
|
| item_svc_location_no | long | 22 | No |
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 | 100 | No |
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 | 22 | No |
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 | No |
Aria-assigned unique identifier for the rate schedule used for pricing this NSO. |
|
| client_nso_rate_schedule_id | string | No |
Client-defined unique identifier for the rate schedule used for pricing this NSO. |
|
| rate_seq_no | long | No |
Tier number of this rate schedule. |
|
| custom_rate_ind | long | No |
Identifies whether this is a custom rate. A value of 1 indicates that it is a custom rate (i.e., the item unit price is overridden at the time of order creation). A value of 0 indicates that it is a standard rate. |
|
| client_order_line_id | string | No |
Client-defined unique identifier for order line item. |
|
| order_line_qualifier_list | object | No |
Returns array of order line qualifiers associated with the order line item. |
|
| item_svc_location_name | string | No |
The origin location name for the specified service associated with the plan. |
|
| nso_rate_schedule_name | string | No |
The rate schedule name used for pricing this NSO. |
|
| installment_term_summary | object | No |
Summary of installment terms associated with items in an order |