Cart - VendorFuel

Search…
Cart
Details of the VendorFuel API Cart service.
Properties
Bolded properties are currently used in templates.
Property
Type
Details
county
​
​
details
null
​
item_count
number
Total number of product within the cart.
(Example: if there are 3 each of 2 products, the number will be 6)
items
array
Products within the cart.
(Example: if there are 3 each of 2 products, the number will be 2)
paymentMethod
​
​
sandboxEnabled
Boolean
​
selectedShipping
object
Selected shipping method.
shipping_methods
null
​
squareUpAppID
null
​
squareUpPaymentForm
null
​
user
object
User service.
zipCode
string
​
Methods
Bolded methods are currently used in templates.
Method
Params
Details
​add​
productId
qty
Adds an item to the cart.
​addBySku​
sku
qty
Adds an item to the cart based on the SKU, rather than product ID.
​addItems​
products
Adds multiple items to the cart.
​addPromoCode​
promoCode
Applies a promo code to the cart.
authorizeCard
​
​
​checkout​
paypal
return_url
cancel_url
shipping_id
​
​clear​
​
Clears the cart.
clearShipping
​
​
​completeOrder​
params
​
confirmPaypalOrder
checkout_info
​
​confirmOrder​
checkout_info
​
​deleteSaved​
savedCartId
Deletes a saved cart.
​fillDetails​
​
Gets the cart details.
getAuthnetPaymentFormTemplate
​
Returns URL for Authnet Payment Form template.
getQty
productId
Gets the quantity of an item in the cart.
getPaymentMethod
​
Returns payment method.
getShippingMethodID
​
Returns the selected shipping method ID.
​getSaved​
savedCartId
Get a saved cart.
​getSavedList​
​
Gets a list of the user's saved carts.
​getShippingMethods​
order_id
profile_id
zipcode
​
getSquareUpApplicationID
​
Returns ID.
getSquareUpPaymentFormTemplate
​
Returns URL for SquareUp Payment Form template.
loadPaymentForm
payment_form_div
Empty function.
loadSquareUpPaymentForm
​
​
partialCheckout
items
​
​payfabricUrl​
return_url
order_id
Returns the Payfabric URL.
​priceAvailabilityResponse​
order
price_availability_response
​
​remove​
productId
Removes an item from the cart.
​removePromoCode​
promoCodeId
Removes a promo code from being applied to the cart.
​removeSavedItem​
savedCartId
productId
Removes an item from a saved cart.
​save​
cartTitle
Saves a copy of the current cart with the given title.
setCounty
county
​
setPaymentMethod
payment_method
Sets the payment method.
setSelectedShipping
selectedShipping
​
setShippingMethodID
shipping_method_id
Sets the selected shipping method ID.
setZip
zip
​
​update​
qty
product_id
Updates the quantity of an item in the cart.
Alerts
Cart.add()
Last modified 9mo ago
Copy link
Contents
Properties
Methods