Skip to main content

32 docs tagged with "api"

View all tags

appInfo

Fetch store information (branding, settings) via the getAppInfo query.

cartAddItem

Adds an item to the cart via the addToCart mutation.

cartApplyCode

Apply a discount code to the cart and return the updated totals/items.

cartBuyNow

Creates a fast cart/session for a single product and returns checkout URL/encryption key.

cartRemoveItem

Removes a cart line item by ID and returns the updated cart.

cartUpdateItem

Updates the quantity of an existing cart line item and returns the refreshed cart snapshot.

checkout

Fetch the current cart (items, totals, coupon state) during checkout.

checkoutToken

Generates an encryption key + checkout URL for a prepared cart/session.

collectionProducts

Returns paginated products belonging to a collection identified by its handle.

collections

Returns a paginated list of collections with basic fields.

customerLogin

Starts a customer session (OTP/login link/etc.) and returns a token.

customerSignUp

Registers a new customer account (or completes signup) and returns an auth token.

customerVerifyOtp

Verifies the OTP sent during customer login/signup and returns an access token.

orderConfirmOtp

Confirms an order-related OTP (e.g., COD or phone verification) and returns a token.

orderCreate

Creates an order from submitted checkout data (shipping, payment, line items).

orderKey

Resolve an order by a one-time order key, returning the order and related app info.

productById

Returns a single product by its ID, including variants, options, images, collections, SEO, and pricing.

productPrice

Resolves the final price for a product/variant + quantity, including totals and savings.

products

Returns a paginated list of products with variants, options, images, collections, SEO, and pricing.

reviewCreate

Submits a review for an order and its products, including shipping rating.

wishlistAddItem

Adds a product to the shopper's wishlist (session or account based).

wishlistRemoveItem

Removes a product entry from the shopper's wishlist and returns the updated list.

wishlists

Returns wishlists for a given session/account, including nested product details.