Kuikpay-sdk NPM

Kuikpay

Install

npm install --save kuikpay-sdk

Usage

Prop name	Type	Description	Default value
`addToCart`	`function`	Function that adds a product to your cart	`undefined`
`itemToAdd`	`Item`	Product to be added to your cart	`undefined`
`updateItems`	`function`	Function that removes products from your cart	`undefined`
`orderForm`	`OrderForm`	Information to make the order	`undefined`
`updateOrderFormProfile`	`function`	Function to update the user in your cart	`undefined`
`cartSimulation`	`function`	Function to make the cart simulations in your store	`undefined`
`clearData`	`function`	Function to reset your store information after making the order	`undefined`
`language`	`string`	Language in which the messages will be displayed	`undefined`
`isVisible`	`boolean`	Option to hide the button according to your needs, for example if a product has no inventory	`true`
`sandbox`	`boolean`	Option to change enviroments. Example `(true)` It is to use both the account and the workspace for development, `(false)` only workspace	`false`
`disabled`	`boolean`	Option to enable button	`false`
`theme`	`enum`	Allows you to change templates, styles and more. Possible values are: `kuikpay`, `vtex` and `generic`	`undefined`
`validateItems`	`function`	Function that returns the items that cannot be paid with `kuikpay` and is executed when you add a product to the cart.	`undefined`
`insertCoupon`	`function`	Function that inserts a coupon, for discount issues.	`undefined`
`addItemOffering`	`function`	Function that adds a service of a product.	`undefined`
`removeItemOffering`	`function`	Function that removes a service from a product.	`undefined`
`customData`	`CustomData`	Personalized information.	`undefined`
`config`	`Config`	Store configuration settings.	`undefined`
`validateBeforeOfAdd`	`function`	Function in which you want to execute something before adding. Returns `(true)` if you want to add the product to the cart.	`undefined`
`multipleAvailableSKUs`	`boolean`		`false or undefined ??`
`onClickBehavior`	`string`	Controls what happens when users click on the button. (If multiple SKUs are available, users will see a product window to select the desired one. If the product only has 1 SKU available, it will be added to the cart once the button is clicked.)	`ensure-sku-selection`
`product`	`Product`	Product Information	`undefined`
`selectedItem`	`ProductItem`	Information of the selected product	`undefined`
`handleSelectedItem`	`function`	This function is executed when the product has several SKUS and you select one of them.	`undefined`
`runtime`	`Runtime`	Account information and workspace in which you are working. If you are `VTEX` you can take it from the `__RUNTIME__` variable.	`undefined`
`handleGetDocumentsClient`	`function`	Function that allows to obtain the last time the user logged in and in that case update it. (This is for specific clients that require it).	`undefined`
`processOpenCoverageModal`	`function`	Function that allows you to open a geolocation window if the store has this type of functionality.	`undefined`
`forceOpenModal`	`boolean`	Force open the kuikpay modal.	`undefined`

Property	Type	Description
`clientProfileData`	`ClientProfileData`	Client information
`items`	`Item[]`	Items added to cart
`totalizers`	`Totalizer[]`	Totals
`shippingData`	`{ selectedAddress?: Address, addressAlternative?: Address }`	Information on the shipping method (address or pick up in store or more)
`value`	`number`	Amount to be paid
`paymentData`	`PaymentData`	Payment method information
`messages`	`Message[]`	Information, error, caution and more messages
`marketingData`	`MarketingData`	Marketing information

Property	Type	Description
`email`	`string`	Client email

Property	Type	Description
`uniqueId`	`string`	SKU Unique Id
`id`	`number`	SKU ID
`name`	`string`	Name SKU
`quantity`	`number`	Quantity to add
`sellingPrice`	`number`	Price in the seller
`imageUrl`	`string`	URL image
`availability`	`string`	Enabled Product. Possible values are: `available`, `unavailable`
`index`	`number`	Position located in the cart
`seller`	`string`	Seller ID
`offerings`	`Offering[]`	List of available services associated with the SKU
`bundleItems`	`BundleItem[]`	List of ??
`isGift`	`boolean`	Valid if the sku is a gift
`price`	`number`	SKU price
`skuSpecifications`	`any[]`	SKU specification list. Example: size, color
`listPrice`	`any[]`	List price ?? `(Optional)`

Property	Type	Description
`allowGiftMessage`	`boolean`	Message Gift
`id`	`string`	Offering ID
`name`	`string`	Name
`price`	`number`	Price
`type`	`string`	Type

Property	Type	Description
`id`	`string`	Bundle item ID
`name`	`string`	Name
`price`	`number`	Price

Property	Type	Description
`id`	`string`	Totalizer ID. Options `Items`, `Shipping`, `Tax`
`name`	`string`	Totalizer name
`value`	`number`	Value

Property	Type	Description
`addressId`	`string`	Address identifier
`addressType`	`string`	Type of address
`city`	`string`	city
`complement`	`string`	Additional information about the location. `(Optional)`
`completed`	`string`	Information completed
`country`	`string`	Country
`geoCoordinates`	`GeoCoordinates`	Geo coordinates (latitude, longitude)
`isDisposable`	`boolean`	The location is available `(Optional)`
`neighborhood`	`string`	neighborhood
`number`	`string`	Code `(Optional)` ??
`postalCode`	`string`	Postal code
`receiverName`	`string`	Name of the person who receives the purchase
`reference`	`string`	Reference ?? `(Optional)`
`state`	`string`	State or department or province
`street`	`string`	Full address

