v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-03269339953.6 KB
Ecommerce: Miscellaneous

Get custom storefront setup instructions

Retrieve step-by-step setup instructions, formatted as Markdown, for connecting a custom sales channel to your store and keeping your catalog, orders, shipping and payments in sync through the Ecommerce API.

get/api/ecommerce/v1/miscellaneous/custom-storefront-instructions

Response

Success response

instructionsstring

Markdown setup instructions for connecting a custom sales channel to your store.

Example response

{
  "instructions": "# Connect your custom storefront\n\nUse the Ecommerce API to sync your store."
}