Skip to content

`CustomerPointTransactionList_Load_Query`#

Description#

This function allows you to load a list of point transactions for a specific customer.

Here are the descriptions for the two tables:

Column	Description
`dtstamp`	The timestamp indicating when the entry was recorded.
`user_id`	The identifier for the user associated with the entry.
`order_id`	The identifier for the order associated with the entry.
`cust_id`	The identifier for the customer associated with the entry.
`pending`	Indicates if the entry is pending or not.
`descrip`	Additional description or information related to the entry.
`points`	Points associated with the entry.
`user_name`	The name of the user associated with the entry.

Sort Columns#

Column	Description
`dtstamp`	The timestamp indicating when the entry was recorded.
`user_id`	The identifier for the user associated with the entry.
`order_id`	The identifier for the order associated with the entry.
`pending`	Indicates if the entry is pending or not.
`descrip`	Additional description or information related to the entry.
`points`	Points associated with the entry.

Request Body Parameters#

Parameter	Type	Description
`customer_id` `edit_customer` `customer_login`	Number String String	The customer id The customer login The customer login
`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

Response Parameters#

Parameter	Type	Description
`total_count`	Number	total_count is the total number of records that match your search criteria. Note: this is not always the total products returned. Based on the Count and Offset parameters passed, the number of records returned could be different than the total_count.
`start_offset`	Number	Number of the starting offset number of products to return. Used in conjunction with the Count parameter for paginating results of large datasets.
`id`	Number	The ID of the Point Transaction List
`user_id`	Number	The Id of the Admin user who added the transaction. 0 if not placed by an Admin user
`cust_id`	Number	The Id of the Customer for the transaction list
`order_id`	Number	The Order ID the transaction references. If no order, it is 0
`pending`	Boolean	If pending is 0, the points have been added. If it is 1, the points have yet to be added.
`descrip`	String	The description for the transaction list
`points`	Number	The amount of points for the transaction
`dtstamp`	Date Timestamp	The timestamp for when the transaction took place
`user_name`	String	The User name of the admin user if it was added by an Admin. If no admin, the string returns empty.

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "Module",
    "Module_Code": "points",
    "Module_Function": "CustomerPointTransactionList_Load_Query",
    "Customer_Login": "my_customer_login"
}

Example Response#

{
    "success": 1,
    "data": {
        "total_count": 3,
        "start_offset": 0,
        "data": [
            {
                "id": 48,
                "user_id": 1,
                "cust_id": 1,
                "order_id": 0,
                "pending": 0,
                "descrip": "Test 1",
                "points": 50,
                "dtstamp": 1567115210,
                "user_name": "some_admin_user"
            },
            {
                "id": 49,
                "user_id": 1,
                "cust_id": 1,
                "order_id": 0,
                "pending": 0,
                "descrip": "Test 2",
                "points": 190,
                "dtstamp": 1567115214,
                "user_name": "some_admin_user"
            },
            {
                "id": 50,
                "user_id": 0,
                "cust_id": 1,
                "order_id": 0,
                "pending": 0,
                "descrip": "Some Description for My Points",
                "points": 150,
                "dtstamp": 1567115304,
                "user_name": ""
            }
        ]
    }
}