API ReferenceStorefront
Storefront settings
GET /rest/v1/storefront
The settings, with payments as configured yes/no only.
Required scope: products:read.
Authorization
apiKey AuthorizationBearer <token>
Authorization: Bearer nbl_live_... (or nbl_test_... for test mode). Test-mode writes are validated and simulated but never persisted and never touch channels; simulated results are marked simulated.
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/storefront"{ "object": "storefront", "name": "string", "slug": "string", "theme": "string", "announcement": { "enabled": true, "message": "string", "link": "string", "mode": "auto" }, "custom_domain": "string", "logo": "string", "return_policy": { "days": 30, "who_pays": "buyer" }, "shipping": { "worldwide_free": true, "zones": [ { "id": "string", "name": "Europe", "enabled": true, "countries": [ "IT", "FR", "DE" ], "free": false, "pricing": { "light": 0, "heavy": 0, "additional": 0 }, "free_over": 0, "heavier_than": { "value": 0, "unit": "oz" }, "larger_than": { "value": 0, "unit": "in3" }, "pickup": { "enabled": true, "note": "string" } } ] }, "address": "string", "show_channels": true, "visible_channels": [ "string" ], "show_chat": true, "out_of_stock": true, "ai_discovery": true, "product_image_display": "fill", "contact_email": "string", "payments": { "stripe": true, "paypal": true }, "simulated": true}Last updated on October 18, 2026
Need help?
Email us and a human replies, usually within one business day.