Skip to content

Extensions API

190 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

ResourceOperations
Commerce extension162
Blog extension28

Commerce extension

MethodOperationDescriptionRequest information
GETList Cart
/__runtime/cart
Returns the current storefront cart for the resolved project, creating a guest cart when none exists.Query parameters: RuntimeCartProjectQuery (project_id?)
Authentication: API key
Request data read: headers, cookies, host
POSTStart buy now cart
/__runtime/cart/buy-now
Adds an item to the cart and returns a checkout URL for an immediate purchase.JSON body: CartItemAddRequest (product_id, variant_id?, variant_sku?, variant_label?, variant_attributes?, quantity?)
Query parameters: RuntimeCartProjectQuery (project_id?)
Authentication: API key
Request data read: headers, cookies, host
POSTClear Cart
/__runtime/cart/clear
Removes all items from the storefront cart and returns the empty cart.Query parameters: RuntimeCartProjectQuery (project_id?)
Authentication: API key
Request data read: headers, cookies, host
POSTCreate Coupon
/__runtime/cart/coupons
Applies a coupon code to the storefront cart and returns the updated cart with its discount.JSON body: ApplyCouponRequest (code)
Query parameters: RuntimeCartProjectQuery (project_id?)
Authentication: API key
Request data read: headers, cookies, host
DELETEDelete Coupon
/__runtime/cart/coupons/{code}
Removes a coupon code from the storefront cart and returns the updated cart.Path parameters: code
Query parameters: RuntimeCartProjectQuery (project_id?)
Authentication: API key
Request data read: headers, cookies, host
POSTCreate Cart Item
/__runtime/cart/items
Adds a product and optional variant to the storefront cart and returns the updated cart.JSON body: CartItemAddRequest (product_id, variant_id?, variant_sku?, variant_label?, variant_attributes?, quantity?)
Query parameters: RuntimeCartProjectQuery (project_id?)
Authentication: API key
Request data read: headers, cookies, host
DELETEDelete Cart Item
/__runtime/cart/items/{item_id}
Removes an item from the storefront cart and returns the updated cart.Path parameters: item_id
Query parameters: RuntimeCartProjectQuery (project_id?)
Authentication: API key
Request data read: headers, cookies, host
PATCHUpdate Cart Item
/__runtime/cart/items/{item_id}
Updates a cart item's quantity, removing it when the quantity is zero, and returns the updated cart.Path parameters: item_id
JSON body: CartItemUpdateRequest (quantity)
Query parameters: RuntimeCartProjectQuery (project_id?)
Authentication: API key
Request data read: headers, cookies, host
POSTCreate Carousel
/__runtime/categories/carousels
Lists storefront category carousels with rendered product HTML for a project or host.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?, featured_product_item_code?, product_item_codes?, featured_product_item_codes?)
Request data read: host
GETList Checkout Addresses
/__runtime/checkout/addresses
Lists the signed-in customer's saved shipping addresses for a storefront project.Request data read: headers, host
POSTCreate Checkout Address
/__runtime/checkout/addresses
Saves a new shipping address for the signed-in customer of a storefront project.JSON body: SaveAddressRequest (label?, street, city, state, zip, country, phone?, is_default?)
Request data read: headers, host
DELETEDelete Checkout Address
/__runtime/checkout/addresses/{id}
Deletes one of the signed-in customer's saved shipping addresses for a storefront project.Path parameters: id
Request data read: headers, host
PATCHUpdate Checkout Address
/__runtime/checkout/addresses/{id}
Updates one of the signed-in customer's saved shipping addresses for a storefront project.Path parameters: id
JSON body: SaveAddressRequest (label?, street, city, state, zip, country, phone?, is_default?)
Request data read: headers, host
GETList Checkout
/__runtime/checkout/cards
Lists the signed-in customer's saved payment cards for a storefront project, returning an empty list for guests.Request data read: headers, host
GETList Guest Email Exists
/__runtime/checkout/guest-email-exists
Checks whether an email already belongs to a customer of a storefront project, optionally creating and sending an invitation.Query parameters: key/value map
Request data read: host
GETList Cities
/__runtime/checkout/locations/cities
Lists the cities for a country and state used in storefront checkout address selection.Query parameters: CheckoutLocationQuery (country?, state?, city?)
GETList Countries
/__runtime/checkout/locations/countries
Lists the countries available for storefront checkout address selection.Request details are not specified in the current route metadata.
GETList Postal Codes
/__runtime/checkout/locations/postal-codes
Lists the postal codes for a city used in storefront checkout address selection.Query parameters: CheckoutLocationQuery (country?, state?, city?)
GETResolve Checkout Location
/__runtime/checkout/locations/resolve
Resolves which states contain a given city for storefront checkout address selection.Query parameters: CheckoutLocationQuery (country?, state?, city?)
GETList States
/__runtime/checkout/locations/states
Lists the states or regions for a country used in storefront checkout address selection.Query parameters: CheckoutLocationQuery (country?, state?, city?)
POSTCreate Checkout
/__runtime/checkout/order
Finalizes a storefront checkout on the project host and creates or completes a sales order from the active cart.Request data read: headers, host
GETGet payment return popup
/__runtime/checkout/payment_return_popup
Renders the HTML popup that reports a completed payment to the opener window and then closes itself.Query parameters: key/value map
POSTCreate Stripe intent
/__runtime/checkout/stripe/intent
Creates a Stripe PaymentIntent for a storefront cart and returns the client secret used to confirm payment.Request data read: headers, host
POSTCreate Stripe Session
/__runtime/checkout/stripe/session
Creates a Stripe Checkout session for a storefront cart and returns the redirect URL.JSON body: key/value map
Request data read: headers, cookies, host
POSTGet Checkout
/__runtime/checkout/summary
Computes the checkout summary for a storefront host, returning cart subtotal, discounts, shipping, tax, and total, or the price change for a subscription upgrade.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, cookies, host
GETCheck Domain
/__runtime/domain/allow
Checks whether a host or domain is present in the server's allowed custom-domain list.Query parameters: key/value map
GETList Product Reviews
/__runtime/product-reviews
Lists approved product reviews for a storefront product with rating summaries and purchase verification.Query parameters: ProductReviewsQuery (product_id?, product_slug?, page?, page_size?)
Request data read: host
POSTCreate Product Review
/__runtime/product-reviews
Creates a product review for a storefront product, optionally attributing it to the authenticated storefront user.JSON body: ProductReviewCreateRequest (product_id?, product_slug?, reviewer_name?, reviewer_email?, title?, body?, image_url?, ratings?)
Request data read: headers, host
POSTUpload Product Review image
/__runtime/product-reviews/upload-image
Uploads a product review image for the storefront resolved from the request Host and returns the stored image URL.Request data read: host
POSTLoad storefront product grid
/__runtime/products
Renders the storefront product listing HTML for a project, applying category filters and pagination.JSON body: RuntimeProductsRequest (project_id, extension_id?, page?, page_size?, page_items_limit?, q?, sort?, direction?, filters?, path?, query?)
POSTSearch storefront products
/__runtime/products/search
Searches the products and pages of a project for the storefront search UI and returns matching products plus page results.JSON body: RuntimeProductsRequest (project_id, extension_id?, page?, page_size?, page_items_limit?, q?, sort?, direction?, filters?, path?, query?)
DELETEDelete recent searches
/__runtime/products/search/recent
Clears the stored recent product-search terms for the current actor identity in a project.Query parameters: RuntimeSearchRecentsListQuery (project_id, limit?)
Request data read: headers
GETList recent searches
/__runtime/products/search/recent
Lists the recent product-search terms stored for the current actor identity in a project.Query parameters: RuntimeSearchRecentsListQuery (project_id, limit?)
Request data read: headers
POSTSave recent search
/__runtime/products/search/recent
Records a product-search term for the current actor identity in a project and returns the updated recent-search list.JSON body: RuntimeSearchRecentsUpsertRequest (project_id, query)
Request data read: headers
POSTUpload RMA
/__runtime/rma/attachment
Uploads an RMA attachment image for the project identified by the multipart project_id and returns the stored file URL.Request details are not specified in the current route metadata.
POSTCreate Create
/__runtime/rma/create
Creates a public return (RMA) request for an order item, supporting guest submissions validated by email.JSON body: RuntimeRmaPublicCreateRequest (project_id, order_number, order_item_id, requested_qty?, reason?, description?, email?)
Request data read: headers
GETList Order Items
/__runtime/rma/order-items
Looks up an order's return-eligible items by order number for the authenticated customer or a supplied guest email.Query parameters: RuntimeRmaOrderLookupQuery (project_id, order_number, email?)
Request data read: headers
GETList Orders
/__runtime/rma/orders
Lists the authenticated customer's orders with return (RMA) eligibility for a project.Query parameters: RuntimeRmaOrdersQuery (project_id)
Request data read: headers
GETGet Free Trial Hash
/__runtime/subscription/free_trial/hash
Evaluates free-trial eligibility for a storefront subscription and returns a claim hash, redirect, or ineligibility reason.Query parameters: key/value map
Request data read: headers, host
GETList Subscriptions
/__runtime/subscriptions/trials
Lists the storefront subscriptions that offer a free trial for the project resolved from the request host.Request data read: host
GETList RMA
/__runtime/user/rma
Lists the authenticated customer's return (RMA) requests with pagination and optional search.Query parameters: RuntimeRmaListQuery (project_id, page?, per_page?, q?)
Request data read: headers
POSTCreate RMA
/__runtime/user/rma
Creates a return (RMA) request for the authenticated customer's order item.JSON body: RuntimeRmaCreateRequest (project_id, order_number, order_item_id, requested_qty?, reason?, description?)
Request data read: headers
GETGet RMA
/__runtime/user/rma/{rma_number}
Returns the details of one of the authenticated customer's return (RMA) requests.Path parameters: rma_number
Query parameters: RuntimeRmaListQuery (project_id, page?, per_page?, q?)
Request data read: headers
GETList RMA Messages
/__runtime/user/rma/{rma_number}/messages
Lists the customer-visible messages for one of the authenticated customer's return (RMA) requests.Path parameters: rma_number
Query parameters: RuntimeRmaListQuery (project_id, page?, per_page?, q?)
Request data read: headers
POSTCreate RMA Message
/__runtime/user/rma/{rma_number}/messages
Appends a customer message, up to five uploaded RMA attachments, or both to the signed-in customer's return request, then returns the updated message thread.Path parameters: rma_number
JSON body: RuntimeRmaMessagePayload (body?, attachments?)
Query parameters: RuntimeRmaListQuery (project_id, page?, per_page?, q?)
Request data read: headers
POSTCancel Subscription
/__runtime/user/subscription/cancel
Cancels a storefront customer's subscription at the next billing cycle and dispatches a commerce subscription-cancelled webhook.JSON body: SubscriptionRefundRequest (subscription_id)
Request data read: headers, host
POSTReactivate Subscription
/__runtime/user/subscription/reactivate
Reactivates a storefront customer's subscription and dispatches a commerce subscription-updated webhook.JSON body: SubscriptionRefundRequest (subscription_id)
Request data read: headers, host
POSTConfirm Refund
/__runtime/user/subscription/refund/confirm
Confirms and processes a Stripe refund for a storefront customer's eligible subscription, returning the refund outcome.JSON body: SubscriptionRefundRequest (subscription_id)
Request data read: headers, host
POSTPreview Refund
/__runtime/user/subscription/refund/preview
Previews whether a storefront customer's subscription is eligible for a refund and the refund amount.JSON body: SubscriptionRefundRequest (subscription_id)
Request data read: headers, host
GETList Wishlist
/__runtime/wishlist
Lists the current wishlist entries for a storefront project, including per-variant keys and rendered product-card HTML.Query parameters: RuntimeWishlistListQuery (project_id, limit?, product_item_code?)
Request data read: headers
POSTCreate Wishlist
/__runtime/wishlist
Removes all items from the current shopper's storefront wishlist.JSON body: RuntimeWishlistListQuery (project_id, limit?, product_item_code?)
Request data read: headers
POSTCreate Wishlist Item
/__runtime/wishlist/items
Adds a product or variant to the current shopper's storefront wishlist.JSON body: RuntimeWishlistItemRequest (project_id, product_id, variant_id?, variant_sku?, variant_label?, variant_attributes?, product_item_code?)
Request data read: headers
DELETEDelete Wishlist Item
/__runtime/wishlist/items/{product_id}
Removes a product or variant from the current shopper's storefront wishlist.Path parameters: product_id
Query parameters: RuntimeWishlistDeleteQuery (project_id, variant_id?, variant_sku?, variant_attributes?)
Request data read: headers
POSTToggle Wishlist Item
/__runtime/wishlist/items/toggle
Toggles a product or variant in the current shopper's storefront wishlist.JSON body: RuntimeWishlistItemRequest (project_id, product_id, variant_id?, variant_sku?, variant_label?, variant_attributes?, product_item_code?)
Request data read: headers
GETList products
/api/projects/{project_id}/extensions/2/products
Lists products for a project extension, including draft products unless the request filters them out.Path parameters: project_id
Query parameters: PageParams (page?, page_size?, q?, sort?, direction?, include_drafts?, filters?)
POSTCreate product
/api/projects/{project_id}/extensions/2/products
Creates a product for a project extension from the submitted product JSON payload.Path parameters: project_id
JSON body: ProductWriteRequest (name?, slug?, price?, product_type?, category_slug?, description?, status?, is_draft?, categories?, media?, media_urls?, images?, attribute_values?, attributes?, variants?, group_items?, bundle_pricing_mode?, downloads?, virtual_services?, meta?, sku?, currency?, weight?, stock_quantity?, track_stock?, backorders?, require_shipping?)
DELETEDelete product
/api/projects/{project_id}/extensions/2/products/{product_id}
Deletes a product from a project extension.Path parameters: project_id, product_id
JSON body: PortfolioMediaBulkPayload (items?)
PUTUpdate product
/api/projects/{project_id}/extensions/2/products/{product_id}
Updates a product for a project extension from the submitted product JSON payload.Path parameters: project_id, product_id
JSON body: ProductWriteRequest (name?, slug?, price?, product_type?, category_slug?, description?, status?, is_draft?, categories?, media?, media_urls?, images?, attribute_values?, attributes?, variants?, group_items?, bundle_pricing_mode?, downloads?, virtual_services?, meta?, sku?, currency?, weight?, stock_quantity?, track_stock?, backorders?, require_shipping?)
GETList Coupons
/api/projects/{project_id}/sales/coupons
Lists all coupons for a project, newest first.Path parameters: project_id
POSTCreate Coupon
/api/projects/{project_id}/sales/coupons
Creates a coupon for a project from the submitted coupon payload and dispatches a coupon-created event.Path parameters: project_id
JSON body: CouponPayload (code, discount_type?, amount, target_scope?, allow_stack?, max_uses?, max_uses_per_customer?, starts_at?, ends_at?, is_active?)
DELETEDelete Coupon
/api/projects/{project_id}/sales/coupons/{coupon_id}
Deletes a project coupon by id and dispatches a coupon-deleted event.Path parameters: project_id, coupon_id
GETGet Coupon
/api/projects/{project_id}/sales/coupons/{coupon_id}
Returns a single coupon by id for a project.Path parameters: project_id, coupon_id
PATCHUpdate Coupon
/api/projects/{project_id}/sales/coupons/{coupon_id}
Updates a project coupon from the submitted coupon payload and dispatches a coupon-updated event.Path parameters: project_id, coupon_id
JSON body: CouponPayload (code, discount_type?, amount, target_scope?, allow_stack?, max_uses?, max_uses_per_customer?, starts_at?, ends_at?, is_active?)
GETList Invoices
/api/projects/{project_id}/sales/invoices
List invoices for a projectPath parameters: project_id
Query parameters: ListInvoicesQuery (page?, perPage)
GETGet Invoice
/api/projects/{project_id}/sales/invoices/{invoice_id}
Get invoice detailPath parameters: project_id, invoice_id
GETList Cities
/api/projects/{project_id}/sales/locations/cities
Lists cities for the requested state ids.Path parameters: project_id
Query parameters: LocationCitiesQuery (state_ids?, page?, per_page?, q?)
GETList Countries
/api/projects/{project_id}/sales/locations/countries
Lists countries available for project location selection.Path parameters: project_id
Query parameters: LocationCountriesQuery (page?, per_page?, q?)
GETList Postal Codes
/api/projects/{project_id}/sales/locations/postal-codes
Lists postal codes for the requested city ids.Path parameters: project_id
Query parameters: LocationPostalQuery (city_ids?, page?, per_page?, q?)
GETList Postal Lookup
/api/projects/{project_id}/sales/locations/postal-lookup
Reverse lookup against the existing location tables; exact postal code only.Path parameters: project_id
Query parameters: PostalLookupQuery (country)
GETList States
/api/projects/{project_id}/sales/locations/states
Lists states or regions filtered by the requested country codes.Path parameters: project_id
Query parameters: LocationStatesQuery (countries?, page?, per_page?, q?)
GETList Orders
/api/projects/{project_id}/sales/orders
List orders for a projectPath parameters: project_id
Query parameters: ListOrdersQuery (page?, perPage, q?, sort?, filters)
POSTCreate Order
/api/projects/{project_id}/sales/orders
Create new orderPath parameters: project_id
JSON body: CreateOrderRequest
GETGet Order
/api/projects/{project_id}/sales/orders/{order_id}
Get order detailPath parameters: project_id, order_id
PATCHUpdate Order
/api/projects/{project_id}/sales/orders/{order_id}
Update orderPath parameters: project_id, order_id
JSON body: UpdateOrderRequest
GETList Order Events
/api/projects/{project_id}/sales/orders/{order_id}/events
Get order events/timelinePath parameters: project_id, order_id
POSTHold Order
/api/projects/{project_id}/sales/orders/{order_id}/hold
Hold/unhold orderPath parameters: project_id, order_id
JSON body: HoldOrderRequest
GETList Invoices
/api/projects/{project_id}/sales/orders/{order_id}/invoices
List invoices for a specific orderPath parameters: project_id, order_id
GETList Shipments
/api/projects/{project_id}/sales/orders/{order_id}/shipments
List shipments for a specific orderPath parameters: project_id, order_id
POSTCreate Shipment
/api/projects/{project_id}/sales/orders/{order_id}/shipments
Create shipment for orderPath parameters: project_id, order_id
JSON body: CreateShipmentRequest
POSTAuto-create Shipment
/api/projects/{project_id}/sales/orders/{order_id}/shipments/auto-create
Automatically creates a shipment for an order in the target project when the automation rules are met.Path parameters: project_id, order_id
POSTCheck Shipment Availability
/api/projects/{project_id}/sales/orders/{order_id}/shipments/can-create
Evaluates whether a shipment can be created for an order in the target project.Path parameters: project_id, order_id
JSON body: CanCreateShipmentRequest (shipment?, is_admin_approved?, is_stock_reserved?, trigger?)
GETList shipped quantities
/api/projects/{project_id}/sales/orders/{order_id}/shipped-quantities
Get shipped quantities for order itemsPath parameters: project_id, order_id
GETList Order Transactions
/api/projects/{project_id}/sales/orders/{order_id}/transactions
List transactions for a specific orderPath parameters: project_id, order_id
GETList Order Attributes
/api/projects/{project_id}/sales/orders/attributes
List order attributes for a projectPath parameters: project_id
POSTCreate Order Attribute
/api/projects/{project_id}/sales/orders/attributes
Create order attributePath parameters: project_id
JSON body: CreateOrderAttributeRequest (attribute_code, default_label, input_type, is_required?, default_value?, placeholder?, min_text_length?, max_text_length?, min_date?, max_date?, allowed_extensions?, max_file_size?, visible_on_frontend?, hidden_from_customer?, visible_on_backend?, customer_roles?, checkout_position?, sort_order?, save_for_future?, show_on_grids?, include_in_pdf?, include_in_emails?, options?, conditions?, is_active?)
DELETEDelete Order Attribute
/api/projects/{project_id}/sales/orders/attributes/{attribute_id}
Delete order attributePath parameters: project_id, attribute_id
GETGet Order Attribute
/api/projects/{project_id}/sales/orders/attributes/{attribute_id}
Get order attribute detailPath parameters: project_id, attribute_id
PATCHUpdate Order Attribute
/api/projects/{project_id}/sales/orders/attributes/{attribute_id}
Update order attributePath parameters: project_id, attribute_id
JSON body: UpdateOrderAttributeRequest (default_label?, input_type?, is_required?, default_value?, placeholder?, min_text_length?, max_text_length?, min_date?, max_date?, allowed_extensions?, max_file_size?, visible_on_frontend?, hidden_from_customer?, visible_on_backend?, customer_roles?, checkout_position?, sort_order?, save_for_future?, show_on_grids?, include_in_pdf?, include_in_emails?, options?, conditions?, is_active?)
GETList Shipments
/api/projects/{project_id}/sales/orders/shipments
List shipments for a projectPath parameters: project_id
Query parameters: ListShipmentsQuery (page?, perPage)
GETList Shipment Methods
/api/projects/{project_id}/sales/orders/shipments/methods
Lists the effective shipping methods for a project, merging system defaults with project overrides and custom methods.Path parameters: project_id
Query parameters: ListQuery (page?, per_page?, q?, filter?, raw_filters?)
POSTCreate Shipment Method
/api/projects/{project_id}/sales/orders/shipments/methods
Creates a project-scoped shipping method from the submitted carrier and method details.Path parameters: project_id
JSON body: UpsertShippingMethodRequest (carrier_code, carrier_label?, method_code, method_label, is_active?, sort_order?, meta?, use_default?)
DELETEDelete Shipment Method
/api/projects/{project_id}/sales/orders/shipments/methods/{method_id}
Deletes a project-scoped shipping method; system default methods cannot be deleted.Path parameters: project_id, method_id
PATCHUpdate Shipment Method
/api/projects/{project_id}/sales/orders/shipments/methods/{method_id}
Updates a project shipping method, creating a project override when the target is a system default.Path parameters: project_id, method_id
JSON body: UpsertShippingMethodRequest (carrier_code, carrier_label?, method_code, method_label, is_active?, sort_order?, meta?, use_default?)
GETList Shipment Methods Tree
/api/projects/{project_id}/sales/orders/shipments/methods/tree
Lists active shipping methods grouped by carrier for a project.Path parameters: project_id
GETList Shipment Rules
/api/projects/{project_id}/sales/orders/shipments/rules
Returns the resolved shipment automation rule settings for the target project.Path parameters: project_id
PUTUpdate Shipment Rule
/api/projects/{project_id}/sales/orders/shipments/rules
Updates the shipment automation rule settings for the target project and returns the resolved settings.Path parameters: project_id
JSON body: ShipmentRuleSettingsInput
GETList Payment Config
/api/projects/{project_id}/sales/payment-config
Get project payment configurationsPath parameters: project_id
GETList Payment Services
/api/projects/{project_id}/sales/payment-services
List all available payment servicesPath parameters: project_id
PATCHUpdate Payment Service
/api/projects/{project_id}/sales/payment-services/{service_id}
Creates or updates a project's payment service configuration (enablement, endpoint override, recurring flag, config, and connected account).Path parameters: project_id, service_id
JSON body: ProjectPaymentConfigUpdate (is_enabled?, endpoint_override?, recurring_enabled?, config?, connected_account_id?, disconnect_account?)
POSTUpdate Payment Service Platform Fees
/api/projects/{project_id}/sales/payment-services/{service_id}/platform-fees
Updates the platform fee configuration for a project payment service.Path parameters: project_id, service_id
JSON body: PaymentFeeRequest (platform_fee_percent?, platform_fee_fixed?)
GETList Account
/api/projects/{project_id}/sales/payment-services/{service_id}/stripe/account
Returns the connected Stripe account's details and migration status for a project payment service.Path parameters: project_id, service_id
POSTConnect Stripe
/api/projects/{project_id}/sales/payment-services/{service_id}/stripe/connect
Creates or reuses a merchant-owned Stripe Connect account for a project payment service and returns an onboarding link.Path parameters: project_id, service_id
JSON body: StripeConnectRequest (return_url, refresh_url)
GETGet Stripe Login Link
/api/projects/{project_id}/sales/payment-services/{service_id}/stripe/login-link
Returns a Stripe dashboard login link for the project's connected Stripe account.Path parameters: project_id, service_id
POSTComplete Migration
/api/projects/{project_id}/sales/payment-services/{service_id}/stripe/migration/complete
Completes a pending Stripe account migration by promoting the replacement account to active for a project payment service.Path parameters: project_id, service_id
GETList Platform Payment Settings
/api/projects/{project_id}/sales/platform-payment-settings
Returns the project's platform payment fee settings.Path parameters: project_id
POSTCreate Platform Payment Setting
/api/projects/{project_id}/sales/platform-payment-settings
Updates the project's platform payment fee settings.Path parameters: project_id
JSON body: PlatformPaymentSettingsRequest (platform_fee_percent?, platform_fee_fixed?)
GETSearch catalog products
/api/projects/{project_id}/sales/products/search
Search products from ext2_products tablePath parameters: project_id
Query parameters: ProductSearchQuery (q?, limit?, offset?)
GETList RMA Addresses
/api/projects/{project_id}/sales/rma/addresses
Lists a project's RMA return addresses, with the default address first.Path parameters: project_id
POSTCreate RMA Address
/api/projects/{project_id}/sales/rma/addresses
Creates an RMA return address for a project and dispatches a commerce location-created webhook.Path parameters: project_id
JSON body: ReturnAddressPayload (label?, contact_name?, company?, phone?, email?, line1, line2?, city, region?, postal_code, country_code, is_default?, ...)
DELETEDelete RMA Address
/api/projects/{project_id}/sales/rma/addresses/{address_id}
Deletes an RMA return address for a project and dispatches a commerce location-deleted webhook.Path parameters: project_id, address_id
PATCHUpdate RMA Address
/api/projects/{project_id}/sales/rma/addresses/{address_id}
Updates an existing RMA return address for a project and dispatches a commerce location-updated webhook.Path parameters: project_id, address_id
JSON body: ReturnAddressPayload (label?, contact_name?, company?, phone?, email?, line1, line2?, city, region?, postal_code, country_code, is_default?, ...)
GETList RMA Requests
/api/projects/{project_id}/sales/rma/requests
Lists a project's RMA return requests with pagination, text search, status filtering, and sorting.Path parameters: project_id
Query parameters: ListRmaRequestsQuery (page?, per_page?, q?, sort?, filters?)
GETGet RMA Request
/api/projects/{project_id}/sales/rma/requests/{rma_id}
Returns a single RMA return request belonging to a project.Path parameters: project_id, rma_id
PATCHUpdate RMA Request
/api/projects/{project_id}/sales/rma/requests/{rma_id}
Updates an RMA return request's status, notes, return label, and return address, and dispatches return lifecycle webhooks.Path parameters: project_id, rma_id
JSON body: UpdateRmaRequestPayload (status?, admin_note?, resolution_note?, return_label_url?, return_tracking_number?, return_carrier?, return_address_id?, return_address_json?, requested_info_message?, customer_reply?)
GETList Request Messages
/api/projects/{project_id}/sales/rma/requests/{rma_id}/messages
Lists the message thread for an RMA return request in a project.Path parameters: project_id, rma_id
POSTCreate Request Message
/api/projects/{project_id}/sales/rma/requests/{rma_id}/messages
Adds an admin message to an RMA return request in a project and returns the updated message thread.Path parameters: project_id, rma_id
JSON body: RmaMessagePayload (body?, attachments?)
GETList RMA Settings
/api/projects/{project_id}/sales/rma/settings
Returns a project's returns (RMA) configuration and return addresses, creating the default settings row on first access.Path parameters: project_id
PUTUpdate RMA Setting
/api/projects/{project_id}/sales/rma/settings
Updates a project's returns (RMA) configuration, including the return window, approval behavior, allowed statuses, and default return address.Path parameters: project_id
JSON body: RmaSettingsPayload (enabled?, return_window_days?, require_approval?, allow_more_info?, auto_approve?, allowed_statuses?, default_return_address_id?)
GETList Shipment Restrictions
/api/projects/{project_id}/sales/shipment-restrictions
Lists the shipment restrictions configured for a project, newest first, with pagination.Path parameters: project_id
Query parameters: ListRestrictionsQuery (page?, perPage)
POSTCreate Shipment Restriction
/api/projects/{project_id}/sales/shipment-restrictions
Creates a shipment restriction for a project from the supplied configuration and returns the created record.Path parameters: project_id
JSON body: UpsertShipmentRestrictionRequest (name?, description?, is_active?, restricted_carriers?, restricted_methods?, show_message?, restriction_message?, show_message_once?, conditions?, admin_area_only?, customer_roles?, days_of_week?, time_from?, time_to?, apply_with_coupon_codes?, apply_with_cart_rules?, do_not_apply_with_coupon_codes?, do_not_apply_with_cart_rules?)
DELETEDelete Shipment Restriction
/api/projects/{project_id}/sales/shipment-restrictions/{restriction_id}
Deletes a shipment restriction from a project.Path parameters: project_id, restriction_id
GETGet Shipment Restriction
/api/projects/{project_id}/sales/shipment-restrictions/{restriction_id}
Returns a single shipment restriction for a project by id.Path parameters: project_id, restriction_id
PATCHUpdate Shipment Restriction
/api/projects/{project_id}/sales/shipment-restrictions/{restriction_id}
Updates an existing shipment restriction for a project from the supplied configuration and returns the updated record.Path parameters: project_id, restriction_id
JSON body: UpsertShipmentRestrictionRequest (name?, description?, is_active?, restricted_carriers?, restricted_methods?, show_message?, restriction_message?, show_message_once?, conditions?, admin_area_only?, customer_roles?, days_of_week?, time_from?, time_to?, apply_with_coupon_codes?, apply_with_cart_rules?, do_not_apply_with_coupon_codes?, do_not_apply_with_cart_rules?)
GETList Shipment Rules
/api/projects/{project_id}/sales/shipment-rules
Lists the shipment rate rules configured for a project.Path parameters: project_id
Query parameters: ListRulesQuery (page?, perPage)
POSTCreate Shipment Rule
/api/projects/{project_id}/sales/shipment-rules
Creates a shipment rate rule for a project.Path parameters: project_id
JSON body: UpsertShipmentRuleRequest (name?, description?, is_active?, priority?, discard_subsequent?, shipping_carriers?, shipping_methods?, ignore_free_shipping_promo?, calculation_type?, base_rate?, fixed_rate_per_product?, rate_per_unit_weight?, percentage_per_product?, handling_percentage?, rate_change_min?, rate_change_max?, total_rate_min?, total_rate_max?, conditions?, apply_to?, admin_area_only?, customer_roles?, days_of_week?, time_from?, time_to?, apply_with_coupon_codes?, apply_with_cart_rules?, do_not_apply_with_coupon_codes?, do_not_apply_with_cart_rules?)
DELETEDelete Shipment Rule
/api/projects/{project_id}/sales/shipment-rules/{rule_id}
Deletes a shipment rate rule from a project.Path parameters: project_id, rule_id
GETGet Shipment Rule
/api/projects/{project_id}/sales/shipment-rules/{rule_id}
Retrieves a single shipment rate rule by id within a project.Path parameters: project_id, rule_id
PATCHUpdate Shipment Rule
/api/projects/{project_id}/sales/shipment-rules/{rule_id}
Updates an existing shipment rate rule in a project.Path parameters: project_id, rule_id
JSON body: UpsertShipmentRuleRequest (name?, description?, is_active?, priority?, discard_subsequent?, shipping_carriers?, shipping_methods?, ignore_free_shipping_promo?, calculation_type?, base_rate?, fixed_rate_per_product?, rate_per_unit_weight?, percentage_per_product?, handling_percentage?, rate_change_min?, rate_change_max?, total_rate_min?, total_rate_max?, conditions?, apply_to?, admin_area_only?, customer_roles?, days_of_week?, time_from?, time_to?, apply_with_coupon_codes?, apply_with_cart_rules?, do_not_apply_with_coupon_codes?, do_not_apply_with_cart_rules?)
GETList Shipments
/api/projects/{project_id}/sales/shipments
List shipments for a projectPath parameters: project_id
Query parameters: ListShipmentsQuery (page?, perPage)
DELETEDelete Shipment
/api/projects/{project_id}/sales/shipments/{shipment_id}
Delete shipmentPath parameters: project_id, shipment_id
GETGet Shipment
/api/projects/{project_id}/sales/shipments/{shipment_id}
Get shipment detailPath parameters: project_id, shipment_id
PATCHUpdate Shipment
/api/projects/{project_id}/sales/shipments/{shipment_id}
Update shipmentPath parameters: project_id, shipment_id
JSON body: UpdateShipmentRequest
GETList Shipment Comments
/api/projects/{project_id}/sales/shipments/{shipment_id}/comments
Lists the comments attached to a shipment in the target project.Path parameters: project_id, shipment_id
POSTCreate Shipment Comment
/api/projects/{project_id}/sales/shipments/{shipment_id}/comments
Adds a comment to a shipment in the target project.Path parameters: project_id, shipment_id
JSON body: AddShipmentCommentRequest
GETGet Shipment Detail
/api/projects/{project_id}/sales/shipments/{shipment_id}/detail
Get shipment detail with optional relationsPath parameters: project_id, shipment_id
Query parameters: ShipmentDetailQuery (include_items?, include_tracks?, include_comments?)
POSTRefresh Shipment Tracking
/api/projects/{project_id}/sales/shipments/{shipment_id}/refresh-tracking
Force refresh tracking for a shipmentPath parameters: project_id, shipment_id
GETList Tracking Events
/api/projects/{project_id}/sales/shipments/{shipment_id}/tracking-events
Get tracking events for a shipmentPath parameters: project_id, shipment_id
GETList Shipment Tracks
/api/projects/{project_id}/sales/shipments/{shipment_id}/tracks
Lists the tracking records attached to a shipment in the target project.Path parameters: project_id, shipment_id
POSTCreate Shipment Track
/api/projects/{project_id}/sales/shipments/{shipment_id}/tracks
Adds a tracking record to a shipment in the target project.Path parameters: project_id, shipment_id
JSON body: CreateShipmentTrackRequest
GETList Shipping Methods
/api/projects/{project_id}/sales/shipping-methods
Lists the effective shipping methods for a project, merging system defaults with project overrides and custom methods.Path parameters: project_id
Query parameters: ListQuery (page?, per_page?, q?, filter?, raw_filters?)
POSTCreate Shipping Method
/api/projects/{project_id}/sales/shipping-methods
Creates a project-scoped shipping method from the submitted carrier and method details.Path parameters: project_id
JSON body: UpsertShippingMethodRequest (carrier_code, carrier_label?, method_code, method_label, is_active?, sort_order?, meta?, use_default?)
DELETEDelete Shipping Method
/api/projects/{project_id}/sales/shipping-methods/{method_id}
Deletes a project-scoped shipping method; system default methods cannot be deleted.Path parameters: project_id, method_id
PATCHUpdate Shipping Method
/api/projects/{project_id}/sales/shipping-methods/{method_id}
Updates a project shipping method, creating a project override when the target is a system default.Path parameters: project_id, method_id
JSON body: UpsertShippingMethodRequest (carrier_code, carrier_label?, method_code, method_label, is_active?, sort_order?, meta?, use_default?)
GETList Shipping Methods Tree
/api/projects/{project_id}/sales/shipping-methods/tree
Lists active shipping methods grouped by carrier for a project.Path parameters: project_id
GETList Subscription Groups
/api/projects/{project_id}/sales/subscription_groups
Lists subscription groups and their subscriptions for a project.Path parameters: project_id
POSTCreate Subscription Group
/api/projects/{project_id}/sales/subscription_groups
Creates a subscription group with optional nested subscriptions for a project.Path parameters: project_id
JSON body: SubscriptionGroupPayload (name, discount_type?, discount_amount?, discount_scope?, intro_duration?, intro_unit?, discount_target?, tax_enabled?, require_payment_before_trial?, refund_policy?, upgrade_allowed?, upgrade_charge_model?, upgrade_proration_window_days?, downgrade_allowed?, downgrade_apply?, allow_multiple_subscriptions?, subscriptions?)
DELETEDelete Subscription Group
/api/projects/{project_id}/sales/subscription_groups/{group_id}
Deletes a subscription group and returns the refreshed refund policy for a project.Path parameters: project_id, group_id
GETGet Subscription Group
/api/projects/{project_id}/sales/subscription_groups/{group_id}
Returns a single subscription group with its subscriptions for a project, or null when missing.Path parameters: project_id, group_id
PUTUpdate Subscription Group
/api/projects/{project_id}/sales/subscription_groups/{group_id}
Updates a subscription group and upserts its nested subscriptions for a project.Path parameters: project_id, group_id
JSON body: SubscriptionGroupPayload (name, discount_type?, discount_amount?, discount_scope?, intro_duration?, intro_unit?, discount_target?, tax_enabled?, require_payment_before_trial?, refund_policy?, upgrade_allowed?, upgrade_charge_model?, upgrade_proration_window_days?, downgrade_allowed?, downgrade_apply?, allow_multiple_subscriptions?, subscriptions?)
GETList Tax Zones
/api/projects/{project_id}/sales/tax-zones
Lists the tax zones configured for a project, ordered by priority.Path parameters: project_id
POSTCreate Tax Zone
/api/projects/{project_id}/sales/tax-zones
Creates a tax zone for a project.Path parameters: project_id
JSON body: CreateTaxZoneRequest (name, tax_title?, rate_percent?, countries?, regions?, cities?, postal_codes?, priority?, is_active?)
DELETEDelete Tax Zone
/api/projects/{project_id}/sales/tax-zones/{zone_id}
Deletes a tax zone from a project.Path parameters: project_id, zone_id
GETGet Tax Zone
/api/projects/{project_id}/sales/tax-zones/{zone_id}
Retrieves a single tax zone by id within a project.Path parameters: project_id, zone_id
PATCHUpdate Tax Zone
/api/projects/{project_id}/sales/tax-zones/{zone_id}
Updates one or more fields on an existing tax zone in a project.Path parameters: project_id, zone_id
JSON body: UpdateTaxZoneRequest (name?, tax_title?, rate_percent?, countries?, regions?, cities?, postal_codes?, priority?, is_active?)
GETList Transactions
/api/projects/{project_id}/sales/transactions
List transactions for a projectPath parameters: project_id
Query parameters: ListTransactionsQuery (page?, per_page?, order_id?, q?, sort?, filters?)
GETGet Transaction
/api/projects/{project_id}/sales/transactions/{transaction_id}
Get transaction detailPath parameters: project_id, transaction_id
POSTStart Connect
/api/projects/{project_id}/shopify/connect/start
Begins the Shopify OAuth connection flow for a project and returns the authorization URL.Path parameters: project_id
JSON body: StartShopifyConnectBody (store_domain, return_to?, auto_import?, api_version?, import_products?, import_collections?, import_orders?, import_customers?, import_pages?)
Authentication: session
Request data read: headers
GETGet Connect status
/api/projects/{project_id}/shopify/connect/status
Returns the Shopify connection status and granted scopes for a project.Path parameters: project_id
Authentication: session
GETList Shopify Imports
/api/projects/{project_id}/shopify/imports
Lists the most recent Shopify import jobs for a project.Path parameters: project_id
Authentication: session
POSTCreate Shopify Import
/api/projects/{project_id}/shopify/imports
Queues a Shopify import job for a project and returns the created job.Path parameters: project_id
JSON body: CreateShopifyImportBody (store_domain?, access_token?, api_version?, import_products?, import_collections?, import_orders?, import_customers?, import_pages?)
Authentication: session
GETGet Shopify Import
/api/projects/{project_id}/shopify/imports/{job_id}
Returns a single Shopify import job by id for a project.Path parameters: project_id, job_id
Authentication: session
GETHandle Connect callback
/api/shopify/connect/callback
Handles the Shopify OAuth redirect, validating state and HMAC before storing the project connection.Query parameters: ShopifyConnectCallbackQuery (shop?, hmac?, code?, state?, host?, timestamp?, error?, error_description?)

