24/7 Support: 800.608.6482

Navigation


Runtime_UpdateShipping

This function allows you to update the shipping address in a runtime checkout session.

Address Validation should be done separately using the Runtime_ValidateAddress function

Request Body 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:
Runtime Update Function
The name of the function being executed
Session_Type Type:
String
Title:
Session Type
This will always be "runtime"
Session_ID Type:
String
Title:
Session ID
The Session ID of the basket
Update_Customer Type:
Boolean
Title:
Update Customer Shipping Address
If true the associated customer record will be updated
Address_ID Type:
Number
Title:
Customer Address ID
The Customer Address ID that you want to update shipping with. All other address fields must be blank.
FirstName Type:
String
Title:
FirstName
Shipping First Name
LastName Type:
String
Title:
LastName
Shipping Last Name
Email Type:
String
Title:
Email
Shipping Email Address
Phone Type:
String
Title:
Phone
Shipping Phone Number
Address1 Type:
String
Title:
Address1
Shipping Address line one
Address2 Type:
String
Title:
Address2
Shipping Address line two
City Type:
String
Title:
City
Shipping City
State Type:
String
Title:
State
Shipping State
Zip Type:
String
Title:
Zip
Shipping Zip Code
Country Type:
String
Title:
Country
Shipping Country Code

Response Parameters

success boolean value for if the request was successfull
total Basket total
subtotal Basket Subtotal
formatted_total Currency formatted total
formatted_subtotal Currency formatted subtotal
ready_for_checkout returns false or true. If false, a ready_for_checkout_reason will be provided
ready_for_checkout_reason Reason session is not ready for checkout. Possible reasons include: 1. Missing shipping and tax 2. Missing shipping 3. Missing Tax
Content-Type for the request must be 'application/json'

Example Request

Example Response

Copyright © 1997 – 2026 Miva®, Miva Merchant®, MivaPay Vault®, Camp Miva®, Miva Connect®, Vexture℠, Miva, Inc. All Rights Reserved.