24/7 Support: 800.608.6482



This function allows you to load a list of available shipping methods for a basket. The shipping address must already be known for this function to return results. This function requires you pass a Session_ID and Checkout_Session_ID if calling from an external system.

If calling this function from a Miva page, there is a helper function with the same name that is part of runtime.js and does not require any parameters

Request Body Parameters

Session_Type Type:
Session Type
This will alwsys be "runtime"
Session_ID Type:
Session ID
The Session ID of the basket
Checkout_Session_ID Type:
Checkout Session ID
Checkout Session ID. This is available once OCST (Bill To/Ship To) has been submitted
Customer_Session_ID Type:
Customer Session ID
Optional - Customer Session ID. This will be available if the customer is currently logged into their customer account during checkout.

Response Parameters

success boolean value for if the request was successfull
module Code of the Shipping Module
code Shipping Method Code
name Shipping Method Name
price Shipping Method Price
formatted_price Shipping Formatted Price
Content-Type for the request must be 'application/json'

Example Request

Example Response

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.


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