Blog extension

MethodOperationRequest information
GETList Authors
/api/projects/{project_id}/blog/authors
Path parameters: project_id
POSTCreate Author
/api/projects/{project_id}/blog/authors
Path parameters: project_id
DELETEDelete Author
/api/projects/{project_id}/blog/authors/{id}
Path parameters: project_id, id
GETList Blog Comments
/api/projects/{project_id}/blog/comments
Path parameters: project_id
POSTCreate Blog Comment
/api/projects/{project_id}/blog/comments
Path parameters: project_id
PATCHUpdate Blog Comment
/api/projects/{project_id}/blog/comments/{id}
Path parameters: project_id, id
GETList Content
/api/projects/{project_id}/blog/content
Path parameters: project_id
POSTCreate Content
/api/projects/{project_id}/blog/content
Path parameters: project_id
DELETEDelete Content
/api/projects/{project_id}/blog/content/{id}
Path parameters: project_id, id
GETGet Content
/api/projects/{project_id}/blog/content/{id}
Path parameters: project_id, id
PUTUpdate Content
/api/projects/{project_id}/blog/content/{id}
Path parameters: project_id, id
POSTCreate Autosave
/api/projects/{project_id}/blog/content/{id}/autosave
Path parameters: project_id, id
GETList Revisions
/api/projects/{project_id}/blog/content/{id}/revisions
Path parameters: project_id, id
POSTCreate Restore
/api/projects/{project_id}/blog/content/{id}/revisions/{revision_id}/restore
Path parameters: project_id, id, revision_id
POSTCreate Bulk
/api/projects/{project_id}/blog/content/bulk
Path parameters: project_id
GETList Export
/api/projects/{project_id}/blog/export
Path parameters: project_id
GETList Overview
/api/projects/{project_id}/blog/overview
Path parameters: project_id
GETList Redirects
/api/projects/{project_id}/blog/redirects
Path parameters: project_id
POSTCreate Redirect
/api/projects/{project_id}/blog/redirects
Path parameters: project_id
DELETEDelete Redirect
/api/projects/{project_id}/blog/redirects/{id}
Path parameters: project_id, id
GETList Blog Settings
/api/projects/{project_id}/blog/settings
Path parameters: project_id
PUTUpdate Blog Setting
/api/projects/{project_id}/blog/settings
Path parameters: project_id
POSTCreate Template Preview
/api/projects/{project_id}/blog/template-preview
Path parameters: project_id
JSON body: PreviewRequest (template_id)
Authentication: session
GETList Templates
/api/projects/{project_id}/blog/templates
Path parameters: project_id
Authentication: session
GETList Terms
/api/projects/{project_id}/blog/terms
Path parameters: project_id
POSTCreate Term
/api/projects/{project_id}/blog/terms
Path parameters: project_id
DELETEDelete Term
/api/projects/{project_id}/blog/terms/{id}
Path parameters: project_id, id
PUTUpdate Template
/api/projects/{project_id}/blog/terms/{id}/template
Path parameters: project_id, id
JSON body: TermAssignment (template_id?)
Authentication: session

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.