24/7 Support: 800.608.6482

Navigation


SubscriptionShippingMethodList_Load_Query

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

Request Parameters

store_code Type:
String
Title:
Store Code
Store code to run the function against. Found in the Miva Admin under Settings > Store Details
function Type:
String
Title:
Subscription Shipping Method List Load Query
The name of the function being executed
product_id Type:
Number
Title:
Product ID
The id number of the product
productsubscriptionterm_id Type:
Number
Title:
Product Subscription Term ID
The id number of the product subscription term
customer_id Type:
Number
Title:
Customer ID
The id number of the customer
address_id Type:
Number
Title:
Address ID
The id number of the customer address
quantity Type:
Number
Title:
Subscription Quantity
The product quantity of the subscription
filter Type:
Object
Title:
Filter
Array of objects containing search filters. See usage here: List Load Query Overview
sort Type:
String
Title:
Sort
The order for sorting any returned data
offset Type:
Number
Title:
Offset
Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
count Type:
Number
Title:
Count
Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return

Response Parameters

The data structure of the `module` object below is repeated for each shipping method.
success Type:
Boolean
Title:
Status Response
Boolean value indicating if the api request was successful
module
+ Show Properties
Type:
Object
Title:
module
Subscription Shipping Module
id Type:
Number
Title:
ID
Shipping module id
code Type:
String
Title:
Module Code
Code for the shipping module
name Type:
String
Title:
Module Name
Name for the shipping module
provider Type:
String
Title:
Provider
Module Provider
api_ver Type:
String
Title:
API Version
The api version of the shipping module
version Type:
String
Title:
Software Version
Software version of Miva
module Type:
String
Title:
Module File
Filepath for the shipping module
refcount Type:
Number
Title:
refcount
A count of references for the shipping module
active Type:
Boolean
Title:
Status Response
Boolean value indicating if the shipping module is active
method_code Type:
String
Title:
Method Code
The code for the shipping method
method_name Type:
String
Title:
Method Name
The name for the shipping method
price Type:
Number
Title:
Shipping Price
The price for the shipping method
formatted_price Type:
String
Title:
Currency Formatted Shipping Price
Currency formatted shipping price
total_count Type:
Number
Title:
Total Count
the number of shipping methods returned
start_offset Type:
Number
Title:
Start Offset
the offset starting point for pagination of return data

Example Request

Example Response

Error Responses

error code:
MER-SUB-JSN-00057
error message:
Product subscription term not found
description:
Product subscription term not found

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.

Accept

Copyright © 1997 – 2024 Miva®, Miva Merchant®, MivaPay®, MivaCon®, Camp Miva®, Miva Connect®, Miva, Inc. All Rights Reserved.