Storefronts API

66 API operations were detected for the current release. Operations are grouped by the first stable resource in their path so related requests are easier to find.

How to Read This Reference

A value in braces, such as {project_id}, must be inserted into the endpoint path.
A field ending in ? is optional according to the detected request schema.
JSON body lists fields sent in the request body.
Query parameters lists values appended after ? in the URL.
When request details are not specified, the current release metadata does not provide enough information to publish them safely.

Resource Summary

Resource	Operations
Authentication	1
Cart	8
Categories	1
Checkout	16
Domain access	1
Service status	1
On-site events	2
Product reviews	3
Products	5
Returns	4
Subscriptions	2
Customer account	11
Wishlist	5
Invitations	2
Social authentication	3
Email verification	1

Authentication

Method	Endpoint	Request information
`POST`	`/__runtime/auth/resend-verification-code`	Request data read: headers

Cart

Method	Endpoint	Request information
`GET`	`/__runtime/cart`	Query parameters: `RuntimeCartProjectQuery` (`project_id?`) Request data read: headers
`POST`	`/__runtime/cart/buy-now`	JSON body: `CartItemAddRequest` (`product_id`, `variant_id?`, `variant_sku?`, `variant_label?`, `variant_attributes?`, `quantity?`) Query parameters: `RuntimeCartProjectQuery` (`project_id?`) Request data read: headers
`POST`	`/__runtime/cart/clear`	Query parameters: `RuntimeCartProjectQuery` (`project_id?`) Request data read: headers
`POST`	`/__runtime/cart/coupons`	JSON body: `ApplyCouponRequest` (`code`) Query parameters: `RuntimeCartProjectQuery` (`project_id?`) Request data read: headers
`DELETE`	`/__runtime/cart/coupons/{code}`	Path parameters: `code` Query parameters: `RuntimeCartProjectQuery` (`project_id?`) Request data read: headers
`POST`	`/__runtime/cart/items`	JSON body: `CartItemAddRequest` (`product_id`, `variant_id?`, `variant_sku?`, `variant_label?`, `variant_attributes?`, `quantity?`) Query parameters: `RuntimeCartProjectQuery` (`project_id?`) Request data read: headers
`DELETE`	`/__runtime/cart/items/{item_id}`	Path parameters: `item_id` Query parameters: `RuntimeCartProjectQuery` (`project_id?`) Request data read: headers
`PATCH`	`/__runtime/cart/items/{item_id}`	Path parameters: `item_id` JSON body: `CartItemUpdateRequest` (`quantity`) Query parameters: `RuntimeCartProjectQuery` (`project_id?`) Request data read: headers

Method	Endpoint	Request information
`POST`	`/__runtime/categories/carousels`	JSON body: `RuntimeCategoryCarouselsRequest` (`project_id?`, `offset?`, `limit?`, `products_limit?`, `product_type?`, `category_key?`, `order?`, `category_slug?`, `category_slugs`, `category_ids`, `exclude_product_ids`, `product_item_code?`, ...)

Checkout

