Skip to content

`AllOrderPaymentList_Load_Query`#

Description#

This function loads a list of payments records (transactions) for a store.

Request Parameters#

Parameter	Type	Description
`count`	Number	Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return
`filter`	String	A string for filtering returned data
`offset`	Number	Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
`sort`	String	The order for sorting returned data

On Demand Columns#

Column	Description
`cust_login`	Customer login attached to the order.
`cust_pw_email`	Customer Password Reset Email Address.
`business_title`	Name of Business Account Associated with Account.
`payment_module`	Name of Payment Module Used for Payment.

Other Custom Filters#

Filter Name	Description
`Customer_ID`	Filter by customer identification number.
`BusinessAccount_ID`	Filter by business account identification number.

Column	Description
`id`	Unique identifier for the order.
`batch_id`	Identifier for the batch the order belongs to.
`status`	Current status of the order.
`pay_status`	Payment status associated with the order.
`orderdate`	Date when the order was placed.
`dt_instock`	Date when the item was stocked.
`ship_res`	Shipping destination residence flag.
`ship_fname`	First name of the recipient for shipping.
`ship_lname`	Last name of the recipient for shipping.
`ship_email`	Email address of the recipient for shipping.
`ship_comp`	Company name of the recipient for shipping.
`ship_phone`	Phone number of the recipient for shipping.
`ship_fax`	Fax number of the recipient for shipping.
`ship_addr1`	Address line 1 of the recipient for shipping.
`ship_addr2`	Address line 2 of the recipient for shipping.
`ship_city`	City of the shipping address.
`ship_state`	State of the shipping address.
`ship_zip`	ZIP code of the shipping address.
`ship_cntry`	Country of the shipping address.
`ship_data`	Additional data related to shipping.
`bill_fname`	First name of the billing recipient.
`bill_lname`	Last name of the billing recipient.
`bill_email`	Email address of the billing recipient.
`bill_comp`	Company name of the billing recipient.
`bill_phone`	Phone number of the billing recipient.
`bill_fax`	Fax number of the billing recipient.
`bill_addr1`	Address line 1 of the billing recipient.
`bill_addr2`	Address line 2 of the billing recipient.
`bill_city`	City of the billing address.
`bill_state`	State of the billing address.
`bill_cntry`	Country of the billing address.
`total`	Total amount of the order.
`total_ship`	Total shipping cost of the order.
`total_tax`	Total tax amount of the order.
`total_auth`	Total authorized payment amount.
`total_rfnd`	Total refund amount for the order.
`net_capt`	Net captured payment amount.
`pend_count`	Pending item count for the order.
`bord_count`	Backorder item count for the order.
`note_count`	Count of notes associated with the order.
`source`	Source of the order.
`source_id`	Identifier of the source of the order.
`pay_id`	Payment module identifier for the order.
`cust_login`	Customer login associated with the order.
`cust_pw_email`	Customer password reset email address.
`business_title`	Business account title associated with the order.
`type`	Payment transaction type.
`refnum`	Payment reference number.
`amount`	Payment transaction amount.
`available`	Available (remaining) payment amount.
`payment_dtstamp`	Timestamp of the payment transaction.
`expires`	Payment expiration timestamp.
`payment_ip`	IP address from which the payment was made.
`payment_module`	Name of the payment module used.
`payment_currency`	Currency used for the payment.
`payment_environ`	Payment processing environment.
`payment_level`	Payment processing level.
`payment_cardbrand`	Card brand used for the payment.

Supported Sort Columns#

One of these values would be passed in the sort request parameter to have the results sorted by that column. Value may be preceded by - for a descending sort.

