24/7 Support: 800.608.6482

Navigation

AvailabilityGroupShippingMethodList_Load_Query

This function loads a list of shipping methods by Availability Group.

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:
Availability Group Shipping Method List Load Query		 The name of the function being executed
assigned Type:
Boolean		 Title:
Assigned		 Boolean value indicating if the query returns assigned shipping methods
availabilitygroup_id Type:
Number		 Title:
Availability Group ID		 The id number of the availability group
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
offset Type:
Number		 Title:
Offset		 Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
sort Type:
String		 Title:
Sort		 The order for sorting returned data
unassigned Type:
Boolean		 Title:
Unassigned		 Boolean value indicating if the query returns unassigned shipping methods

Response Parameters

success Type:
Boolean		 Title:
Status Response		 Boolean value indicating if the api request was successful
mod_code Type:
String		 Title:
Shipping Module Code		 The shipping module code
meth_code Type:
String		 Title:
Shipping Method Code		 The shipping method code
method_name Type:
String		 Title:
Shipping Method Name		 The shipping method name
assigned Type:
Boolean		 Title:
Assigned		 Boolean value indicating if the shipping method is currently assigned to the availability group
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-AGR-JSN-00042		 error message:
Availability group not found		 description:
Availability group 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 – 2023 Miva©, Miva Merchant©, MivaPay©, MivaCon©, Camp Miva ℠, Miva, Inc. All Rights Reserved.