Skip to content

SubscriptionShippingMethodList_Load_Query#

This function loads a list of shipping methods for a subscription.

Request Parameters#

Parameter
Type Description
product_id
Edit_Product
Product_Code
Product_SKU
Number
String
String
String
ID Number of product
Product code string
Product code string
Product SKU string
productsubscriptionterm_id Number The id number of the product subscription term
customer_id Number The id number of the customer
address_id Number The id number of the customer address
quantity Number The product quantity of the subscription
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
success Boolean Boolean value indicating if the api request was successful
module Object Module Object
method_code String Code for the shipping method
method_name String Name for the shipping method
price Number Price for the shipping method
formatted_price String Formatted shipping price
total_count Number Number of shipping methods returned
start_offset Number Start offset for pagination

module Object#

Parameter
Type Description
id Number Shipping module id
code String Code for the shipping module
name String Name for the shipping module
provider String Module Provider
api_ver String The API version
version String Software version of Miva
module String Filepath for the module
refcount Number Count of references
active Boolean Indicates if module is active

Example Request#

{
    "Store_code": "beta",
    "Function": "SubscriptionShippingMethodList_Load_Query",
    "Product_ID": 9,
    "ProductSubscriptionTerm_ID": 1,
    "Customer_ID": 2,
    "Address_ID": 2,
    "Quantity": 1,
    "Filter": [],
    "Sort": "method",
    "Offset": 0,
    "Count": 18
}

Example Response#

{
    "success": 1,
    "data": {
        "data": [
            {
                "module": {
                    "id": 0,
                    "code": "",
                    "name": "",
                    "provider": "",
                    "api_ver": "",
                    "version": "",
                    "module": "",
                    "refcount": 0,
                    "active": false
                },
                "method_code": "",
                "method_name": "",
                "price": 0.0,
                "formatted_price": "$0.00"
            },
            {
                "module": {
                    "id": 140,
                    "code": "flatrate",
                    "name": "Flat Rate Shipping",
                    "provider": "Miva Merchant",
                    "api_ver": "5.61",
                    "version": "10.0300",
                    "module": "modules/shipping/flatrate.mvc",
                    "refcount": 1,
                    "active": true
                },
                "method_code": "ground",
                "method_name": "Ground Shipping",
                "price": 10.0,
                "formatted_price": "$10.00"
            },
            {
                "module": {
                    "id": 140,
                    "code": "flatrate",
                    "name": "Flat Rate Shipping",
                    "provider": "Miva Merchant",
                    "api_ver": "5.61",
                    "version": "10.0300",
                    "module": "modules/shipping/flatrate.mvc",
                    "refcount": 1,
                    "active": true
                },
                "method_code": "next day air",
                "method_name": "Next Day Air",
                "price": 30.0,
                "formatted_price": "$30.00"
            },
            {
                "module": {
                    "id": 140,
                    "code": "flatrate",
                    "name": "Flat Rate Shipping",
                    "provider": "Miva Merchant",
                    "api_ver": "5.61",
                    "version": "10.0300",
                    "module": "modules/shipping/flatrate.mvc",
                    "refcount": 1,
                    "active": true
                },
                "method_code": "overnight",
                "method_name": "Overnight",
                "price": 15.0,
                "formatted_price": "$15.00"
            }
        ],
        "total_count": 4,
        "start_offset": 0
    }
}

Error Responses#

Error Code Error Message Error Description
MER-SUB-JSN-00057 Product subscription term not found Product subscription term not found