Endpoint overview
The table below mirrors the public routes mounted in backend-public-api/app.js. Paths are shown with the public proxy prefix used by external integrations.
| Method | Endpoint | Description | Access |
|---|---|---|---|
GET | /public-api/healthz | Service health check. | public |
GET | /public-api/v1/auth/check | Validates credentials and returns storefront, scopes and plan capabilities. | any authenticated credential |
GET | /public-api/v1/customer-orders | Returns a paginated and filterable list of customer orders. | orders:read |
GET | /public-api/v1/customer-orders/:id | Returns a single customer order with configured product items. | orders:read |
POST | /public-api/v1/customer-orders/batch | Returns up to 100 orders by ID. | orders:read |
PATCH | /public-api/v1/customer-orders/:id/status | Updates the order status. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity | Updates selected order detail quantities. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity/all | Sets one quantity for every item in an order. | orders:write |
DELETE | /public-api/v1/customer-orders/:id | Deletes a customer order owned by the storefront owner. | orders:write |
GET | /public-api/v1/products | Returns storefront products/designs with embed availability and media URLs. | products:read |
GET | /public-api/v1/products/:id | Returns one storefront product/design. | products:read |
POST | /public-api/v1/embed/session | Issues a short-lived JWT for embedded tools, including the model generator. | embed:session:create |
GET | /public-api/v1/runtime/bootstrap | Resolves runtime context from an embed JWT. | Bearer embed token |
GET | /public-api/v1/assets | Lists asset catalog items for the requested type. | any authenticated credential |
GET | /public-api/v1/assets/:type/:assetId | Returns an asset manifest with downloadable file roles. | any authenticated credential |
GET | /public-api/v1/assets/:type/:assetId/files/:role | Downloads an asset file by role. | any authenticated credential |
GET | /public-api/v1/design-imports | Lists importable Alter-hosted designs. | authenticated credential, Business plan required |
GET | /public-api/v1/design-imports/:id | Returns a design import payload and file descriptors. | authenticated credential, Business plan required |
GET | /public-api/v1/design-imports/:id/files/:fileId | Downloads a file from a design import descriptor. | authenticated credential, Business plan required |
GET | /public-api/v1/file/public/products/:productId/:size | Returns a public product preview. Size must be small.png, medium.png or big.png. | public |
GET | /public-api/v1/file/protected/:key | Returns a protected file by storage key. | signed URL or files:read |
GET | /public-api/v1/fonts | Returns all available fonts. | public |
GET | /public-api/v1/currencies | Returns all currencies. | public |
POST | /public-api/v1/runtime-bindings/sync-from-wordpress | Creates or updates runtime bindings from WordPress product mappings. | any authenticated credential |
PATCH | /public-api/v1/runtime-bindings/:id | Patches a runtime binding. | any authenticated credential |
POST | /public-api/v1/runtime-bindings/:id/activate | Activates a runtime binding. | any authenticated credential |
POST | /public-api/v1/runtime-bindings/:id/deactivate | Deactivates a runtime binding. | any authenticated credential |
POST | /public-api/v1/wp-connect/exchange | Exchanges a WordPress auto-connect handoff code for API credentials. | one-time handoff code |
GET | /public-api/v1/model-generator/catalog | Lists visible generator products, configurations and template revisions. | embed:session:create |
GET | /public-api/v1/model-generator/models | Lists models with pinned generator source descriptors for import. | embed:session:create |
GET | /public-api/v1/model-generator/designer-catalog | Returns the generator model catalog used by Designer. | embed:session:create |
GET | /public-api/v1/model-generator/projects | Lists the owner’s and globally available generator projects. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId | Returns the latest or selected project revision, template and file manifest. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/revisions/:revision | Returns the latest or selected project revision, template and file manifest. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/artifacts/:artifactId | Downloads an artifact after checking access to its project. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/template | Returns an accessible template document for the selected configuration revision. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/import | Returns the template import bundle with dependency files. | embed:session:create |
GET | /public-api/v1/model-generator/mannequins | Returns both mannequins and their resource descriptors. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets | Lists texture or background library assets with importable files. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets/:assetId | Returns one texture or background asset with its importable files. | embed:session:create |
GET | /public-api/v1/model-generator/public-files/:key | Downloads an allowed generator dependency file. | embed:session:create |