Storefront

StorefrontApi

Methods

addCartLines()

addCartLines(lines): Promise<Cart>

Parameters

Parameter	Type
lines	OptimisticCartLine[]

Returns

Promise<Cart>

authorize()

authorize(): Promise<void>

Returns

Promise<void>

createAddress()

createAddress(args): Promise<Customer>

Parameters

Parameter	Type
args	object
args.address	MailingAddress
args.defaultAddress	boolean

Returns

Promise<Customer>

createCart()

createCart(args): Promise<undefined | Cart>

Parameters

Parameter	Type
args	object
args.discountCodes	string[]
args.lines	object[]

Returns

Promise<undefined | Cart>

deleteAddress()

deleteAddress(args): Promise<Customer>

Parameters

Parameter	Type
args	object
args.addressId	string

Returns

Promise<Customer>

getCart()

getCart(): Promise<Cart>

Returns

Promise<Cart>

getCategories()

getCategories(params): Promise<CategoriesQuery>

Parameters

Parameter	Type
params	object
params.endCursor?	string
params.first?	number
params.last?	number
params.startCursor?	string

Returns

Promise<CategoriesQuery>

getCategory()

getCategory(params): Promise<undefined | CategoryQuery>

Parameters

Parameter	Type
params	object
params.endCursor?	string
params.first?	number
params.handle	string
params.last?	number
params.startCursor?	string

Returns

Promise<undefined | CategoryQuery>

getCategoryTree()

getCategoryTree(): Promise<CategoryTree>

Returns

Promise<CategoryTree>

getCustomerDetails()

getCustomerDetails(): Promise<null | Customer>

Returns

Promise<null | Customer>

getCustomerOrder()

getCustomerOrder(args): Promise<undefined | Order>

Parameters

Parameter	Type
args	object
args.orderId	string

Returns

Promise<undefined | Order>

getCustomerOrders()

getCustomerOrders(args): Promise<CustomerOrdersQuery>

Parameters

Parameter	Type
args	object
args.endCursor?	string
args.first?	number
args.last?	number
args.startCursor?	string

Returns

Promise<CustomerOrdersQuery>

getProduct()

getProduct(params): Promise<undefined | Product>

Parameters

Parameter	Type
params	object
params.handle	string
params.selectedOptions	SelectedOption[]

Returns

Promise<undefined | Product>

getRecommendedProducts()

getRecommendedProducts(params): Promise<RecommendedProductsQuery>

Parameters

Parameter	Type
params	object
params.product?	string

Returns

Promise<RecommendedProductsQuery>

getShop()

getShop(): Promise<Shop>

Returns

Promise<Shop>

getSitemap()

getSitemap(): Promise<SitemapQuery>

Returns

Promise<SitemapQuery>

getUser()

getUser(): null | User

Returns

null | User

loginUsernamePassword()

loginUsernamePassword(__namedParameters): Promise<string>

Parameters

Parameter	Type
__namedParameters	object
__namedParameters.password	string
__namedParameters.username	string

Returns

Promise<string>

predictiveSearch()

predictiveSearch(params): Promise<PredictiveSearchQuery>

Parameters

Parameter	Type
params	object
params.limit	number
params.limitScope	string
params.searchTerm	string
params.types	( | "ARTICLE" | "COLLECTION" | "PAGE" | "PRODUCT" | "QUERY")[]

Returns

Promise<PredictiveSearchQuery>

removeCartLines()

removeCartLines(lineIds): Promise<Cart>

Parameters

Parameter	Type
lineIds	string[]

Returns

Promise<Cart>

search()

search(params): Promise<SearchQuery>

Parameters

Parameter	Type
params	object
params.endCursor?	string
params.first?	number
params.last?	number
params.query?	string
params.startCursor?	string

Returns

Promise<SearchQuery>

updateAddress()

updateAddress(args): Promise<Customer>

Parameters

Parameter	Type
args	object
args.address	MailingAddress
args.addressId	string
args.defaultAddress	boolean

Returns

Promise<Customer>

updateBuyerIdentity()

updateBuyerIdentity(params): Promise<Cart>

Parameters

Parameter	Type
params	CartBuyerIdentity

Returns

Promise<Cart>

updateCartLines()

updateCartLines(lines): Promise<Cart>

Parameters

Parameter	Type
lines	CartLine[]

Returns

Promise<Cart>

updateCustomer()

updateCustomer(customer): Promise<Customer>

Parameters

Parameter	Type
customer	CustomerUpdateInput

Returns

Promise<Customer>

updateDiscountCodes()

updateDiscountCodes(discountCodes): Promise<Cart>

Parameters

Parameter	Type
discountCodes	string[]

Returns

Promise<Cart>

---

PredictiveSearchQuery

type PredictiveSearchQuery: object;

Type declaration

Name	Type
predictiveSearch	object
predictiveSearch.articles	Pick<Article, "id" | "title" | "handle" | "trackingParameters"> & object[]
predictiveSearch.collections	Pick<Category, "id" | "title" | "handle" | "trackingParameters"> & object[]
predictiveSearch.pages	Pick<Page, "id" | "title" | "handle" | "trackingParameters">[]
predictiveSearch.products	Product[]
predictiveSearch.queries	Pick<SearchQuerySuggestion, "text" | "styledText" | "trackingParameters">[]

---

SearchQuery

type SearchQuery: object;

Type declaration

Name	Type
articles	object
articles.nodes	Pick<Article, "handle" | "id" | "title" | "trackingParameters">[]
pages	object
pages.nodes	Pick<Page, "handle" | "id" | "title" | "trackingParameters">[]
products	object
products.nodes	Product[]
products.pageInfo	Pick<PageInfo, | "total" | "hasNextPage" | "hasPreviousPage" | "startCursor" | "endCursor">

---

SearchQuerySuggestion

type SearchQuerySuggestion: object;

A search query suggestion.

Type declaration

Name	Type
styledText	string
text	string
trackingParameters	string

---

SitemapQuery

type SitemapQuery: object;

Type declaration

Name	Type
collections	object
collections.nodes	Pick<Category, "updatedAt" | "handle" | "onlineStoreUrl">[]
pages	object
pages.nodes	Pick<Page, "updatedAt" | "handle" | "onlineStoreUrl">[]
products	object
products.nodes	Pick<Product, "updatedAt" | "handle" | "onlineStoreUrl" | "title"> & object[]