Class: ZynoSalesClient
Low-level generated-contract client. It does not persist cart capabilities.
Constructors
Constructor
new ZynoSalesClient(
options):ZynoSalesClient
Parameters
options
apiBase
string
fetch?
{(input, init?): Promise<Response>; (input, init?): Promise<Response>; }
publishableKey
string
Returns
ZynoSalesClient
Methods
abandonCart()
abandonCart(
cartId,cartKey):Promise<void>
Parameters
cartId
string
cartKey
string
Returns
Promise<void>
acceptMembershipTerms()
acceptMembershipTerms(
cartId,cartKey,input):Promise<ISalesEcommCartResponse>
Parameters
cartId
string
cartKey
string
input
termsHash
string
Returns
Promise<ISalesEcommCartResponse>
applyDiscount()
applyDiscount(
cartId,cartKey,input):Promise<ISalesEcommCartResponse>
Parameters
cartId
string
cartKey
string
input
ISalesEcommCartDiscountCodeInput
Returns
Promise<ISalesEcommCartResponse>
calculateShippingRates()
calculateShippingRates(
cartId,cartKey,input):Promise<ISalesEcommShippingRatesResponse>
Parameters
cartId
string
cartKey
string
input
ISalesEcommCartShippingRatesInput
Returns
Promise<ISalesEcommShippingRatesResponse>
cancelPaymentAttempt()
cancelPaymentAttempt(
cartId,cartKey,attemptId):Promise<void>
Parameters
cartId
string
cartKey
string
attemptId
string
Returns
Promise<void>
confirmCardPayment()
confirmCardPayment(
cartId,cartKey,input):Promise<ISalesEcommOrderResponse>
Parameters
cartId
string
cartKey
string
input
ISalesEcommCartConfirmPaymentInput
Returns
Promise<ISalesEcommOrderResponse>
confirmMembershipCard()
confirmMembershipCard(
cartId,cartKey,input):Promise<ISalesEcommOrderResponse>
Parameters
cartId
string
cartKey
string
input
paymentAttemptId
string
setupIntentId
string
Returns
Promise<ISalesEcommOrderResponse>
createCart()
createCart(
input):Promise<ISalesEcommCartResponse>
Parameters
input
Returns
Promise<ISalesEcommCartResponse>
finalizeZeroDueCart()
finalizeZeroDueCart(
cartId,cartKey):Promise<ISalesEcommCartResponse>
Parameters
cartId
string
cartKey
string
Returns
Promise<ISalesEcommCartResponse>
getCart()
getCart(
cartId,cartKey):Promise<ISalesEcommCartResponse>
Parameters
cartId
string
cartKey
string
Returns
Promise<ISalesEcommCartResponse>
getConfig()
getConfig():
Promise<ISalesEcommStorefrontConfigResponse>
Returns
Promise<ISalesEcommStorefrontConfigResponse>
getOrder()
getOrder(
orderId,orderKey):Promise<ISalesEcommOrderResponse>
Parameters
orderId
string
orderKey
string
Returns
Promise<ISalesEcommOrderResponse>
getPaymentAttempt()
getPaymentAttempt(
cartId,cartKey,attemptId):Promise<ISalesEcommPaymentAttemptResponse>
Parameters
cartId
string
cartKey
string
attemptId
string
Returns
Promise<ISalesEcommPaymentAttemptResponse>
getProduct()
getProduct(
slug):Promise<ISalesEcommStoreProduct>
Parameters
slug
string
Returns
Promise<ISalesEcommStoreProduct>
getProducts()
getProducts():
Promise<ISalesEcommStoreProduct[]>
Returns
Promise<ISalesEcommStoreProduct[]>
quoteShippingSelection()
quoteShippingSelection(
cartId,cartKey,input):Promise<ISalesEcommShippingSelectionQuoteResponse>
Parameters
cartId
string
cartKey
string
input
ISalesEcommShippingSelectionQuoteInput
Returns
Promise<ISalesEcommShippingSelectionQuoteResponse>
removeDiscount()
removeDiscount(
cartId,cartKey):Promise<ISalesEcommCartResponse>
Parameters
cartId
string
cartKey
string
Returns
Promise<ISalesEcommCartResponse>
removeFulfillment()
removeFulfillment(
cartId,cartKey):Promise<ISalesEcommCartResponse>
Parameters
cartId
string
cartKey
string
Returns
Promise<ISalesEcommCartResponse>
replaceItems()
replaceItems(
cartId,cartKey,input):Promise<ISalesEcommCartResponse>
Parameters
cartId
string
cartKey
string
input
ISalesEcommCartUpdateItemsInput
Returns
Promise<ISalesEcommCartResponse>
setupCardPayment()
setupCardPayment(
cartId,cartKey,input):Promise<ISalesEcommCartPaymentSetupResponse>
Parameters
cartId
string
cartKey
string
input
ISalesEcommCartPaymentSetupInput
Returns
Promise<ISalesEcommCartPaymentSetupResponse>
setupMembershipCard()
setupMembershipCard(
cartId,cartKey,input):Promise<ISalesEcommCartMembershipCardSetupResponse>
Parameters
cartId
string
cartKey
string
input
ISalesEcommCartPaymentSetupInput
Returns
Promise<ISalesEcommCartMembershipCardSetupResponse>
updateBuyer()
updateBuyer(
cartId,cartKey,input):Promise<ISalesEcommCartResponse>
Parameters
cartId
string
cartKey
string
input
Returns
Promise<ISalesEcommCartResponse>
updateFulfillment()
updateFulfillment(
cartId,cartKey,input):Promise<ISalesEcommCartResponse>
Parameters
cartId
string
cartKey
string
input
ISalesEcommCartFulfillmentInput
Returns
Promise<ISalesEcommCartResponse>
validateDiscount()
validateDiscount(
cartId,cartKey,code):Promise<IValidateDiscountCodeResponse>
Parameters
cartId
string
cartKey
string
code
string
Returns
Promise<IValidateDiscountCodeResponse>
verifyAddress()
verifyAddress(
cartId,cartKey,input):Promise<ISalesFulfillmentAddressVerificationResponse>
Parameters
cartId
string
cartKey
string
input
ISalesEcommAddressVerificationInput