Search
Preparing search index...
The search index is not available
storefront-sdk
Options
All
Public
Public/Protected
All
Inherited
Menu
storefront-sdk
sdk-full/models/checkout
Module sdk-full/models/checkout
Index
Type aliases
Checkout
Add
Coupon
Data
Checkout
Add
Metadata
Data
Checkout
Add
Metadata
For
Product
Variant
Data
Checkout
Address
Associate
Data
Checkout
Change
Multi
Payment
Values
Data
Checkout
Change
Multi
Payment
Values
Input
Checkout
Clone
Data
Checkout
Complete
Data
Checkout
Cookie
Only
Data
Checkout
Customer
Associate
Data
Checkout
Customization
Input
Checkout
Data
Checkout
Gift
Variant
Selection
Data
Checkout
Kit
Data
Checkout
Kit
Input
Checkout
Metadata
Input
Checkout
Product
Checkout
Product
Customization
Data
Checkout
Product
Customization
Value
Data
Checkout
Product
Data
Checkout
Product
Input
Checkout
Product
Item
Update
Input
Checkout
Product
Subscription
Data
Checkout
Product
Subscription
Item
Data
Checkout
Product
Update
Input
Checkout
Remove
Coupon
Data
Checkout
Remove
Product
Customization
Data
Checkout
Select
Installment
Data
Checkout
Select
Payment
Method
Data
Checkout
Select
Shipping
Quote
Data
Checkout
Select
Shipping
Quote
Input
Checkout
Subscription
Input
Checkout
Update
Product
Data
Current
Account
Selected
Data
Type aliases
Checkout
Add
Coupon
Data
Checkout
Add
Coupon
Data
:
{
checkoutId
:
string
;
coupon
?:
string
}
Type declaration
checkout
Id
:
string
Optional
coupon
?:
string
Checkout
Add
Metadata
Data
Checkout
Add
Metadata
Data
:
{
checkoutId
:
string
;
metadata
:
{
key
:
string
;
value
:
string
}
[]
}
Type declaration
checkout
Id
:
string
metadata
:
{
key
:
string
;
value
:
string
}
[]
Checkout
Add
Metadata
For
Product
Variant
Data
Checkout
Add
Metadata
For
Product
Variant
Data
:
{
checkoutId
:
string
;
metadata
:
{
key
:
string
;
value
:
string
}
[]
;
products
:
{
metadata
:
{
key
:
string
;
value
:
string
}
[]
;
productId
:
number
;
productVariantId
:
number
}
[]
;
total
:
number
}
Type declaration
checkout
Id
:
string
metadata
:
{
key
:
string
;
value
:
string
}
[]
products
:
{
metadata
:
{
key
:
string
;
value
:
string
}
[]
;
productId
:
number
;
productVariantId
:
number
}
[]
total
:
number
Checkout
Address
Associate
Data
Checkout
Address
Associate
Data
:
{
cep
:
string
;
checkoutId
:
string
;
selectedAddress
?:
{
addressNumber
:
string
;
cep
:
string
;
city
:
string
;
complement
:
string
;
id
:
string
;
neighborhood
:
string
;
referencePoint
:
string
;
state
:
string
;
street
:
string
}
}
Type declaration
cep
:
string
checkout
Id
:
string
Optional
selected
Address
?:
{
addressNumber
:
string
;
cep
:
string
;
city
:
string
;
complement
:
string
;
id
:
string
;
neighborhood
:
string
;
referencePoint
:
string
;
state
:
string
;
street
:
string
}
address
Number
:
string
cep
:
string
city
:
string
complement
:
string
id
:
string
neighborhood
:
string
reference
Point
:
string
state
:
string
street
:
string
Checkout
Change
Multi
Payment
Values
Data
Checkout
Change
Multi
Payment
Values
Data
:
{
checkoutId
:
string
;
selectedPaymentMethods
?:
{
id
:
string
;
value
:
number
}
[]
}
Type declaration
checkout
Id
:
string
Optional
selected
Payment
Methods
?:
{
id
:
string
;
value
:
number
}
[]
Checkout
Change
Multi
Payment
Values
Input
Checkout
Change
Multi
Payment
Values
Input
:
{
paymentId
:
string
;
value
:
number
}
Type declaration
payment
Id
:
string
value
:
number
Checkout
Clone
Data
Checkout
Clone
Data
:
{
checkoutId
:
string
}
Type declaration
checkout
Id
:
string
Checkout
Complete
Data
Checkout
Complete
Data
:
{
cep
:
string
;
checkoutId
:
string
;
completed
:
boolean
;
orders
:
{
date
:
string
;
discount
:
number
;
discountValue
:
number
;
orderId
:
string
;
orderStatus
:
string
;
paymentFees
:
number
;
products
:
{
attributes
:
{
name
:
string
;
value
:
string
}
[]
;
name
:
string
;
productVariantId
:
string
;
quantity
:
number
;
value
:
number
}
[]
;
shippingFee
:
number
;
shippingValue
:
number
;
subtotal
:
number
;
total
:
number
;
totalValue
:
number
}
[]
}
Type declaration
cep
:
string
checkout
Id
:
string
completed
:
boolean
orders
:
{
date
:
string
;
discount
:
number
;
discountValue
:
number
;
orderId
:
string
;
orderStatus
:
string
;
paymentFees
:
number
;
products
:
{
attributes
:
{
name
:
string
;
value
:
string
}
[]
;
name
:
string
;
productVariantId
:
string
;
quantity
:
number
;
value
:
number
}
[]
;
shippingFee
:
number
;
shippingValue
:
number
;
subtotal
:
number
;
total
:
number
;
totalValue
:
number
}
[]
Checkout
Cookie
Only
Data
Checkout
Cookie
Only
Data
:
{
checkoutId
:
string
;
cookieOnly
:
boolean
}
Type declaration
checkout
Id
:
string
cookie
Only
:
boolean
Checkout
Customer
Associate
Data
Checkout
Customer
Associate
Data
:
{
checkoutId
:
string
;
customer
?:
{
customerName
:
string
;
email
:
string
}
}
Type declaration
checkout
Id
:
string
Optional
customer
?:
{
customerName
:
string
;
email
:
string
}
customer
Name
:
string
email
:
string
Checkout
Customization
Input
Checkout
Customization
Input
:
{
customizationId
:
number
;
value
:
string
}
Type declaration
customization
Id
:
number
value
:
string
Checkout
Data
Checkout
Data
:
{
checkoutId
:
string
;
products
:
CheckoutProduct
[]
;
shippingFee
:
number
;
subtotal
:
number
;
total
:
number
;
url
:
string
}
Type declaration
checkout
Id
:
string
products
:
CheckoutProduct
[]
shipping
Fee
:
number
subtotal
:
number
total
:
number
url
:
string
Checkout
Gift
Variant
Selection
Data
Checkout
Gift
Variant
Selection
Data
:
{
checkoutId
:
string
;
products
:
{
gift
:
boolean
;
productVariantId
:
number
}
[]
}
Type declaration
checkout
Id
:
string
products
:
{
gift
:
boolean
;
productVariantId
:
number
}
[]
Checkout
Kit
Data
Checkout
Kit
Data
:
{
checkoutId
:
string
;
kits
:
{
alias
:
string
;
imageUrl
:
string
;
kitGroupId
:
string
;
kitId
:
number
;
listPrice
:
number
;
name
:
string
;
price
:
number
;
products
:
CheckoutProduct
[]
;
quantity
:
number
;
totalListPrice
:
number
}
[]
;
url
:
string
}
Type declaration
checkout
Id
:
string
kits
:
{
alias
:
string
;
imageUrl
:
string
;
kitGroupId
:
string
;
kitId
:
number
;
listPrice
:
number
;
name
:
string
;
price
:
number
;
products
:
CheckoutProduct
[]
;
quantity
:
number
;
totalListPrice
:
number
}
[]
url
:
string
Checkout
Kit
Input
Checkout
Kit
Input
:
{
id
:
string
;
kitGroupId
:
string
;
kitId
:
number
;
products
:
{
productId
:
number
;
variants
:
{
productVariantId
:
number
;
quantity
:
number
}
[]
}
[]
;
quantity
:
number
}
Type declaration
id
:
string
kit
Group
Id
:
string
kit
Id
:
number
products
:
{
productId
:
number
;
variants
:
{
productVariantId
:
number
;
quantity
:
number
}
[]
}
[]
quantity
:
number
Checkout
Metadata
Input
Checkout
Metadata
Input
:
{
key
:
string
;
value
:
string
}
Type declaration
key
:
string
value
:
string
Checkout
Product
Checkout
Product
:
{
ajustedPrice
:
number
;
customization
:
{
id
:
string
;
values
:
{
cost
:
number
;
name
:
string
;
value
:
string
}
[]
}
;
imageUrl
:
string
;
listPrice
:
number
;
name
:
string
;
price
:
number
;
productAttributes
:
{
name
:
string
;
type
:
number
;
value
:
string
}
[]
;
productId
:
number
;
productVariantId
:
number
;
quantity
:
number
}
Type declaration
ajusted
Price
:
number
customization
:
{
id
:
string
;
values
:
{
cost
:
number
;
name
:
string
;
value
:
string
}
[]
}
id
:
string
values
:
{
cost
:
number
;
name
:
string
;
value
:
string
}
[]
image
Url
:
string
list
Price
:
number
name
:
string
price
:
number
product
Attributes
:
{
name
:
string
;
type
:
number
;
value
:
string
}
[]
product
Id
:
number
product
Variant
Id
:
number
quantity
:
number
Checkout
Product
Customization
Data
Checkout
Product
Customization
Data
:
{
id
:
string
;
values
:
CheckoutProductCustomizationValueData
}
Type declaration
id
:
string
values
:
CheckoutProductCustomizationValueData
Checkout
Product
Customization
Value
Data
Checkout
Product
Customization
Value
Data
:
{
cost
:
number
;
name
:
string
;
value
:
string
}
Type declaration
cost
:
number
name
:
string
value
:
string
Checkout
Product
Data
Checkout
Product
Data
:
{
customization
:
CheckoutProductCustomizationData
;
informations
:
string
;
subscription
:
CheckoutProductSubscriptionData
}
Type declaration
customization
:
CheckoutProductCustomizationData
informations
:
string
subscription
:
CheckoutProductSubscriptionData
Checkout
Product
Input
Checkout
Product
Input
:
{
customization
?:
{
customizationId
:
number
;
value
:
string
}
[]
;
customizationId
:
string
;
productVariantId
:
number
;
quantity
:
number
;
subscription
?:
{
recurringTypeId
:
number
;
subscriptionGroupId
:
number
}
}
Type declaration
Optional
customization
?:
{
customizationId
:
number
;
value
:
string
}
[]
customization
Id
:
string
product
Variant
Id
:
number
quantity
:
number
Optional
subscription
?:
{
recurringTypeId
:
number
;
subscriptionGroupId
:
number
}
recurring
Type
Id
:
number
subscription
Group
Id
:
number
Checkout
Product
Item
Update
Input
Checkout
Product
Item
Update
Input
:
{
customization
:
CheckoutCustomizationInput
;
customizationId
:
string
;
productVariantId
:
number
;
subscription
:
CheckoutSubscriptionInput
}
Type declaration
customization
:
CheckoutCustomizationInput
customization
Id
:
string
product
Variant
Id
:
number
subscription
:
CheckoutSubscriptionInput
Checkout
Product
Subscription
Data
Checkout
Product
Subscription
Data
:
{
selected
:
CheckoutProductSubscriptionItemData
}
Type declaration
selected
:
CheckoutProductSubscriptionItemData
Checkout
Product
Subscription
Item
Data
Checkout
Product
Subscription
Item
Data
:
{
name
:
string
;
recurringDays
:
number
;
recurringTypeId
:
number
;
selected
:
boolean
;
subscriptionGroupDiscount
:
number
;
subscriptionGroupId
:
number
}
Type declaration
name
:
string
recurring
Days
:
number
recurring
Type
Id
:
number
selected
:
boolean
subscription
Group
Discount
:
number
subscription
Group
Id
:
number
Checkout
Product
Update
Input
Checkout
Product
Update
Input
:
{
id
:
string
;
product
:
CheckoutProductItemUpdateInput
}
Type declaration
id
:
string
product
:
CheckoutProductItemUpdateInput
Checkout
Remove
Coupon
Data
Checkout
Remove
Coupon
Data
:
{
checkoutId
:
string
;
coupon
?:
string
}
Type declaration
checkout
Id
:
string
Optional
coupon
?:
string
Checkout
Remove
Product
Customization
Data
Checkout
Remove
Product
Customization
Data
:
{
checkoutId
:
string
}
Type declaration
checkout
Id
:
string
Checkout
Select
Installment
Data
Checkout
Select
Installment
Data
:
{
checkoutId
:
string
;
selectedPaymentMethod
?:
{
id
:
string
;
selectedInstallment
?:
{
adjustment
:
number
;
number
:
number
;
total
:
number
;
value
:
number
}
}
}
Type declaration
checkout
Id
:
string
Optional
selected
Payment
Method
?:
{
id
:
string
;
selectedInstallment
?:
{
adjustment
:
number
;
number
:
number
;
total
:
number
;
value
:
number
}
}
id
:
string
Optional
selected
Installment
?:
{
adjustment
:
number
;
number
:
number
;
total
:
number
;
value
:
number
}
adjustment
:
number
number
:
number
total
:
number
value
:
number
Checkout
Select
Payment
Method
Data
Checkout
Select
Payment
Method
Data
:
{
checkoutId
:
string
;
selectedPaymentMethod
?:
{
id
:
string
;
installments
?:
{
adjustment
:
number
;
number
:
number
;
total
:
number
;
value
:
number
}
[]
}
}
Type declaration
checkout
Id
:
string
Optional
selected
Payment
Method
?:
{
id
:
string
;
installments
?:
{
adjustment
:
number
;
number
:
number
;
total
:
number
;
value
:
number
}
[]
}
id
:
string
Optional
installments
?:
{
adjustment
:
number
;
number
:
number
;
total
:
number
;
value
:
number
}
[]
Checkout
Select
Shipping
Quote
Data
Checkout
Select
Shipping
Quote
Data
:
{
cep
:
string
;
checkoutId
:
string
;
selectedShipping
?:
{
deadline
:
string
;
name
:
string
;
shippingQuoteId
:
string
;
type
:
string
;
value
:
number
}
;
shippingFee
:
number
}
Type declaration
cep
:
string
checkout
Id
:
string
Optional
selected
Shipping
?:
{
deadline
:
string
;
name
:
string
;
shippingQuoteId
:
string
;
type
:
string
;
value
:
number
}
deadline
:
string
name
:
string
shipping
Quote
Id
:
string
type
:
string
value
:
number
shipping
Fee
:
number
Checkout
Select
Shipping
Quote
Input
Checkout
Select
Shipping
Quote
Input
:
{
additionalInformation
?:
{
document
:
string
;
name
:
string
}
;
checkoutId
?:
string
;
deliveryScheduleInput
?:
{
date
:
string
;
periodId
:
number
}
;
shippingQuoteId
:
string
}
Type declaration
Optional
additional
Information
?:
{
document
:
string
;
name
:
string
}
document
:
string
name
:
string
Optional
checkout
Id
?:
string
Optional
delivery
Schedule
Input
?:
{
date
:
string
;
periodId
:
number
}
date
:
string
period
Id
:
number
shipping
Quote
Id
:
string
Checkout
Subscription
Input
Checkout
Subscription
Input
:
{
recurringTypeId
:
number
;
subscriptionGroupId
:
number
}
Type declaration
recurring
Type
Id
:
number
subscription
Group
Id
:
number
Checkout
Update
Product
Data
Checkout
Update
Product
Data
:
{
checkoutId
:
string
;
products
:
CheckoutProductData
}
Type declaration
checkout
Id
:
string
products
:
CheckoutProductData
Current
Account
Selected
Data
Current
Account
Selected
Data
:
{
checkingAccountValue
:
number
;
total
:
number
}
Type declaration
checking
Account
Value
:
number
total
:
number
Modules
base/cookie
base/event
base/generic-
form-
repository
base/graphql-
client
base/graphql-
requests
base/models/graphql-
response
base/models/partner
base/models/shop-
setting
base/newsletter-
repository
base/partner-
repository
base/product-
repository
base/snippet
base/wishlist-
repository
sdk-
full/checkout-
repository
sdk-
full/customer-
repository
sdk-
full/models/checkout
sdk-
full/models/cookie-
domain
sdk-
full/models/customer
sdk-
full/models/order
sdk-
full/order-
repository
sdk-
full/storefront-
client
Checkout
Add
Coupon
Data
Checkout
Add
Metadata
Data
Checkout
Add
Metadata
For
Product
Variant
Data
Checkout
Address
Associate
Data
Checkout
Change
Multi
Payment
Values
Data
Checkout
Change
Multi
Payment
Values
Input
Checkout
Clone
Data
Checkout
Complete
Data
Checkout
Cookie
Only
Data
Checkout
Customer
Associate
Data
Checkout
Customization
Input
Checkout
Data
Checkout
Gift
Variant
Selection
Data
Checkout
Kit
Data
Checkout
Kit
Input
Checkout
Metadata
Input
Checkout
Product
Checkout
Product
Customization
Data
Checkout
Product
Customization
Value
Data
Checkout
Product
Data
Checkout
Product
Input
Checkout
Product
Item
Update
Input
Checkout
Product
Subscription
Data
Checkout
Product
Subscription
Item
Data
Checkout
Product
Update
Input
Checkout
Remove
Coupon
Data
Checkout
Remove
Product
Customization
Data
Checkout
Select
Installment
Data
Checkout
Select
Payment
Method
Data
Checkout
Select
Shipping
Quote
Data
Checkout
Select
Shipping
Quote
Input
Checkout
Subscription
Input
Checkout
Update
Product
Data
Current
Account
Selected
Data
Generated using
TypeDoc