get_order_m
Summary
| API Name | get_order_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 54 |
Description
Retrieves non-subscription orders (NSOs) associated with a specified account. NSOs are one-time purchases of inventory items (physical or digital goods), as opposed to recurring subscription charges. Returns order details including order number, status, items ordered, quantities, amounts, fulfillment dates, and associated invoice information. Can be filtered by order number or date range. Use get_order_items_m to retrieve just the line items for a specific order.
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | No |
Client No |
||||||
| auth_key | string | 32 | No |
Auth Key |
||||||
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
||||||
| order_no | long | 22 | No |
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. Alternative field: client_order_id |
||||||
| client_order_id | string | 100 | No |
Client specified order ID. Alternative field: order_no |
||||||
| limit_records | long | No |
To be deprecated. Please use 'limit' field in tandem with 'offset' field instead. |
|||||||
| details_flag | long | 1 | No |
If 1, also returns the order line items Allowed values:
|
||||||
| master_plan_instance_no | long | 22 | No |
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. Alternative field: client_master_plan_instance_id |
||||||
| client_master_plan_instance_id | string | 100 | No |
Client specified master plan instance ID. Alternative field: master_plan_instance_no |
||||||
| order_status_filter | object | No |
Array of status filters to be used to define which order(s) to be returned. |
|||||||
| limit | long | 3 | No |
Limits the number of records returned in the orders array. Min of 1 and Max 999. If no value is specified all possible records will be returned. |
||||||
| offset | long | 10 | No |
The number of records to skip in the orders array. Min of 0 with no maximum value. If no value specified the default is 0. If an offset value greater than the total matching order count is passed, then no records will be returned in the response since that is an invalid offset. |
order_status_filter fields
| Name | Type | Length | Required | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| status_filter_cd | long | 22 | No |
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(es) will be retrieved. If null, then all orders for the given acct_no will be retrieved unless another filter is used. Allowed values:
|
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. |
|
| orders | object | No |
An array containing the order record |
|
| filtered_order_count | long | No |
Returns the total number of orders matching the given filters without considering the limit input. This parameter will return a count only if there is at least one matching order for the given input filters. If an offset value greater than the total matching order count is passed (which is an invalid offset value), then no orders will be returned in the response, and so, the filtered_order_count will be null in this case as well. |
orders.order_items.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. |
orders.order_items fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| line_no | long | No |
Line number of this particular row of the order |
|
| client_sku | string | 100 | No |
Client SKU of the NSO/Inventory item. |
| label | string | No |
Label or short description of this item |
|
| alt_label | string | No |
Alternate label to use during invoicing |
|
| long_desc | string | No |
Long description of this order item |
|
| units | double | No |
The number of units of this order item placed on this particular order |
|
| unit_amount | double | No |
The charge per unit |
|
| line_amount | double | No |
The total charge for this line |
|
| line_comments | string | No |
Any client-defined comments, from a CSR or automated system, for this particular line item |
|
| 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. |
orders.order_qualifiers fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| qualifier_name | string | No |
Returns the qualifier name associated with the order number. |
|
| qualifier_value | string | No |
Returns the qualifier value associated with the order number. |
orders fields
| Name | Type | Length | Required | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| order_no | long | 22 | No |
Unique order number for this order |
||||||||||||||||||
| amount | double | No |
Monetary amount for this order |
|||||||||||||||||||
| currency_cd | string | No |
The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
|||||||||||||||||||
| status_label | string | No |
Status label for this order Allowed values:
|
|||||||||||||||||||
| plan_instance_no | long | No |
Note: This field is deprecated. Aria no longer supports plan_instance_no. |
|||||||||||||||||||
| client_plan_instance_id | string | No |
Client plan instance id |
|||||||||||||||||||
| invoice_no | long | No |
The Aria-assigned unique identifier of a given invoice. |
|||||||||||||||||||
| create_date | string | No |
Date the order was created |
|||||||||||||||||||
| update_date | string | No |
Date the order was modified |
|||||||||||||||||||
| comments | string | No |
Comments for this order |
|||||||||||||||||||
| client_order_id | string | No |
Client assigned ID for this order |
|||||||||||||||||||
| transaction_id | long | No |
Note: This field is deprecated. Aria no longer supports transaction_id. |
|||||||||||||||||||
| order_create_client_receipt_id | string | No |
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 | No |
The API receipt ID associated with the most recent status change on the order |
|||||||||||||||||||
| statement_message | string | No |
Alternate contact details for orders. |
|||||||||||||||||||
| po_num | string | 100 | No |
Purchase order number assigned to the one-time order. |
||||||||||||||||||
| order_items | object | No | ||||||||||||||||||||
| plan_instance_no_2 | long | No |
plan instance no |
|||||||||||||||||||
| order_qualifiers | object | No |
Returns array of order qualifiers associated with the order number. |
|||||||||||||||||||
| fulfilled_date | string | No |
Date on which order is fulfilled. |
|||||||||||||||||||
| invoice_status_cd | long | No |
Invoice status code. |
|||||||||||||||||||
| invoice_status_text | string | No |
Invoice status description. |
|||||||||||||||||||
| master_plan_name | string | No |
Master plan name. |