Property	Type	Description
`latitude`	`string`	Latitude
`longitude`	`string`	Longitude

Property	Type	Description
`availablePaymentMethods`	`PaymentMethod[]`	User available payment methods
`selectedPaymentMethod`	`PaymentMethod`	Selected payment methods
`paymentMethod`	`PaymentMethod`	Payment method information ??
`completed`	`boolean`	Completed process ??
`otherAvailablePaymentMethods`	`PaymentMethod[]`	Other payment methods available to the user
`bin`	`string`	Get the first 5 digits of the credit card. (This only applies to payment by credit card)
`installmentOptions`	`InstallmentOption[]`	List of fees with respect to credit cards enabled for the store.

Property	Type	Description
`id`	`string`	Credit card
`gateway`	`string`	?? `(Optional)`
`email`	`string`	Email `(Optional)`
`franchise`	`string`	Franchise credit card. Example: visa
`number`	`string`	Get the last 4 digits of the credit card. (This only applies to payment by credit card)
`ccToken`	`string`	Token ??
`paymentMethod`	`string`	Payment method
`bin`	`string`	Get the first 5 digits of the credit card. (This only applies to payment by credit card)

Property	Type	Description
`bin`	`string`	Get the first 5 digits of the credit card. (This only applies to payment by credit card)
`installments`	`Installment`	List of installments, their price in each installment and the total including interest
`paymentName`	`string`	Payment method name
`value`	`number`	Total purchase price paying with that franchise

Property	Type	Description
`count`	`number`	Installment number
`value`	`number`	Order value including interest depending on the fee
`total`	`number`	Total price if you pay with that fee

Property	Type	Description
`code`	`string`	Code

Property	Type	Description
`coupon`	`string`	Coupon

Property	Type	Description
`customApps`	`CustomApp[]`	Personalized information

Property	Type	Description
`id`	`string`	ID
`fields`	`CustomAppField[]`	Inputs to add in the store
`major`	`number`	Version or number ?

Property	Type	Description
`key`	`string`	Identification or key
`value`	`string`	Description

Property	Type	Description
`bagId`	`string`	If the store implements bag add the ID
`mainSellerId`	`string`	Main seller id
`oneBagForProducts`	`number`	Number of bags per product
`salesChannel`	`string`	Channel identifier seller
`productCategories`	`ProductCategoriesConfig`	Categories to apply the bag

Property	Type	Description
`market`	`string[]`	List of market identifiers
`healthAndBeauty`	`string[]`	List of health and beauty identifiers

Property	Type	Description
`items`	`ProductItem[]`	Information of the items that this product contains. Example: SKUS
`skuSpecifications`	`SkuSpecification[]`	Information about SKUS specifications. Example: color, size

Property	Type	Description
`itemId`	`string`	Item identification
`name`	`string`	Name
`images`	`Image[]`	List of image information
`variations`	`Array<{ name: string, values: string }>`	Variety of types
`sellers`	`Array<{ sellerDefault: boolean, commertialOffer: ProductItemSellers }>`	Distributions

Property	Type	Description
`imageId`	`string`
`imageLabel`	`string`
`imageTag`	`string`
`imageUrl`	`string`
`imageText`	`string`

Property	Type	Description
`Price`	`number`	Price item
`ListPrice`	`number`	List price item
`AvailableQuantity`	`number`	Quantity available

Property	Type	Description
`field`	`SkuSpecificationField`	Information specification SKU
`values`	`SkuSpecificationValues[]`	Information specification SKU

Property	Type	Description
`name`	`string`
`originalName`	`string`

Property	Type	Description
`name`	`string`
`originalName`	`string`

import React, { Component } from 'react'

import { Kuikpay } from 'kuikpay-sdk'
import 'kuikpay-sdk/dist/index.css'

class Example extends Component {
  render() {
    return <Kuikpay {...props} />
  }
}

Development

npm install
npm run start

Execute in another terminal

cd example
npm i
npm run start

License

Kuikpay

Install

Usage

Props

Types

OrderForm Type

ClientProfileData Type

Item Type

Offering Type

BundleItem Type

Totalizer Type

Address Type

GeoCoordinates Type

PaymentData Type

PaymentMethod Type

InstallmentOption Type

Installment Type

Message Type

MarketingData Type

CustomData Type

CustomApp Type

CustomAppField Type

Config Type

ProductCategoriesConfig Type

Product Type

ProductItem Type

Image Type

ProductItemSellers Type

SkuSpecification Type

SkuSpecificationField Type

SkuSpecificationValues Type

Development

License

`OrderForm` Type

`ClientProfileData` Type

`Item` Type

`Offering` Type

`BundleItem` Type

`Totalizer` Type

`Address` Type

`GeoCoordinates` Type

`PaymentData` Type

`PaymentMethod` Type

`InstallmentOption` Type

`Installment` Type

`Message` Type

`MarketingData` Type

`CustomData` Type

`CustomApp` Type

`CustomAppField` Type

`Config` Type

`ProductCategoriesConfig` Type

`Product` Type

`ProductItem` Type

`Image` Type

`ProductItemSellers` Type

`SkuSpecification` Type

`SkuSpecificationField` Type

`SkuSpecificationValues` Type