Column	Description
`id`	Unique identifier for the order.
`batch_id`	Identifier for the batch the order belongs to.
`status`	Current status of the order.
`pay_status`	Payment status associated with the order.
`orderdate`	Date when the order was placed.
`dt_instock`	Date when the item was stocked.
`ship_res`	Shipping destination residence flag.
`ship_fname`	First name of the recipient for shipping.
`ship_lname`	Last name of the recipient for shipping.
`ship_email`	Email address of the recipient for shipping.
`ship_comp`	Company name of the recipient for shipping.
`ship_phone`	Phone number of the recipient for shipping.
`ship_fax`	Fax number of the recipient for shipping.
`ship_addr1`	Address line 1 of the recipient for shipping.
`ship_addr2`	Address line 2 of the recipient for shipping.
`ship_city`	City of the shipping address.
`ship_state`	State of the shipping address.
`ship_zip`	ZIP code of the shipping address.
`ship_cntry`	Country of the shipping address.
`bill_fname`	First name of the billing recipient.
`bill_lname`	Last name of the billing recipient.
`bill_email`	Email address of the billing recipient.
`bill_comp`	Company name of the billing recipient.
`bill_phone`	Phone number of the billing recipient.
`bill_fax`	Fax number of the billing recipient.
`bill_addr1`	Address line 1 of the billing recipient.
`bill_addr2`	Address line 2 of the billing recipient.
`bill_city`	City of the billing address.
`bill_state`	State of the billing address.
`bill_cntry`	Country of the billing address.
`total`	Total amount of the order.
`total_ship`	Total shipping cost of the order.
`total_tax`	Total tax amount of the order.
`total_auth`	Total authorized payment amount.
`total_rfnd`	Total refund amount for the order.
`net_capt`	Net captured payment amount.
`pend_count`	Pending item count for the order.
`bord_count`	Backorder item count for the order.
`note_count`	Count of notes associated with the order.
`source`	Source of the order.
`source_id`	Identifier of the source of the order.
`cust_login`	Customer login associated with the order.
`cust_pw_email`	Customer password reset email address.
`business_title`	Business account title associated with the order.
`ship_data`	Additional data related to shipping.
`type`	Payment transaction type.
`refnum`	Payment reference number.
`amount`	Payment transaction amount.
`available`	Available (remaining) payment amount.
`expires`	Payment expiration timestamp.
`payment_ip`	IP address from which the payment was made.
`payment_dtstamp`	Timestamp of the payment transaction.
`payment_module`	Name of the payment module used.
`payment_currency`	Currency used for the payment.
`payment_environ`	Payment processing environment.
`payment_level`	Payment processing level.
`payment_cardbrand`	Card brand used for the payment.

Response Parameters#

Parameter	Type	Description
`success`	Number	`1` indicating a successful request. `0` indicating an unsuccessful request.
`data`	Object	The response data of the function used.
`data.total_count`	Object	The total count included in the data object.
`data.start_offset`	Object	The starting number of the data returned.

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "AllOrderPaymentList_Load_Query",
    "Count": 0,
    "Offset": 0
}

Example Response#

{
    "success": 1,
    "data": {
        "data": [
            {
                "id": 1000,
                "pay_id": 118,
                "batch_id": 0,
                "status": 100,
                "pay_status": 0,
                "stk_status": 0,
                "dt_instock": 0,
                "orderdate": 1671043090,
                "cust_id": 2,
                "ship_res": false,
                "ship_fname": "WWE",
                "ship_lname": "Test",
                "ship_email": "noreply@coolcommerce.net",
                "ship_comp": "WWE Test Co",
                "ship_phone": "858-490-2571",
                "ship_fax": "",
                "ship_addr1": "490 Sussex Dr",
                "ship_addr2": "",
                "ship_city": "Ottawa",
                "ship_state": "ON",
                "ship_zip": "K1N 1G8",
                "ship_cntry": "CA",
                "bill_fname": "WWE",
                "bill_lname": "Test",
                "bill_email": "noreply@coolcommerce.net",
                "bill_comp": "Miva Inc",
                "bill_phone": "858-490-2571",
                "bill_fax": "",
                "bill_addr1": "5060 Shoreham Drive",
                "bill_addr2": "Suite 130",
                "bill_city": "San Diego",
                "bill_state": "CA",
                "bill_zip": "92121",
                "bill_cntry": "US",
                "ship_id": 0,
                "ship_data": "",
                "source": "user",
                "source_id": 1,
                "total": 50.00,
                "formatted_total": "$50.00",
                "total_ship": 0.00,
                "formatted_total_ship": "$0.00",
                "total_tax": 0.00,
                "formatted_total_tax": "$0.00",
                "total_auth": 50.00,
                "formatted_total_auth": "$50.00",
                "total_capt": 50.00,
                "formatted_total_capt": "$50.00",
                "total_rfnd": 0.00,
                "formatted_total_rfnd": "$0.00",
                "net_capt": 50.00,
                "formatted_net_capt": "$50.00",
                "pend_count": 0,
                "bord_count": 0,
                "note_count": 0,
                "dt_Updated": 1671660121,
                "orderpayment": {
                    "id": 1,
                    "order_id": 1000,
                    "type": 5,
                    "refnum": "1000",
                    "amount": 50.00,
                    "formatted_amount": "$50.00",
                    "available": 50.00,
                    "formatted_available": "$50.00",
                    "dtstamp": 1671660121,
                    "ip": "123.45.6.7",
                    "currency": "USD",
                    "environ": "live",
                    "level": "",
                    "cardbrand": "visa"
                }
            }
        ],
        "total_count": 1,
        "start_offset": 0
    }
}