Method	Endpoint	Request information
`GET`	`/__runtime/checkout/addresses`	Request data read: headers
`POST`	`/__runtime/checkout/addresses`	JSON body: `SaveAddressRequest` (`label?`, `street`, `city`, `state`, `zip`, `country`, `phone?`, `is_default?`) Request data read: headers
`DELETE`	`/__runtime/checkout/addresses/{id}`	Path parameters: `id` Request data read: headers
`PATCH`	`/__runtime/checkout/addresses/{id}`	Path parameters: `id` JSON body: `SaveAddressRequest` (`label?`, `street`, `city`, `state`, `zip`, `country`, `phone?`, `is_default?`) Request data read: headers
`GET`	`/__runtime/checkout/cards`	Request data read: headers
`GET`	`/__runtime/checkout/guest-email-exists`	Query parameters: key/value map
`GET`	`/__runtime/checkout/locations/cities`	Query parameters: `CheckoutLocationQuery` (`country?`, `state?`, `city?`)
`GET`	`/__runtime/checkout/locations/countries`	Request details are not specified in the current route metadata.
`GET`	`/__runtime/checkout/locations/postal-codes`	Query parameters: `CheckoutLocationQuery` (`country?`, `state?`, `city?`)
`GET`	`/__runtime/checkout/locations/resolve`	Query parameters: `CheckoutLocationQuery` (`country?`, `state?`, `city?`)
`GET`	`/__runtime/checkout/locations/states`	Query parameters: `CheckoutLocationQuery` (`country?`, `state?`, `city?`)
`POST`	`/__runtime/checkout/order`	Request data read: headers
`GET`	`/__runtime/checkout/payment_return_popup`	Query parameters: key/value map
`POST`	`/__runtime/checkout/stripe/intent`	Request data read: headers
`POST`	`/__runtime/checkout/stripe/session`	Request data read: headers
`POST`	`/__runtime/checkout/summary`	JSON body: `CheckoutSummaryRequest` (`shipping_address?`, `billing_address?`, `shipping_method?`, `buy_now_item_id?`, `subscription_id?`, `interval?`, `current_subscription_id?`) Query parameters: key/value map Request data read: headers

Domain access

Method	Endpoint	Request information
`GET`	`/__runtime/domain/allow`	Query parameters: key/value map

Service status

Method	Endpoint	Request information
`GET`	`/__runtime/heartbeat`	Request details are not specified in the current route metadata.

On-site events

Method	Endpoint	Request information
`POST`	`/__runtime/onsite/events`	Request data read: headers
`GET`	`/__runtime/onsite/snippet.js`	Query parameters: key/value map Request data read: headers

Product reviews

Method	Endpoint	Request information
`GET`	`/__runtime/product-reviews`	Query parameters: `ProductReviewsQuery` (`product_id?`, `product_slug?`, `page?`, `page_size?`)
`POST`	`/__runtime/product-reviews`	JSON body: `ProductReviewCreateRequest` (`product_id?`, `product_slug?`, `reviewer_name?`, `reviewer_email?`, `title?`, `body?`, `image_url?`, `ratings?`) Request data read: headers
`POST`	`/__runtime/product-reviews/upload-image`	Request details are not specified in the current route metadata.

Products

Method	Endpoint	Request information
`POST`	`/__runtime/products`	JSON body: `RuntimeProductsRequest` (`project_id`, `extension_id?`, `page?`, `page_size?`, `page_items_limit?`, `q?`, `sort?`, `direction?`, `filters`, `path?`, `query?`)
`POST`	`/__runtime/products/search`	JSON body: `RuntimeProductsRequest` (`project_id`, `extension_id?`, `page?`, `page_size?`, `page_items_limit?`, `q?`, `sort?`, `direction?`, `filters`, `path?`, `query?`)
`DELETE`	`/__runtime/products/search/recent`	Query parameters: `RuntimeSearchRecentsListQuery` (`project_id`, `limit?`) Request data read: headers
`GET`	`/__runtime/products/search/recent`	Query parameters: `RuntimeSearchRecentsListQuery` (`project_id`, `limit?`) Request data read: headers
`POST`	`/__runtime/products/search/recent`	JSON body: `RuntimeSearchRecentsUpsertRequest` (`project_id`, `query`) Request data read: headers

Returns

Method	Endpoint	Request information
`POST`	`/__runtime/rma/attachment`	Request details are not specified in the current route metadata.
`POST`	`/__runtime/rma/create`	JSON body: `RuntimeRmaPublicCreateRequest` (`project_id`, `order_number`, `order_item_id`, `requested_qty?`, `reason?`, `description?`, `email?`) Request data read: headers
`GET`	`/__runtime/rma/order-items`	Query parameters: `RuntimeRmaOrderLookupQuery` (`project_id`, `order_number`, `email?`) Request data read: headers
`GET`	`/__runtime/rma/orders`	Query parameters: `RuntimeRmaOrdersQuery` (`project_id`) Request data read: headers

Subscriptions

Method	Endpoint	Request information
`GET`	`/__runtime/subscription/free_trial/hash`	Query parameters: key/value map Request data read: headers
`GET`	`/__runtime/subscriptions/trials`	Request details are not specified in the current route metadata.

