@avvyr/storefront-sdk - v0.19.0
Docs
Storefront API
Preparing search index...
index
Module index
Functions
browserTimeZone
createSseReader
createStorefrontClient
decodeAccessToken
drawingOf
drawingsOf
groupCartLines
groupCartLinesBySet
isAccessTokenExpired
isChargeLine
readSseStream
sortAccessTokens
Classes
InterceptorManager
StorefrontApiError
StorefrontConfigError
Interfaces
AccessTokenClaims
AddConfiguredItemsParams
AddItemParams
Address
AddSetParams
AppliedDiscountCode
AssetListParams
AssetListResponse
AuthMethods
AuthorizeCheckoutParams
AuthResponse
CartConsent
CartConsentInput
CartCustomer
CartLineItem
CartLinesBySet
CartOptionGroup
CartRepricedChange
CartSetGroup
CartSetView
CartShipmentOrder
CartShippingDetails
CartVatValidation
CategoryListParams
CheckoutResponse
Company
CompanyInvite
CompanyMember
CompanyMembership
CompleteCartParams
ConfiguredItemsBody
ConfirmationResponse
CreateReturnItem
CreateReturnParams
CustomerCartSummary
CustomerProfile
GiftCardRecipient
InitCheckoutParams
InviteMemberParams
LineCharge
LineOptionGroup
LineSet
LinkedIdentity
LoginParams
MagicLinkCodeParams
NewSetParams
OptionCatalogGroup
OptionCatalogItem
OptionCatalogView
OptionChargeTier
OptionGroupSelection
OptionItemAsset
OptionItemAttribute
OptionLineSnapshot
OptionPriceClass
OptionProfileCharge
OptionProfileOption
OptionProfilePosition
OptionProfileView
OptionSelectionSnapshot
Order
OrderAppliedDiscountCode
OrderLineItem
OrderListParams
OrderListResponse
OrderShipment
OrderShipmentOrder
OrderShipmentOrderItem
OrderShippingDetails
Pagination
PaymentMethod
PickupLocation
PickupLocationAddress
ProductSearchParams
ProductSearchResponse
ProviderSignInParams
RegisterParams
RegisterResponse
RelatedProductGroup
RequestContext
ResponseContext
ReturnableItem
ReturnAttachment
ReturnAttachmentSettings
ReturnClaimTerms
ReturnLineItem
ReturnListResponse
ReturnOrder
Review
ReviewConsent
ReviewListParams
ReviewListResponse
ReviewStatistics
SearchFacets
SendInviteParams
SetAddressParams
SetCustomerParams
SetLayout
SetLayoutPart
SetLineLike
SetShippingParams
ShipmentOptions
ShipmentOptionShipment
ShipmentShippingOptions
ShippingOption
ShippingOptionsParams
SseReader
StorefrontAsset
StorefrontAttribute
StorefrontBundle
StorefrontCampaign
StorefrontCart
StorefrontCategory
StorefrontCategoryPage
StorefrontClient
StorefrontClientConfig
StorefrontColorVariant
StorefrontHotspot
StorefrontImageWithHotspots
StorefrontInterceptors
StorefrontMarket
StorefrontProduct
StorefrontStockLevel
StorefrontVariant
SubmitReviewParams
SubmitReviewResponse
SuggestionItem
SuggestParams
SuggestResponse
UpdateProfileParams
UploadReturnAttachmentsParams
UploadReturnAttachmentsResponse
ValidateReturnResponse
VatStamps
VerifyReviewResponse
Type Aliases
AddSetResult
CheckoutAuthorizeResult
CheckoutInitResult
ConfiguredItemsResult
ErrorInterceptor
LineSetSourceType
OptionPricingMode
OptionSelections
OrderShipmentOrderStatus
PaymentSessionState
ProviderSignInResponse
RequestInterceptor
ResponseInterceptor
ReturnResolution
ShipmentPreference
SignInCompany
SignInProvider
UpdateSetItem
VatRateSource
VatTreatment
Namespaces
options
References
AddSavedListItemsResult
→
AddSavedListItemsResult
AddSavedListToCartParams
→
AddSavedListToCartParams
AddSavedListToCartResult
→
AddSavedListToCartResult
AssistantAccess
→
AssistantAccess
AssistantActivityKind
→
AssistantActivityKind
AssistantAttachment
→
AssistantAttachment
AssistantAvailability
→
AssistantAvailability
AssistantAvailabilityStore
→
AssistantAvailabilityStore
AssistantCampaignsCard
→
AssistantCampaignsCard
AssistantCapabilities
→
AssistantCapabilities
AssistantCard
→
AssistantCard
AssistantCartCard
→
AssistantCartCard
AssistantConfig
→
AssistantConfig
AssistantContext
→
AssistantContext
AssistantConversation
→
AssistantConversation
AssistantConversationStatus
→
AssistantConversationStatus
AssistantDeliveryCard
→
AssistantDeliveryCard
AssistantDeliveryOption
→
AssistantDeliveryOption
AssistantFreeShippingCard
→
AssistantFreeShippingCard
AssistantHandoverInfo
→
AssistantHandoverInfo
AssistantHandoverParams
→
AssistantHandoverParams
AssistantMessage
→
AssistantMessage
AssistantOrderCard
→
AssistantOrderCard
AssistantProductCardItem
→
AssistantProductCardItem
AssistantProductsCard
→
AssistantProductsCard
AssistantProposal
→
AssistantProposal
AssistantProposalLine
→
AssistantProposalLine
AssistantProposalResult
→
AssistantProposalResult
AssistantProposalStatus
→
AssistantProposalStatus
AssistantProposalSummary
→
AssistantProposalSummary
AssistantReturnCard
→
AssistantReturnCard
AssistantSigningCard
→
AssistantSigningCard
AssistantSigningCardItem
→
AssistantSigningCardItem
AssistantStoreCardItem
→
AssistantStoreCardItem
AssistantStoreHours
→
AssistantStoreHours
AssistantStoresCard
→
AssistantStoresCard
AssistantStoreStatus
→
AssistantStoreStatus
AssistantStoreTime
→
AssistantStoreTime
AssistantStreamEvent
→
AssistantStreamEvent
AssistantStreamResult
→
AssistantStreamResult
AssistantTrackingCard
→
AssistantTrackingCard
AssistantTrackingParcel
→
AssistantTrackingParcel
ConfirmAssistantProposalResponse
→
ConfirmAssistantProposalResponse
ConsentChoices
→
ConsentChoices
ConsentReceiptInput
→
ConsentReceiptInput
ConsentReceiptResult
→
ConsentReceiptResult
CreateAssistantConversationParams
→
CreateAssistantConversationParams
CreateAssistantConversationResponse
→
CreateAssistantConversationResponse
CreateSavedListParams
→
CreateSavedListParams
createTrackingBatcher
→
createTrackingBatcher
ListSavedListsParams
→
ListSavedListsParams
paymentSessionState
→
paymentSessionState
PresencePing
→
PresencePing
PresencePingOptions
→
PresencePingOptions
QuoteAssistantDeliveryParams
→
QuoteAssistantDeliveryParams
QuoteAssistantDeliveryResponse
→
QuoteAssistantDeliveryResponse
SavedList
→
SavedList
SavedListAccess
→
SavedListAccess
SavedListExpanded
→
SavedListExpanded
SavedListItem
→
SavedListItem
SavedListItemExpanded
→
SavedListItemExpanded
SavedListItemInput
→
SavedListItemInput
SavedListMembership
→
SavedListMembership
SavedListSummary
→
SavedListSummary
SavedListType
→
SavedListType
SendAssistantMessageOptions
→
SendAssistantMessageOptions
TRACKING_MAX_BATCH
→
TRACKING_MAX_BATCH
TrackingBatcher
→
TrackingBatcher
TrackingBatcherOptions
→
TrackingBatcherOptions
TrackingCollectResult
→
TrackingCollectResult
TrackingEventBase
→
TrackingEventBase
TrackingEventInput
→
TrackingEventInput
UpdateSavedListItemParams
→
UpdateSavedListItemParams
UpdateSavedListParams
→
UpdateSavedListParams
UploadAssistantAttachmentsResponse
→
UploadAssistantAttachmentsResponse
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Functions
browser
Time
Zone
create
Sse
Reader
create
Storefront
Client
decode
Access
Token
drawing
Of
drawings
Of
group
Cart
Lines
group
Cart
Lines
By
Set
is
Access
Token
Expired
is
Charge
Line
read
Sse
Stream
sort
Access
Tokens
Classes
Interceptor
Manager
Storefront
Api
Error
Storefront
Config
Error
Interfaces
Access
Token
Claims
Add
Configured
Items
Params
Add
Item
Params
Address
Add
Set
Params
Applied
Discount
Code
Asset
List
Params
Asset
List
Response
Auth
Methods
Authorize
Checkout
Params
Auth
Response
Cart
Consent
Cart
Consent
Input
Cart
Customer
Cart
Line
Item
Cart
Lines
By
Set
Cart
Option
Group
Cart
Repriced
Change
Cart
Set
Group
Cart
Set
View
Cart
Shipment
Order
Cart
Shipping
Details
Cart
Vat
Validation
Category
List
Params
Checkout
Response
Company
Company
Invite
Company
Member
Company
Membership
Complete
Cart
Params
Configured
Items
Body
Confirmation
Response
Create
Return
Item
Create
Return
Params
Customer
Cart
Summary
Customer
Profile
Gift
Card
Recipient
Init
Checkout
Params
Invite
Member
Params
Line
Charge
Line
Option
Group
Line
Set
Linked
Identity
Login
Params
Magic
Link
Code
Params
New
Set
Params
Option
Catalog
Group
Option
Catalog
Item
Option
Catalog
View
Option
Charge
Tier
Option
Group
Selection
Option
Item
Asset
Option
Item
Attribute
Option
Line
Snapshot
Option
Price
Class
Option
Profile
Charge
Option
Profile
Option
Option
Profile
Position
Option
Profile
View
Option
Selection
Snapshot
Order
Order
Applied
Discount
Code
Order
Line
Item
Order
List
Params
Order
List
Response
Order
Shipment
Order
Shipment
Order
Order
Shipment
Order
Item
Order
Shipping
Details
Pagination
Payment
Method
Pickup
Location
Pickup
Location
Address
Product
Search
Params
Product
Search
Response
Provider
Sign
In
Params
Register
Params
Register
Response
Related
Product
Group
Request
Context
Response
Context
Returnable
Item
Return
Attachment
Return
Attachment
Settings
Return
Claim
Terms
Return
Line
Item
Return
List
Response
Return
Order
Review
Review
Consent
Review
List
Params
Review
List
Response
Review
Statistics
Search
Facets
Send
Invite
Params
Set
Address
Params
Set
Customer
Params
Set
Layout
Set
Layout
Part
Set
Line
Like
Set
Shipping
Params
Shipment
Options
Shipment
Option
Shipment
Shipment
Shipping
Options
Shipping
Option
Shipping
Options
Params
Sse
Reader
Storefront
Asset
Storefront
Attribute
Storefront
Bundle
Storefront
Campaign
Storefront
Cart
Storefront
Category
Storefront
Category
Page
Storefront
Client
Storefront
Client
Config
Storefront
Color
Variant
Storefront
Hotspot
Storefront
Image
With
Hotspots
Storefront
Interceptors
Storefront
Market
Storefront
Product
Storefront
Stock
Level
Storefront
Variant
Submit
Review
Params
Submit
Review
Response
Suggestion
Item
Suggest
Params
Suggest
Response
Update
Profile
Params
Upload
Return
Attachments
Params
Upload
Return
Attachments
Response
Validate
Return
Response
Vat
Stamps
Verify
Review
Response
Type Aliases
Add
Set
Result
Checkout
Authorize
Result
Checkout
Init
Result
Configured
Items
Result
Error
Interceptor
Line
Set
Source
Type
Option
Pricing
Mode
Option
Selections
Order
Shipment
Order
Status
Payment
Session
State
Provider
Sign
In
Response
Request
Interceptor
Response
Interceptor
Return
Resolution
Shipment
Preference
Sign
In
Company
Sign
In
Provider
Update
Set
Item
Vat
Rate
Source
Vat
Treatment
Namespaces
options
References
Add
Saved
List
Items
Result
Add
Saved
List
To
Cart
Params
Add
Saved
List
To
Cart
Result
Assistant
Access
Assistant
Activity
Kind
Assistant
Attachment
Assistant
Availability
Assistant
Availability
Store
Assistant
Campaigns
Card
Assistant
Capabilities
Assistant
Card
Assistant
Cart
Card
Assistant
Config
Assistant
Context
Assistant
Conversation
Assistant
Conversation
Status
Assistant
Delivery
Card
Assistant
Delivery
Option
Assistant
Free
Shipping
Card
Assistant
Handover
Info
Assistant
Handover
Params
Assistant
Message
Assistant
Order
Card
Assistant
Product
Card
Item
Assistant
Products
Card
Assistant
Proposal
Assistant
Proposal
Line
Assistant
Proposal
Result
Assistant
Proposal
Status
Assistant
Proposal
Summary
Assistant
Return
Card
Assistant
Signing
Card
Assistant
Signing
Card
Item
Assistant
Store
Card
Item
Assistant
Store
Hours
Assistant
Stores
Card
Assistant
Store
Status
Assistant
Store
Time
Assistant
Stream
Event
Assistant
Stream
Result
Assistant
Tracking
Card
Assistant
Tracking
Parcel
Confirm
Assistant
Proposal
Response
Consent
Choices
Consent
Receipt
Input
Consent
Receipt
Result
Create
Assistant
Conversation
Params
Create
Assistant
Conversation
Response
Create
Saved
List
Params
create
Tracking
Batcher
List
Saved
Lists
Params
payment
Session
State
Presence
Ping
Presence
Ping
Options
Quote
Assistant
Delivery
Params
Quote
Assistant
Delivery
Response
Saved
List
Saved
List
Access
Saved
List
Expanded
Saved
List
Item
Saved
List
Item
Expanded
Saved
List
Item
Input
Saved
List
Membership
Saved
List
Summary
Saved
List
Type
Send
Assistant
Message
Options
TRACKING_
MAX_
BATCH
Tracking
Batcher
Tracking
Batcher
Options
Tracking
Collect
Result
Tracking
Event
Base
Tracking
Event
Input
Update
Saved
List
Item
Params
Update
Saved
List
Params
Upload
Assistant
Attachments
Response
Docs
Storefront API
@avvyr/storefront-sdk - v0.19.0
Loading...