AllOrderPaymentList_Load_Query
#
Description#
This function loads a list of payments records (transactions) for a store.
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"
}
}
],
"total_count": 1,
"start_offset": 0
}
}