Customer account

Method	Endpoint	Request information
`GET`	`/__runtime/user-profile.json`	Request data read: headers
`GET`	`/__runtime/user/rma`	Query parameters: `RuntimeRmaListQuery` (`project_id`, `page?`, `per_page?`, `q?`) Request data read: headers
`POST`	`/__runtime/user/rma`	JSON body: `RuntimeRmaCreateRequest` (`project_id`, `order_number`, `order_item_id`, `requested_qty?`, `reason?`, `description?`) Request data read: headers
`GET`	`/__runtime/user/rma/{rma_number}`	Path parameters: `rma_number` Query parameters: `RuntimeRmaListQuery` (`project_id`, `page?`, `per_page?`, `q?`) Request data read: headers
`GET`	`/__runtime/user/rma/{rma_number}/messages`	Path parameters: `rma_number` Query parameters: `RuntimeRmaListQuery` (`project_id`, `page?`, `per_page?`, `q?`) Request data read: headers
`POST`	`/__runtime/user/rma/{rma_number}/messages`	Path parameters: `rma_number` JSON body: `RuntimeRmaMessagePayload` (`body`, `attachments`) Query parameters: `RuntimeRmaListQuery` (`project_id`, `page?`, `per_page?`, `q?`) Request data read: headers
`POST`	`/__runtime/user/subscription/cancel`	JSON body: `SubscriptionRefundRequest` (`subscription_id`) Request data read: headers
`POST`	`/__runtime/user/subscription/reactivate`	JSON body: `SubscriptionRefundRequest` (`subscription_id`) Request data read: headers
`POST`	`/__runtime/user/subscription/refund/confirm`	JSON body: `SubscriptionRefundRequest` (`subscription_id`) Request data read: headers
`POST`	`/__runtime/user/subscription/refund/preview`	JSON body: `SubscriptionRefundRequest` (`subscription_id`) Request data read: headers
`GET`	`/__runtime/user/tab`	Request data read: headers

Wishlist

Method	Endpoint	Request information
`GET`	`/__runtime/wishlist`	Query parameters: `RuntimeWishlistListQuery` (`project_id`, `limit?`, `product_item_code?`) Request data read: headers
`POST`	`/__runtime/wishlist`	JSON body: `RuntimeWishlistListQuery` (`project_id`, `limit?`, `product_item_code?`) Request data read: headers
`POST`	`/__runtime/wishlist/items`	JSON body: `RuntimeWishlistItemRequest` (`project_id`, `product_id`, `variant_id?`, `variant_sku?`, `variant_label?`, `variant_attributes?`, `product_item_code?`) Request data read: headers
`DELETE`	`/__runtime/wishlist/items/{product_id}`	Path parameters: `product_id` Query parameters: `RuntimeWishlistDeleteQuery` (`project_id`, `variant_id?`, `variant_sku?`, `variant_attributes?`) Request data read: headers
`POST`	`/__runtime/wishlist/items/toggle`	JSON body: `RuntimeWishlistItemRequest` (`project_id`, `product_id`, `variant_id?`, `variant_sku?`, `variant_label?`, `variant_attributes?`, `product_item_code?`) Request data read: headers

Invitations

Method	Endpoint	Request information
`POST`	`/accept-invite`	Request details are not specified in the current route metadata.
`GET`	`/accept-invite/{token}`	Path parameters: `token`

Method	Endpoint	Request information
`GET`	`/auth/{provider}`	Path parameters: `provider` Query parameters: key/value map
`GET`	`/auth/{provider}/callback`	Path parameters: `provider` Query parameters: key/value map Request data read: headers
`GET`	`/auth/social/handoff`	Query parameters: key/value map

Email verification

Method	Endpoint	Request information
`GET`	`/verify-email`	Query parameters: key/value map

Reference Coverage

Request body, query, path, header, cookie, and session information is shown only when it can be detected from current route, spec, schema, or test metadata. Response fields, pagination behavior, sorting, filtering, and error mappings are omitted when that metadata is unavailable.