Skip to content



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

Request Parameters#

Type Description
assigned Boolean Boolean value indicating if the query returns assigned shipping methods
The availability group id
The availability group name
The availability group name
count Number Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return
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
unassigned Boolean Boolean value indicating if the query returns unassigned shipping methods

Response Parameters#

Type Description
success Boolean Boolean value indicating if the api request was successful
mod_code String The shipping module code
meth_code String The shipping method code
method_name String The shipping method name
assigned Boolean Boolean value indicating if the shipping method is currently assigned to the availability group
total_count Number The number of shipping methods returned
start_offset Number The offset starting point for pagination of return data

Example Request#

    "Store_code": "beta",
    "Function": "AvailabilityGroupShippingMethodList_Load_Query",
    "Assigned": true,
    "AvailabilityGroup_ID": 4,
    "Count": 18,
    "Offset": 0,
    "Sort": "method_name",
    "Unassigned": true

Example Response#

    "success": 1,
    "data": {
        "data": [
                "mod_code": "flatrate",
                "meth_code": "Ground",
                "method_name": "Ground",
                "assigned": true
        "total_count": 1,
        "start_offset": 0

Error Responses#

Error Code Error Message Error Description
MER-AGR-JSN-00042 Availability group not found Availability group not found