Skip to content

SubscriptionList_Load_Query#


Description#

This function loads a list of subscriptions for a store.

Example Request#

{
    "Store_code": "beta",
    "Function": "SubscriptionList_Load_Query",
    "Count": 0,
    "Offset": 0,
    "Filter": [
        {
            "name": "search",
            "value": [
                {
                    "field": "status",
                    "operator": "EQ",
                    "value": "A"
                }
            ]
        }
    ]
}

Example Response#

{
    "success": 1,
    "data": {
        "total_count": 1,
        "start_offset": 0,
        "data": [
            {
                "id": 1,
                "order_id": 0,
                "line_id": 0,
                "cust_id": 6,
                "custpc_id": 0,
                "product_id": 13,
                "subterm_id": 1,
                "addr_id": 10,
                "ship_id": 144,
                "ship_data": "free_shipping",
                "quantity": 1,
                "termrem": 0,
                "termproc": 0,
                "firstdate": {
                    "time_t": 0,
                    "year": 1969,
                    "month": 12,
                    "day": 31,
                    "hour": 16,
                    "minute": 0,
                    "second": 0,
                    "timezone": -8
                },
                "lastdate": {
                    "time_t": 0,
                    "year": 1969,
                    "month": 12,
                    "day": 31,
                    "hour": 16,
                    "minute": 0,
                    "second": 0,
                    "timezone": -8
                },
                "nextdate": {
                    "time_t": 1671609600,
                    "year": 2022,
                    "month": 12,
                    "day": 21,
                    "hour": 0,
                    "minute": 0,
                    "second": 0,
                    "timezone": -8
                },
                "status": "A",
                "message": "",
                "cncldate": {
                    "time_t": 0,
                    "year": 1969,
                    "month": 12,
                    "day": 31,
                    "hour": 16,
                    "minute": 0,
                    "second": 0,
                    "timezone": -8
                },
                "tax": 0.0,
                "formatted_tax": "$0.00",
                "shipping": 0.0,
                "formatted_shipping": "$0.00",
                "subtotal": 100.0,
                "formatted_subtotal": "$100.00",
                "total": 100.0,
                "formatted_total": "$100.00",
                "authfails": 0,
                "lastafail": {
                    "time_t": 0,
                    "year": 1969,
                    "month": 12,
                    "day": 31,
                    "hour": 16,
                    "minute": 0,
                    "second": 0,
                    "timezone": -8
                },
                "frequency": "n",
                "term": 0,
                "descrip": "Reorder every 30 days",
                "n": 30,
                "fixed_dow": 0,
                "fixed_dom": 0,
                "sub_count": 1,
                "method": "Free Shipping",
                "product_code": "subscription",
                "product_name": "Subscription",
                "product_sku": "",
                "product_price": 100.0,
                "product_formatted_price": "$100.00",
                "product_cost": 0.0,
                "product_formatted_cost": "$0.00",
                "product_weight": 1.0,
                "product_taxable": true,
                "product_thumbnail": "",
                "product_image": "",
                "product_active": true,
                "product_dt_created": 1671659203,
                "product_dt_Updated": 1671659386,
                "product_page_title": "",
                "product_page_id": 0,
                "product_page_code": "",
                "product_cancat_id": 0,
                "product_cancat_code": "",
                "product_inventory_active": false,
                "product_inventory": 0,
                "paymentcard_lastfour": "",
                "paymentcard_type": "",
                "address_descrip": "5060 Shoreham Drive",
                "address_fname": "APO",
                "address_lname": "Test",
                "address_email": "noreply@coolcommerce.net",
                "address_comp": "Miva Inc",
                "address_phone": "858-490-2571",
                "address_fax": "",
                "address_addr": "5060 Shoreham Drive Suite 130",
                "address_addr1": "5060 Shoreham Drive",
                "address_addr2": "Suite 130",
                "address_city": "San Diego",
                "address_state": "CA",
                "address_zip": "92121",
                "address_cntry": "US",
                "address_resdntl": false,
                "customer_login": "UPS_SP_APO",
                "customer_pw_email": "noreply@coolcommerce.net",
                "customer_business_title": "",
                "options": []
            }
        ]
    }
}