# Open Mercato API Version: 1.0.0 Auto-generated OpenAPI definition for all enabled modules. ## Servers - https://open-mercato.dogtronic.biz – Default environment ## DELETE `/api_keys/keys` Delete API key Removes an API key by identifier. The key must belong to the current tenant and fall within the requester organization scope. Requires features: api_keys.delete **Tags:** API Keys **Requires authentication.** **Features:** api_keys.delete ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required | ### Responses **200** – Key deleted successfully Content-Type: `application/json` ```json { "success": true } ``` **400** – Missing or invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Key not found within scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/api_keys/keys?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/api_keys/keys` List API keys Returns paginated API keys visible to the current user, including per-key role assignments and organization context. Requires features: api_keys.view **Tags:** API Keys **Requires authentication.** **Features:** api_keys.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | ### Responses **200** – Collection of API keys Content-Type: `application/json` ```json { "items": [ { "id": "string", "name": "string", "description": null, "keyPrefix": "string", "organizationId": null, "organizationName": null, "createdAt": "string", "lastUsedAt": null, "expiresAt": null, "roles": [ { "id": "string", "name": null } ] } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` **400** – Tenant context missing Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/api_keys/keys" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/api_keys/keys` Create API key Creates a new API key, returning the one-time secret value together with the generated key prefix and scope details. Requires features: api_keys.create **Tags:** API Keys **Requires authentication.** **Features:** api_keys.create ### Request Body Content-Type: `application/json` ```json { "name": "string", "description": null, "tenantId": null, "organizationId": null, "roles": [], "expiresAt": null } ``` ### Responses **201** – API key created successfully Content-Type: `application/json` ```json { "id": "string", "name": "string", "keyPrefix": "string", "tenantId": null, "organizationId": null, "roles": [ { "id": "string", "name": null } ] } ``` **400** – Invalid payload or missing tenant context Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/api_keys/keys" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "name": "string", "description": null, "tenantId": null, "organizationId": null, "roles": [], "expiresAt": null }' ``` ## DELETE `/attachments/attachments` Delete attachment Removes an uploaded attachment and deletes the stored asset. Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required | ### Responses **200** – Attachment deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Missing attachment identifier Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Attachment not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/attachments/attachments?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/attachments/attachments` List attachments for a record Returns uploaded attachments for the given entity record, ordered by newest first. Requires features: attachments.view **Tags:** Attachments **Requires authentication.** **Features:** attachments.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityId | query | any | Required | | recordId | query | any | Required | ### Responses **200** – Attachments found for the record Content-Type: `application/json` ```json { "items": [ { "id": "string", "url": "string", "fileName": "string", "fileSize": 1, "createdAt": "string" } ] } ``` **400** – Missing entity or record identifiers Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/attachments/attachments?entityId=string&recordId=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/attachments/attachments` Upload attachment Uploads a new attachment using multipart form-data and stores metadata for later retrieval. Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Request Body Content-Type: `multipart/form-data` ```text entityId=string recordId=string file=string ``` ### Responses **200** – Attachment stored successfully Content-Type: `application/json` ```json { "ok": true, "item": { "id": "string", "url": "string", "fileName": "string", "fileSize": 1 } } ``` **400** – Payload validation error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/attachments/attachments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: multipart/form-data" \ -d '{ "entityId": "string", "recordId": "string", "file": "string" }' ``` ## GET `/attachments/attachments/file/{id}` GET /attachments/attachments/file/{id} **Tags:** Attachments ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/attachments/attachments/file/:id" \ -H "Accept: application/json" ``` ## GET `/attachments/attachments/image/{id}/{slug}` GET /attachments/attachments/image/{id}/{slug} **Tags:** Attachments ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | slug | path | any | Optional | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/attachments/attachments/image/:id/:slug" \ -H "Accept: application/json" ``` ## POST `/attachments/attachments/transfer` POST /attachments/attachments/transfer Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/attachments/attachments/transfer" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/attachments/library` GET /attachments/library Requires features: attachments.view **Tags:** Attachments **Requires authentication.** **Features:** attachments.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/attachments/library" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/attachments/library/{id}` DELETE /attachments/library/{id} Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/attachments/library/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/attachments/library/{id}` GET /attachments/library/{id} Requires features: attachments.view **Tags:** Attachments **Requires authentication.** **Features:** attachments.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/attachments/library/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/attachments/library/{id}` PATCH /attachments/library/{id} Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://open-mercato.dogtronic.biz/attachments/library/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/attachments/partitions` DELETE /attachments/partitions Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/attachments/partitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/attachments/partitions` GET /attachments/partitions Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/attachments/partitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/attachments/partitions` POST /attachments/partitions Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/attachments/partitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/attachments/partitions` PUT /attachments/partitions Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/attachments/partitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/audit_logs/audit-logs/access` Retrieve access logs Fetches paginated access audit logs scoped to the authenticated user. Tenant administrators can optionally expand the search to other actors or organizations. Requires features: audit_logs.view_self **Tags:** Audit & Action Logs **Requires authentication.** **Features:** audit_logs.view_self ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | organizationId | query | any | Optional | | actorUserId | query | any | Optional | | resourceKind | query | any | Optional | | accessType | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | limit | query | any | Optional | | before | query | any | Optional | | after | query | any | Optional | ### Responses **200** – Access logs returned successfully Content-Type: `application/json` ```json { "items": [ { "id": "string", "resourceKind": "string", "resourceId": "string", "accessType": "string", "actorUserId": null, "actorUserName": null, "tenantId": null, "tenantName": null, "organizationId": null, "organizationName": null, "fields": [ "string" ], "context": null, "createdAt": "string" } ], "canViewTenant": true, "page": 1, "pageSize": 1, "total": 1, "totalPages": 1 } ``` **400** – Invalid filters supplied Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/audit_logs/audit-logs/access" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/audit_logs/audit-logs/actions` Fetch action logs Returns recent action audit log entries. Tenant administrators can widen the scope to other actors or organizations, and callers can optionally restrict results to undoable actions. Requires features: audit_logs.view_self **Tags:** Audit & Action Logs **Requires authentication.** **Features:** audit_logs.view_self ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | organizationId | query | any | Optional | | actorUserId | query | any | Optional | | undoableOnly | query | any | Optional | | limit | query | any | Optional | | before | query | any | Optional | | after | query | any | Optional | ### Responses **200** – Action logs retrieved successfully Content-Type: `application/json` ```json { "items": [ { "id": "string", "commandId": "string", "actionLabel": null, "executionState": "done", "actorUserId": null, "actorUserName": null, "tenantId": null, "tenantName": null, "organizationId": null, "organizationName": null, "resourceKind": null, "resourceId": null, "undoToken": null, "createdAt": "string", "updatedAt": "string", "snapshotBefore": null, "snapshotAfter": null, "changes": null, "context": null } ], "canViewTenant": true } ``` **400** – Invalid filter values Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/audit_logs/audit-logs/actions?undoableOnly=false" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/audit_logs/audit-logs/actions/redo` Redo by action log id Redoes the latest undone command owned by the caller. Requires the action to still be eligible for redo within tenant and organization scope. Requires features: audit_logs.redo_self **Tags:** Audit & Action Logs **Requires authentication.** **Features:** audit_logs.redo_self ### Request Body Content-Type: `application/json` ```json { "logId": "string" } ``` ### Responses **200** – Redo executed successfully Content-Type: `application/json` ```json { "ok": true, "logId": null, "undoToken": null } ``` **400** – Log not eligible for redo Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/audit_logs/audit-logs/actions/redo" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "logId": "string" }' ``` ## POST `/audit_logs/audit-logs/actions/undo` Undo action by token Replays the undo handler registered for a command. The provided undo token must match the latest undoable log entry accessible to the caller. Requires features: audit_logs.undo_self **Tags:** Audit & Action Logs **Requires authentication.** **Features:** audit_logs.undo_self ### Request Body Content-Type: `application/json` ```json { "undoToken": "string" } ``` ### Responses **200** – Undo applied successfully Content-Type: `application/json` ```json { "ok": true, "logId": "string" } ``` **400** – Invalid or unavailable undo token Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/audit_logs/audit-logs/actions/undo" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "undoToken": "string" }' ``` ## GET `/auth/admin/nav` Resolve sidebar entries Returns the backend navigation tree available to the authenticated administrator after applying role and personal sidebar preferences. **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **200** – Sidebar navigation structure Content-Type: `application/json` ```json { "groups": [ { "id": "string", "name": "string", "defaultName": "string", "items": [ { "href": "string", "title": "string", "defaultTitle": "string", "enabled": true } ] } ] } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/auth/admin/nav" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/feature-check` Check feature grants for the current user Evaluates which of the requested features are available to the signed-in user within the active tenant / organization context. **Tags:** Authentication & Accounts **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "features": [ "string" ] } ``` ### Responses **200** – Evaluation result Content-Type: `application/json` ```json { "ok": true, "granted": [ "string" ] } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/auth/feature-check" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "features": [ "string" ] }' ``` ## GET `/auth/features` List declared feature flags Returns all static features contributed by the enabled modules along with their module source. Requires features: auth.acl.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.acl.manage ### Responses **200** – Aggregated feature catalog Content-Type: `application/json` ```json { "items": [ { "id": "string", "title": "string", "module": "string" } ], "modules": [ { "id": "string", "title": "string" } ] } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/auth/features" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/login` Authenticate user credentials Validates the submitted credentials and issues a bearer token cookie for subsequent API calls. **Tags:** Authentication & Accounts ### Request Body Content-Type: `application/x-www-form-urlencoded` ```text email=user%40example.com&password=string ``` ### Responses **200** – Authentication succeeded Content-Type: `application/json` ```json { "ok": true, "token": "string", "redirect": null } ``` **400** – Validation failed Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Invalid credentials Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – User lacks required role Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/auth/login" \ -H "Accept: application/json" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d 'email=user%40example.com&password=string' ``` ## GET `/auth/logout` Log out (legacy GET) For convenience, the GET variant performs the same logout logic as POST and issues a redirect. **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` **302** – Redirect to login after successful logout Content-Type: `text/html` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/auth/logout" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/logout` Invalidate session and redirect Clears authentication cookies and redirects the browser to the login page. **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` **302** – Redirect to login after successful logout Content-Type: `text/html` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/auth/logout" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/reset` Send reset email Requests a password reset email for the given account. The endpoint always returns `ok: true` to avoid leaking account existence. **Tags:** Authentication & Accounts ### Request Body Content-Type: `application/x-www-form-urlencoded` ```text email=user%40example.com ``` ### Responses **200** – Reset email dispatched (or ignored for unknown accounts) Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/auth/reset" \ -H "Accept: application/json" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d 'email=user%40example.com' ``` ## POST `/auth/reset/confirm` Complete password reset Validates the reset token and updates the user password. **Tags:** Authentication & Accounts ### Request Body Content-Type: `application/x-www-form-urlencoded` ```text token=string&password=string ``` ### Responses **200** – Password reset succeeded Content-Type: `application/json` ```json { "ok": true, "redirect": "string" } ``` **400** – Invalid token or payload Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/auth/reset/confirm" \ -H "Accept: application/json" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d 'token=string&password=string' ``` ## DELETE `/auth/roles` Delete role Deletes a role by identifier. Fails when users remain assigned. Requires features: auth.roles.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.roles.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required | ### Responses **200** – Role deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Role cannot be deleted Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/auth/roles?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/roles` List roles Returns available roles within the current tenant. Super administrators receive visibility across tenants. Requires features: auth.roles.list **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.roles.list ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | tenantId | query | any | Optional | ### Responses **200** – Role collection Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "usersCount": 1, "tenantId": null, "tenantName": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/auth/roles?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/roles` Create role Creates a new role for the current tenant or globally when `tenantId` is omitted. Requires features: auth.roles.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.roles.manage ### Request Body Content-Type: `application/json` ```json { "name": "string", "tenantId": null } ``` ### Responses **201** – Role created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/auth/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "name": "string", "tenantId": null }' ``` ## PUT `/auth/roles` Update role Updates mutable fields on an existing role. Requires features: auth.roles.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.roles.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "tenantId": null } ``` ### Responses **200** – Role updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/auth/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "tenantId": null }' ``` ## GET `/auth/roles/acl` Fetch role ACL Returns the feature and organization assignments associated with a role within the current tenant. Requires features: auth.acl.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.acl.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | roleId | query | any | Required | | tenantId | query | any | Optional | ### Responses **200** – Role ACL entry Content-Type: `application/json` ```json { "isSuperAdmin": true, "features": [ "string" ], "organizations": null } ``` **400** – Invalid role id Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/auth/roles/acl?roleId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/auth/roles/acl` Update role ACL Replaces the feature list, super admin flag, and optional organization assignments for a role. Requires features: auth.acl.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.acl.manage ### Request Body Content-Type: `application/json` ```json { "roleId": "00000000-0000-4000-8000-000000000000", "organizations": null } ``` ### Responses **200** – Role ACL updated Content-Type: `application/json` ```json { "ok": true, "sanitized": true } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/auth/roles/acl" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "roleId": "00000000-0000-4000-8000-000000000000", "organizations": null }' ``` ## GET `/auth/session/refresh` Refresh auth cookie from session token Exchanges an existing `session_token` cookie for a fresh JWT auth cookie and redirects the browser. **Tags:** Authentication & Accounts ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | redirect | query | any | Optional | ### Responses **200** – Success response Content-Type: `application/json` **302** – Redirect to target location when session is valid Content-Type: `text/html` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/auth/session/refresh" \ -H "Accept: application/json" ``` ## GET `/auth/sidebar/preferences` Get sidebar preferences Returns personal sidebar customization and any role-level preferences the user can manage. **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **200** – Current sidebar configuration Content-Type: `application/json` ```json { "locale": "string", "settings": { "version": 1, "groupOrder": [ "string" ], "groupLabels": { "key": "string" }, "itemLabels": { "key": "string" }, "hiddenItems": [ "string" ] }, "canApplyToRoles": true, "roles": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "hasPreference": true } ] } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/auth/sidebar/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/auth/sidebar/preferences` Update sidebar preferences Updates personal sidebar configuration and, optionally, applies the same settings to selected roles. **Tags:** Authentication & Accounts **Requires authentication.** ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Preferences saved Content-Type: `application/json` ```json { "locale": "string", "settings": { "version": 1, "groupOrder": [ "string" ], "groupLabels": { "key": "string" }, "itemLabels": { "key": "string" }, "hiddenItems": [ "string" ] }, "canApplyToRoles": true, "roles": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "hasPreference": true } ], "appliedRoles": [ "00000000-0000-4000-8000-000000000000" ], "clearedRoles": [ "00000000-0000-4000-8000-000000000000" ] } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing features for role-wide updates Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/auth/sidebar/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{}' ``` ## DELETE `/auth/users` Delete user Deletes a user by identifier. Undo support is provided via the command bus. Requires features: auth.users.delete **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.users.delete ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required | ### Responses **200** – User deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – User cannot be deleted Content-Type: `application/json` ```json { "error": "string" } ``` **404** – User not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/auth/users?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/users` List users Returns users for the current tenant. Super administrators may scope the response via organization or role filters. Requires features: auth.users.list **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.users.list ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | organizationId | query | any | Optional | | roleIds | query | any | Optional | ### Responses **200** – User collection Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "email": "user@example.com", "organizationId": null, "organizationName": null, "tenantId": null, "tenantName": null, "roles": [ "string" ] } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/auth/users?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/users` Create user Creates a new confirmed user within the specified organization and optional roles. Requires features: auth.users.create **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.users.create ### Request Body Content-Type: `application/json` ```json { "email": "user@example.com", "password": "string", "organizationId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **201** – User created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload or duplicate email Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/auth/users" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "email": "user@example.com", "password": "string", "organizationId": "00000000-0000-4000-8000-000000000000" }' ``` ## PUT `/auth/users` Update user Updates profile fields, organization assignment, credentials, or role memberships. Requires features: auth.users.edit **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.users.edit ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – User updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **404** – User not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/auth/users" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/auth/users/acl` Fetch user ACL Returns custom ACL overrides for a user within the current tenant, if any. Requires features: auth.acl.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.acl.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | userId | query | any | Required | ### Responses **200** – User ACL entry Content-Type: `application/json` ```json { "hasCustomAcl": true, "isSuperAdmin": true, "features": [ "string" ], "organizations": null } ``` **400** – Invalid user id Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/auth/users/acl?userId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/auth/users/acl` Update user ACL Configures per-user ACL overrides, including super admin access, feature list, and organization scope. Requires features: auth.acl.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.acl.manage ### Request Body Content-Type: `application/json` ```json { "userId": "00000000-0000-4000-8000-000000000000", "organizations": null } ``` ### Responses **200** – User ACL updated Content-Type: `application/json` ```json { "ok": true, "sanitized": true } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/auth/users/acl" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "userId": "00000000-0000-4000-8000-000000000000", "organizations": null }' ``` ## POST `/business_rules/execute` Execute rules for given context Manually executes applicable business rules for the specified entity type, event, and data. Supports dry-run mode to test rules without executing actions. Requires features: business_rules.execute **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.execute ### Request Body Content-Type: `application/json` ```json { "entityType": "string", "dryRun": false } ``` ### Responses **200** – Rules executed successfully Content-Type: `application/json` ```json { "allowed": true, "executedRules": [ { "ruleId": "string", "ruleName": "string", "conditionResult": true, "executionTime": 1 } ], "totalExecutionTime": 1 } ``` **400** – Invalid request payload Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Execution error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/business_rules/execute" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "entityType": "string", "dryRun": false }' ``` ## GET `/business_rules/logs` List rule execution logs Returns rule execution history for the current tenant and organization with filtering and pagination. Useful for audit trails and debugging. Requires features: business_rules.view_logs **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.view_logs ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | ruleId | query | any | Optional | | entityId | query | any | Optional | | entityType | query | any | Optional | | executionResult | query | any | Optional | | executedBy | query | any | Optional | | executedAtFrom | query | any | Optional | | executedAtTo | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Rule execution logs collection Content-Type: `application/json` ```json { "items": [ { "id": "string", "ruleId": "string", "ruleName": "string", "ruleType": "string", "entityId": "00000000-0000-4000-8000-000000000000", "entityType": "string", "executionResult": "SUCCESS", "inputContext": null, "outputContext": null, "errorMessage": null, "executionTimeMs": 1, "executedAt": "string", "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": null, "executedBy": null } ], "total": 1, "totalPages": 1 } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/business_rules/logs?page=1&pageSize=50&sortDir=desc" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/business_rules/logs/{id}` Get execution log detail Returns detailed information about a specific rule execution, including full context and results. Requires features: business_rules.view_logs **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.view_logs ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Log entry details Content-Type: `application/json` ```json { "id": "string", "rule": { "id": "00000000-0000-4000-8000-000000000000", "ruleId": "string", "ruleName": "string", "ruleType": "string", "entityType": "string" }, "entityId": "00000000-0000-4000-8000-000000000000", "entityType": "string", "executionResult": "SUCCESS", "inputContext": null, "outputContext": null, "errorMessage": null, "executionTimeMs": 1, "executedAt": "string", "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": null, "executedBy": null } ``` **400** – Invalid log id Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Log entry not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/business_rules/logs/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/business_rules/rules` Delete business rule Soft deletes a business rule by identifier. Requires features: business_rules.manage **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required | ### Responses **200** – Business rule deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Business rule not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/business_rules/rules?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/business_rules/rules` List business rules Returns business rules for the current tenant and organization with filtering and pagination. Requires features: business_rules.view **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | ruleId | query | any | Optional | | ruleType | query | any | Optional | | entityType | query | any | Optional | | eventType | query | any | Optional | | enabled | query | any | Optional | | ruleCategory | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Business rules collection Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "ruleId": "string", "ruleName": "string", "description": null, "ruleType": "GUARD", "ruleCategory": null, "entityType": "string", "eventType": null, "enabled": true, "priority": 1, "version": 1, "effectiveFrom": null, "effectiveTo": null, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string" } ], "total": 1, "totalPages": 1 } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/business_rules/rules?page=1&pageSize=50&sortDir=desc" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/business_rules/rules` Create business rule Creates a new business rule for the current tenant and organization. Requires features: business_rules.manage **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage ### Request Body Content-Type: `application/json` ```json { "ruleId": "string", "ruleName": "string", "description": null, "ruleType": "GUARD", "ruleCategory": null, "entityType": "string", "eventType": null, "successActions": null, "failureActions": null, "enabled": true, "priority": 100, "version": 1, "effectiveFrom": null, "effectiveTo": null, "tenantId": "string", "organizationId": "string", "createdBy": null } ``` ### Responses **201** – Business rule created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/business_rules/rules" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "ruleId": "string", "ruleName": "string", "description": null, "ruleType": "GUARD", "ruleCategory": null, "entityType": "string", "eventType": null, "successActions": null, "failureActions": null, "enabled": true, "priority": 100, "version": 1, "effectiveFrom": null, "effectiveTo": null, "tenantId": "string", "organizationId": "string", "createdBy": null }' ``` ## PUT `/business_rules/rules` Update business rule Updates an existing business rule. Requires features: business_rules.manage **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage ### Request Body Content-Type: `application/json` ```json { "description": null, "ruleCategory": null, "eventType": null, "successActions": null, "failureActions": null, "enabled": true, "priority": 100, "version": 1, "effectiveFrom": null, "effectiveTo": null, "createdBy": null, "id": "string" } ``` ### Responses **200** – Business rule updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Business rule not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/business_rules/rules" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "description": null, "ruleCategory": null, "eventType": null, "successActions": null, "failureActions": null, "enabled": true, "priority": 100, "version": 1, "effectiveFrom": null, "effectiveTo": null, "createdBy": null, "id": "string" }' ``` ## GET `/business_rules/rules/{id}` Fetch business rule by ID Returns complete details of a business rule including conditions and actions. Requires features: business_rules.view **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Business rule detail Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "ruleId": "string", "ruleName": "string", "description": null, "ruleType": "GUARD", "ruleCategory": null, "entityType": "string", "eventType": null, "successActions": null, "failureActions": null, "enabled": true, "priority": 1, "version": 1, "effectiveFrom": null, "effectiveTo": null, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdBy": null, "updatedBy": null, "createdAt": "string", "updatedAt": "string" } ``` **400** – Invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Business rule not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/business_rules/rules/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/business_rules/sets` Delete rule set Soft deletes a rule set by identifier. Requires features: business_rules.manage_sets **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage_sets ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required | ### Responses **200** – Rule set deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Rule set not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/business_rules/sets?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/business_rules/sets` List rule sets Returns rule sets for the current tenant and organization with filtering and pagination. Requires features: business_rules.view **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | setId | query | any | Optional | | enabled | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Rule sets collection Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "setId": "string", "setName": "string", "description": null, "enabled": true, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdBy": null, "updatedBy": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "totalPages": 1 } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/business_rules/sets?page=1&pageSize=50&sortDir=asc" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/business_rules/sets` Create rule set Creates a new rule set for organizing business rules. Requires features: business_rules.manage_sets **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage_sets ### Request Body Content-Type: `application/json` ```json { "setId": "string", "setName": "string", "description": null, "enabled": true, "tenantId": "string", "organizationId": "string", "createdBy": null } ``` ### Responses **201** – Rule set created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/business_rules/sets" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "setId": "string", "setName": "string", "description": null, "enabled": true, "tenantId": "string", "organizationId": "string", "createdBy": null }' ``` ## PUT `/business_rules/sets` Update rule set Updates an existing rule set. Requires features: business_rules.manage_sets **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage_sets ### Request Body Content-Type: `application/json` ```json { "description": null, "enabled": true, "createdBy": null, "id": "string" } ``` ### Responses **200** – Rule set updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Rule set not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/business_rules/sets" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "description": null, "enabled": true, "createdBy": null, "id": "string" }' ``` ## GET `/business_rules/sets/{id}` Get rule set detail Returns detailed information about a specific rule set, including all member rules. Requires features: business_rules.view **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Rule set details Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "setId": "string", "setName": "string", "description": null, "enabled": true, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdBy": null, "updatedBy": null, "createdAt": "string", "updatedAt": "string", "members": [ { "id": "00000000-0000-4000-8000-000000000000", "ruleId": "00000000-0000-4000-8000-000000000000", "ruleName": "string", "ruleType": "string", "sequence": 1, "enabled": true } ] } ``` **400** – Invalid rule set id Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Rule set not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/business_rules/sets/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/business_rules/sets/{id}/members` Remove rule from set Removes a business rule from a rule set (hard delete). Requires features: business_rules.manage_sets **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage_sets ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | memberId | query | any | Required | ### Responses **200** – Member removed Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Member not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/business_rules/sets/:id/members?memberId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/business_rules/sets/{id}/members` Add rule to set Adds a business rule to a rule set with specified sequence and enabled state. Requires features: business_rules.manage_sets **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage_sets ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "ruleId": "00000000-0000-4000-8000-000000000000", "sequence": 0, "enabled": true } ``` ### Responses **201** – Member added Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Rule set or rule not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Rule already in set Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/business_rules/sets/:id/members" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "ruleId": "00000000-0000-4000-8000-000000000000", "sequence": 0, "enabled": true }' ``` ## PUT `/business_rules/sets/{id}/members` Update set member Updates sequence or enabled state of a rule set member. Requires features: business_rules.manage_sets **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage_sets ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "memberId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Member updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Member not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/business_rules/sets/:id/members" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "memberId": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/catalog/categories` Delete category Deletes a category by id. Requires features: catalog.categories.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.categories.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Category deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/catalog/categories" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/catalog/categories` List categories Returns a paginated collection of categories scoped to the authenticated organization. Requires features: catalog.categories.view **Tags:** Catalog **Requires authentication.** **Features:** catalog.categories.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | view | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | status | query | any | Optional | | ids | query | any | Optional | ### Responses **200** – Paginated categories Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "slug": null, "description": null, "parentId": null, "parentName": null, "depth": 1, "treePath": "string", "pathLabel": "string", "childCount": 1, "descendantCount": 1, "isActive": true, "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000" } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/catalog/categories?view=manage&page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/categories` Create category Creates a new product category. Requires features: catalog.categories.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.categories.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "slug": null, "parentId": null } ``` ### Responses **201** – Category created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/catalog/categories" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "slug": null, "parentId": null }' ``` ## PUT `/catalog/categories` Update category Updates an existing category by id. Requires features: catalog.categories.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.categories.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "slug": null, "parentId": null } ``` ### Responses **200** – Category updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/catalog/categories" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "slug": null, "parentId": null }' ``` ## GET `/catalog/dictionaries/{key}` Get dictionary entries by key Returns dictionary entries for a specific key (e.g., currency, unit). Requires features: catalog.products.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.products.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | key | path | any | Required | ### Responses **200** – Dictionary entries Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "entries": [ { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": "string", "color": null, "icon": null } ] } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/catalog/dictionaries/:key" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/catalog/offers` Delete offer Deletes an offer by id. Requires features: sales.channels.manage **Tags:** Catalog **Requires authentication.** **Features:** sales.channels.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Offer deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/catalog/offers" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/catalog/offers` List offers Returns a paginated collection of offers scoped to the authenticated organization. Requires features: sales.channels.manage **Tags:** Catalog **Requires authentication.** **Features:** sales.channels.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | productId | query | any | Optional | | channelId | query | any | Optional | | channelIds | query | any | Optional | | id | query | any | Optional | | search | query | any | Optional | | isActive | query | any | Optional | | withDeleted | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated offers Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "productId": null, "organizationId": null, "tenantId": null, "channelId": null, "title": "string", "description": null, "defaultMediaId": null, "defaultMediaUrl": null, "localizedContent": null, "metadata": null, "isActive": null, "createdAt": null, "updatedAt": null, "product": null, "productChannelPrice": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/catalog/offers?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/offers` Create offer Creates a new offer linking a product to a sales channel. Requires features: sales.channels.manage **Tags:** Catalog **Requires authentication.** **Features:** sales.channels.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "channelId": "00000000-0000-4000-8000-000000000000", "title": "string", "defaultMediaId": null, "defaultMediaUrl": null, "productId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **201** – Offer created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/catalog/offers" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "channelId": "00000000-0000-4000-8000-000000000000", "title": "string", "defaultMediaId": null, "defaultMediaUrl": null, "productId": "00000000-0000-4000-8000-000000000000" }' ``` ## PUT `/catalog/offers` Update offer Updates an existing offer by id. Requires features: sales.channels.manage **Tags:** Catalog **Requires authentication.** **Features:** sales.channels.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "defaultMediaId": null, "defaultMediaUrl": null } ``` ### Responses **200** – Offer updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/catalog/offers" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "defaultMediaId": null, "defaultMediaUrl": null }' ``` ## DELETE `/catalog/option-schemas` Delete option schema Deletes an option schema by id. Requires features: catalog.settings.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Option Schema deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/catalog/option-schemas" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/catalog/option-schemas` List option schemas Returns a paginated collection of option schemas scoped to the authenticated organization. Requires features: catalog.products.view **Tags:** Catalog **Requires authentication.** **Features:** catalog.products.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | id | query | any | Optional | | search | query | any | Optional | | isActive | query | any | Optional | | withDeleted | query | any | Optional | ### Responses **200** – Paginated option schemas Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "code": null, "description": null, "schema": null, "metadata": null, "is_active": null, "created_at": null, "updated_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/catalog/option-schemas?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/option-schemas` Create option schema Creates a new option schema template for product configurations. Requires features: catalog.settings.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "schema": { "options": [ { "code": "string", "label": "string", "inputType": "select" } ] } } ``` ### Responses **201** – Option Schema created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/catalog/option-schemas" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "schema": { "options": [ { "code": "string", "label": "string", "inputType": "select" } ] } }' ``` ## PUT `/catalog/option-schemas` Update option schema Updates an existing option schema by id. Requires features: catalog.settings.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Option Schema updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/catalog/option-schemas" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/catalog/price-kinds` Delete price kind Deletes a price kind by id. Requires features: catalog.settings.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Price Kind deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/catalog/price-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/catalog/price-kinds` List price kinds Returns a paginated collection of price kinds scoped to the authenticated organization. Requires features: catalog.settings.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | isPromotion | query | any | Optional | | isActive | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated price kinds Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "organization_id": null, "tenant_id": null, "code": "string", "title": "string", "display_mode": null, "currency_code": null, "is_promotion": null, "is_active": null, "created_at": null, "updated_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/catalog/price-kinds?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/price-kinds` Create price kind Creates a new price kind for categorizing product prices. Requires features: catalog.settings.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.settings.manage ### Request Body Content-Type: `application/json` ```json { "tenantId": "00000000-0000-4000-8000-000000000000", "code": "string", "title": "string", "displayMode": "excluding-tax" } ``` ### Responses **201** – Price Kind created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/catalog/price-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "tenantId": "00000000-0000-4000-8000-000000000000", "code": "string", "title": "string", "displayMode": "excluding-tax" }' ``` ## PUT `/catalog/price-kinds` Update price kind Updates an existing price kind by id. Requires features: catalog.settings.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "displayMode": "excluding-tax" } ``` ### Responses **200** – Price Kind updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/catalog/price-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "displayMode": "excluding-tax" }' ``` ## DELETE `/catalog/prices` Delete price Deletes a price by id. Requires features: catalog.pricing.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.pricing.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Price deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/catalog/prices" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/catalog/prices` List prices Returns a paginated collection of prices scoped to the authenticated organization. Requires features: catalog.products.view **Tags:** Catalog **Requires authentication.** **Features:** catalog.products.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | productId | query | any | Optional | | variantId | query | any | Optional | | offerId | query | any | Optional | | channelId | query | any | Optional | | currencyCode | query | any | Optional | | priceKindId | query | any | Optional | | kind | query | any | Optional | | userId | query | any | Optional | | userGroupId | query | any | Optional | | customerId | query | any | Optional | | customerGroupId | query | any | Optional | | withDeleted | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated prices Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "product_id": null, "variant_id": null, "offer_id": null, "currency_code": null, "price_kind_id": null, "kind": null, "min_quantity": null, "max_quantity": null, "unit_price_net": null, "unit_price_gross": null, "tax_rate": null, "tax_amount": null, "channel_id": null, "user_id": null, "user_group_id": null, "customer_id": null, "customer_group_id": null, "metadata": null, "starts_at": null, "ends_at": null, "created_at": null, "updated_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/catalog/prices?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/prices` Create price Creates a new price entry for a product or variant. Requires features: catalog.pricing.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.pricing.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "currencyCode": "string", "priceKindId": "00000000-0000-4000-8000-000000000000", "taxRateId": null } ``` ### Responses **201** – Price created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/catalog/prices" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "currencyCode": "string", "priceKindId": "00000000-0000-4000-8000-000000000000", "taxRateId": null }' ``` ## PUT `/catalog/prices` Update price Updates an existing price by id. Requires features: catalog.pricing.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.pricing.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "taxRateId": null } ``` ### Responses **200** – Price updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/catalog/prices" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "taxRateId": null }' ``` ## GET `/catalog/product-media` List product media Returns a list of media attachments for a specific product. Requires features: catalog.products.view **Tags:** Catalog **Requires authentication.** **Features:** catalog.products.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | productId | query | any | Required | ### Responses **200** – List of product media Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "fileName": "string", "url": "string", "thumbnailUrl": "string" } ] } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/catalog/product-media?productId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/catalog/products` Delete product Deletes a product by id. Requires features: catalog.products.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.products.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Product deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/catalog/products" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/catalog/products` List products Returns a paginated collection of products scoped to the authenticated organization. Requires features: catalog.products.view **Tags:** Catalog **Requires authentication.** **Features:** catalog.products.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | id | query | any | Optional | | search | query | any | Optional | | status | query | any | Optional | | isActive | query | any | Optional | | configurable | query | any | Optional | | productType | query | any | Optional | | channelIds | query | any | Optional | | channelId | query | any | Optional | | categoryIds | query | any | Optional | | tagIds | query | any | Optional | | offerId | query | any | Optional | | userId | query | any | Optional | | userGroupId | query | any | Optional | | customerId | query | any | Optional | | customerGroupId | query | any | Optional | | quantity | query | any | Optional | | priceDate | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | withDeleted | query | any | Optional | | customFieldset | query | any | Optional | ### Responses **200** – Paginated products Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "title": null, "subtitle": null, "description": null, "sku": null, "handle": null, "product_type": null, "status_entry_id": null, "primary_currency_code": null, "default_unit": null, "default_media_id": null, "default_media_url": null, "weight_value": null, "weight_unit": null, "dimensions": null, "is_configurable": null, "is_active": null, "metadata": null, "custom_fieldset_code": null, "option_schema_id": null, "created_at": null, "updated_at": null, "pricing": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/catalog/products?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/products` Create product Creates a new product in the catalog. Requires features: catalog.products.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.products.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "title": "string", "taxRateId": null, "taxRate": null, "productType": "simple", "defaultMediaId": null, "defaultMediaUrl": null, "weightValue": null, "weightUnit": null, "dimensions": null, "optionSchemaId": null, "customFieldsetCode": null } ``` ### Responses **201** – Product created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/catalog/products" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "title": "string", "taxRateId": null, "taxRate": null, "productType": "simple", "defaultMediaId": null, "defaultMediaUrl": null, "weightValue": null, "weightUnit": null, "dimensions": null, "optionSchemaId": null, "customFieldsetCode": null }' ``` ## PUT `/catalog/products` Update product Updates an existing product by id. Requires features: catalog.products.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.products.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "taxRateId": null, "taxRate": null, "defaultMediaId": null, "defaultMediaUrl": null, "weightValue": null, "weightUnit": null, "dimensions": null, "optionSchemaId": null, "customFieldsetCode": null } ``` ### Responses **200** – Product updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/catalog/products" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "taxRateId": null, "taxRate": null, "defaultMediaId": null, "defaultMediaUrl": null, "weightValue": null, "weightUnit": null, "dimensions": null, "optionSchemaId": null, "customFieldsetCode": null }' ``` ## GET `/catalog/tags` List product tags Returns a paginated collection of product tags scoped to the authenticated organization. Requires features: catalog.products.view **Tags:** Catalog **Requires authentication.** **Features:** catalog.products.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | search | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | ### Responses **200** – Paginated product tags Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "slug": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/catalog/tags?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/catalog/variants` Delete variant Deletes a variant by id. Requires features: catalog.variants.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.variants.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Variant deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/catalog/variants" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/catalog/variants` List variants Returns a paginated collection of variants scoped to the authenticated organization. Requires features: catalog.products.view **Tags:** Catalog **Requires authentication.** **Features:** catalog.products.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | id | query | any | Optional | | search | query | any | Optional | | productId | query | any | Optional | | sku | query | any | Optional | | isActive | query | any | Optional | | isDefault | query | any | Optional | | withDeleted | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated variants Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "product_id": null, "name": null, "sku": null, "barcode": null, "status_entry_id": null, "is_default": null, "is_active": null, "weight_value": null, "weight_unit": null, "dimensions": null, "metadata": null, "option_values": null, "custom_fieldset_code": null, "created_at": null, "updated_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/catalog/variants?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/variants` Create variant Creates a new product variant. Requires features: catalog.variants.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.variants.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "productId": "00000000-0000-4000-8000-000000000000", "defaultMediaId": null, "defaultMediaUrl": null, "taxRateId": null, "taxRate": null, "customFieldsetCode": null } ``` ### Responses **201** – Variant created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/catalog/variants" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "productId": "00000000-0000-4000-8000-000000000000", "defaultMediaId": null, "defaultMediaUrl": null, "taxRateId": null, "taxRate": null, "customFieldsetCode": null }' ``` ## PUT `/catalog/variants` Update variant Updates an existing variant by id. Requires features: catalog.variants.manage **Tags:** Catalog **Requires authentication.** **Features:** catalog.variants.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "defaultMediaId": null, "defaultMediaUrl": null, "taxRateId": null, "taxRate": null, "customFieldsetCode": null } ``` ### Responses **200** – Variant updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/catalog/variants" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "defaultMediaId": null, "defaultMediaUrl": null, "taxRateId": null, "taxRate": null, "customFieldsetCode": null }' ``` ## GET `/configs/cache` GET /configs/cache Requires features: configs.cache.view **Tags:** Configuration **Requires authentication.** **Features:** configs.cache.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/configs/cache" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/configs/cache` POST /configs/cache Requires features: configs.cache.manage **Tags:** Configuration **Requires authentication.** **Features:** configs.cache.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/configs/cache" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/configs/system-status` GET /configs/system-status Requires features: configs.system_status.view **Tags:** Configuration **Requires authentication.** **Features:** configs.system_status.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/configs/system-status" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/configs/system-status` POST /configs/system-status Requires features: configs.manage **Tags:** Configuration **Requires authentication.** **Features:** configs.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/configs/system-status" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/configs/upgrade-actions` GET /configs/upgrade-actions Requires features: configs.manage **Tags:** Configuration **Requires authentication.** **Features:** configs.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/configs/upgrade-actions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/configs/upgrade-actions` POST /configs/upgrade-actions Requires features: configs.manage **Tags:** Configuration **Requires authentication.** **Features:** configs.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/configs/upgrade-actions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/activities` Delete activity Deletes an activity identified by `id`. Accepts id via body or query string. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Activity deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/customers/activities" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/customers/activities` List activitys Returns a paginated collection of activitys scoped to the authenticated organization. Requires features: customers.activities.view **Tags:** Customers **Requires authentication.** **Features:** customers.activities.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | entityId | query | any | Optional | | dealId | query | any | Optional | | activityType | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated activitys Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "entityId": null, "dealId": null, "activityType": "string", "subject": null, "body": null, "occurredAt": null, "createdAt": null, "authorUserId": null, "organizationId": null, "tenantId": null, "activityTypeLabel": null, "authorName": null, "authorEmail": null, "appearanceIcon": null, "appearanceColor": null, "dealTitle": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/activities?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/activities` Create activity Creates a timeline activity linked to an entity or deal. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000", "activityType": "string", "appearanceIcon": null, "appearanceColor": null } ``` ### Responses **201** – Activity created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/customers/activities" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000", "activityType": "string", "appearanceIcon": null, "appearanceColor": null }' ``` ## PUT `/customers/activities` Update activity Updates subject, body, scheduling, or custom fields for an existing activity. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "appearanceIcon": null, "appearanceColor": null } ``` ### Responses **200** – Activity updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/customers/activities" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "appearanceIcon": null, "appearanceColor": null }' ``` ## DELETE `/customers/addresses` Delete address Deletes an address by id. The identifier may be included in the body or query. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Address deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/customers/addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/customers/addresses` List addresss Returns a paginated collection of addresss scoped to the authenticated organization. Requires features: customers.activities.view **Tags:** Customers **Requires authentication.** **Features:** customers.activities.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | entityId | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated addresss Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "entity_id": "00000000-0000-4000-8000-000000000000", "name": null, "purpose": null, "company_name": null, "address_line1": null, "address_line2": null, "building_number": null, "flat_number": null, "city": null, "region": null, "postal_code": null, "country": null, "latitude": null, "longitude": null, "is_primary": null, "organization_id": null, "tenant_id": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/addresses?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/addresses` Create address Creates a customer address record and associates it with the referenced entity. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000", "addressLine1": "string" } ``` ### Responses **201** – Address created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/customers/addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000", "addressLine1": "string" }' ``` ## PUT `/customers/addresses` Update address Updates fields on an existing customer address. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Address updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/customers/addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/customers/comments` Delete comment Deletes a comment identified by `id` supplied via body or query string. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Comment deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/customers/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/customers/comments` List comments Returns a paginated collection of comments scoped to the authenticated organization. Requires features: customers.activities.view **Tags:** Customers **Requires authentication.** **Features:** customers.activities.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | entityId | query | any | Optional | | dealId | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated comments Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "entity_id": null, "deal_id": null, "body": null, "author_user_id": null, "appearance_icon": null, "appearance_color": null, "organization_id": null, "tenant_id": null, "created_at": null, "updated_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/comments?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/comments` Create comment Adds a comment to a customer timeline. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000", "body": "string", "appearanceIcon": null, "appearanceColor": null } ``` ### Responses **201** – Comment created Content-Type: `application/json` ```json { "id": null, "authorUserId": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/customers/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000", "body": "string", "appearanceIcon": null, "appearanceColor": null }' ``` ## PUT `/customers/comments` Update comment Updates an existing timeline comment. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "appearanceIcon": null, "appearanceColor": null } ``` ### Responses **200** – Comment updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/customers/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "appearanceIcon": null, "appearanceColor": null }' ``` ## DELETE `/customers/companies` Delete company Deletes a company by id. The identifier can be provided via body or query. Requires features: customers.companies.manage **Tags:** Customers **Requires authentication.** **Features:** customers.companies.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Company deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/customers/companies" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/customers/companies` List companies Returns a paginated collection of companies scoped to the authenticated organization. Requires features: customers.companies.view **Tags:** Customers **Requires authentication.** **Features:** customers.companies.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | email | query | any | Optional | | emailStartsWith | query | any | Optional | | emailContains | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | status | query | any | Optional | | lifecycleStage | query | any | Optional | | source | query | any | Optional | | hasEmail | query | any | Optional | | hasPhone | query | any | Optional | | hasNextInteraction | query | any | Optional | | createdFrom | query | any | Optional | | createdTo | query | any | Optional | | id | query | any | Optional | | tagIds | query | any | Optional | | tagIdsEmpty | query | any | Optional | ### Responses **200** – Paginated companies Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "description": null, "owner_user_id": null, "primary_email": null, "primary_phone": null, "status": null, "lifecycle_stage": null, "source": null, "next_interaction_at": null, "next_interaction_name": null, "next_interaction_ref_id": null, "next_interaction_icon": null, "next_interaction_color": null, "organization_id": null, "tenant_id": null, "created_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/companies?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/companies` Create company Creates a company record and associated profile data. Requires features: customers.companies.manage **Tags:** Customers **Requires authentication.** **Features:** customers.companies.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "displayName": "string", "nextInteraction": null } ``` ### Responses **201** – Company created Content-Type: `application/json` ```json { "id": null, "companyId": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/customers/companies" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "displayName": "string", "nextInteraction": null }' ``` ## PUT `/customers/companies` Update company Updates company profile fields, tags, or custom attributes. Requires features: customers.companies.manage **Tags:** Customers **Requires authentication.** **Features:** customers.companies.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "nextInteraction": null } ``` ### Responses **200** – Company updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/customers/companies" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "nextInteraction": null }' ``` ## GET `/customers/companies/{id}` Fetch company with related data Returns a company customer record with optional related resources such as addresses, comments, activities, deals, todos, and linked people. **Tags:** Customers ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | include | query | any | Optional | ### Responses **200** – Company detail payload Content-Type: `application/json` ```json { "company": { "id": "00000000-0000-4000-8000-000000000000", "displayName": null, "description": null, "ownerUserId": null, "primaryEmail": null, "primaryPhone": null, "status": null, "lifecycleStage": null, "source": null, "nextInteractionAt": null, "nextInteractionName": null, "nextInteractionRefId": null, "nextInteractionIcon": null, "nextInteractionColor": null, "organizationId": null, "tenantId": null, "createdAt": "string", "updatedAt": "string" }, "profile": null, "customFields": {}, "tags": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "color": null } ], "addresses": [ { "id": "00000000-0000-4000-8000-000000000000", "name": null, "purpose": null, "addressLine1": null, "addressLine2": null, "buildingNumber": null, "flatNumber": null, "city": null, "region": null, "postalCode": null, "country": null, "latitude": null, "longitude": null, "isPrimary": null, "createdAt": "string" } ], "comments": [ { "id": "00000000-0000-4000-8000-000000000000", "body": null, "authorUserId": null, "authorName": null, "authorEmail": null, "dealId": null, "createdAt": "string", "appearanceIcon": null, "appearanceColor": null } ], "activities": [ { "id": "00000000-0000-4000-8000-000000000000", "activityType": "string", "subject": null, "body": null, "occurredAt": null, "dealId": null, "authorUserId": null, "authorName": null, "authorEmail": null, "createdAt": "string", "appearanceIcon": null, "appearanceColor": null } ], "deals": [ { "id": "00000000-0000-4000-8000-000000000000", "title": null, "status": null, "pipelineStage": null, "valueAmount": null, "valueCurrency": null, "probability": null, "expectedCloseAt": null, "ownerUserId": null, "source": null, "createdAt": "string", "updatedAt": "string" } ], "todos": [ { "id": "00000000-0000-4000-8000-000000000000", "todoId": "00000000-0000-4000-8000-000000000000", "todoSource": "string", "createdAt": "string", "createdByUserId": null, "title": null, "isDone": null, "priority": null, "severity": null, "description": null, "dueAt": null, "todoOrganizationId": null, "customValues": null } ], "people": [ { "id": "00000000-0000-4000-8000-000000000000", "displayName": null, "primaryEmail": null, "primaryPhone": null, "status": null, "lifecycleStage": null, "jobTitle": null, "department": null, "createdAt": "string", "organizationId": null } ], "viewer": { "userId": null, "name": null, "email": null } } ``` **400** – Invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden for tenant/organization scope Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Company not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/companies/:id" \ -H "Accept: application/json" ``` ## GET `/customers/dashboard/widgets/customer-todos` Fetch recent customer todo links Returns the most recently created todo links for display on dashboards. Requires features: dashboards.view, customers.widgets.todos **Tags:** Customers **Requires authentication.** **Features:** dashboards.view, customers.widgets.todos ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | limit | query | any | Optional | | tenantId | query | any | Optional | | organizationId | query | any | Optional | ### Responses **200** – Widget payload Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "todoId": "00000000-0000-4000-8000-000000000000", "todoSource": "string", "todoTitle": null, "createdAt": "string", "organizationId": null, "entity": { "id": null, "displayName": null, "kind": null, "ownerUserId": null } } ] } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Widget failed to load Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/dashboard/widgets/customer-todos?limit=5" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/dashboard/widgets/new-customers` Fetch recently created customers Returns the latest customers created within the scoped tenant/organization for dashboard display. Requires features: dashboards.view, customers.widgets.new-customers **Tags:** Customers **Requires authentication.** **Features:** dashboards.view, customers.widgets.new-customers ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | limit | query | any | Optional | | tenantId | query | any | Optional | | organizationId | query | any | Optional | | kind | query | any | Optional | ### Responses **200** – Widget payload Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "displayName": null, "kind": null, "organizationId": null, "createdAt": "string", "ownerUserId": null } ] } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Widget failed to load Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/dashboard/widgets/new-customers?limit=5" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/dashboard/widgets/next-interactions` Fetch upcoming customer interactions Lists upcoming (or optionally past) customer interaction reminders ordered by interaction date. Requires features: dashboards.view, customers.widgets.next-interactions **Tags:** Customers **Requires authentication.** **Features:** dashboards.view, customers.widgets.next-interactions ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | limit | query | any | Optional | | tenantId | query | any | Optional | | organizationId | query | any | Optional | | includePast | query | any | Optional | ### Responses **200** – Widget payload Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "displayName": null, "kind": null, "organizationId": null, "nextInteractionAt": null, "nextInteractionName": null, "nextInteractionIcon": null, "nextInteractionColor": null, "ownerUserId": null } ], "now": "string" } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Widget failed to load Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/dashboard/widgets/next-interactions?limit=5" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/deals` Delete deal Deletes a deal by `id`. The identifier may be provided in the body or query parameters. Requires features: customers.deals.manage **Tags:** Customers **Requires authentication.** **Features:** customers.deals.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Deal deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/customers/deals" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/customers/deals` List deals Returns a paginated collection of deals scoped to the authenticated organization. Requires features: customers.deals.view **Tags:** Customers **Requires authentication.** **Features:** customers.deals.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | status | query | any | Optional | | pipelineStage | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | personEntityId | query | any | Optional | | companyEntityId | query | any | Optional | ### Responses **200** – Paginated deals Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "title": null, "description": null, "status": null, "pipeline_stage": null, "value_amount": null, "value_currency": null, "probability": null, "expected_close_at": null, "owner_user_id": null, "source": null, "organization_id": null, "tenant_id": null, "created_at": null, "updated_at": null, "organizationId": null, "tenantId": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/deals?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/deals` Create deal Creates a sales deal, optionally associating people and companies. Requires features: customers.deals.manage **Tags:** Customers **Requires authentication.** **Features:** customers.deals.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "title": "string" } ``` ### Responses **201** – Deal created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/customers/deals" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "title": "string" }' ``` ## PUT `/customers/deals` Update deal Updates pipeline position, metadata, or associations for an existing deal. Requires features: customers.deals.manage **Tags:** Customers **Requires authentication.** **Features:** customers.deals.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Deal updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/customers/deals" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/customers/deals/{id}` Fetch deal with associations Returns a deal with linked people, companies, custom fields, and viewer context. **Tags:** Customers ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Deal detail payload Content-Type: `application/json` ```json { "deal": { "id": "00000000-0000-4000-8000-000000000000", "title": null, "description": null, "status": null, "pipelineStage": null, "valueAmount": null, "valueCurrency": null, "probability": null, "expectedCloseAt": null, "ownerUserId": null, "source": null, "organizationId": null, "tenantId": null, "createdAt": "string", "updatedAt": "string" }, "people": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "subtitle": null, "kind": "person" } ], "companies": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "subtitle": null, "kind": "company" } ], "customFields": {}, "viewer": { "userId": null, "name": null, "email": null } } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden for tenant/organization scope Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Deal not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/deals/:id" \ -H "Accept: application/json" ``` ## GET `/customers/dictionaries/currency` Resolve currency dictionary Returns the active currency dictionary for the current organization scope, falling back to shared entries when required. Requires features: customers.people.view **Tags:** Customers **Requires authentication.** **Features:** customers.people.view ### Responses **200** – Currency dictionary entries Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "entries": [ { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": null } ] } ``` **404** – Currency dictionary missing Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Unexpected error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/dictionaries/currency" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/dictionaries/{kind}` List dictionary entries Returns the merged dictionary entries for the requested kind, including inherited values. Requires features: customers.people.view **Tags:** Customers **Requires authentication.** **Features:** customers.people.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | kind | path | any | Required | ### Responses **200** – Dictionary entries Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": null, "color": null, "icon": null, "organizationId": null } ] } ``` **400** – Failed to resolve dictionary context Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/dictionaries/:kind" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/dictionaries/{kind}` Create or override dictionary entry Creates a dictionary entry (or updates the existing entry for the same value) within the current organization scope. Requires features: customers.settings.manage **Tags:** Customers **Requires authentication.** **Features:** customers.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | kind | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "value": "string" } ``` ### Responses **200** – Dictionary entry updated Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": null, "color": null, "icon": null, "organizationId": null } ``` **201** – Dictionary entry created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": null, "color": null, "icon": null, "organizationId": null } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Duplicate value conflict Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/customers/dictionaries/:kind" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "value": "string" }' ``` ## DELETE `/customers/dictionaries/{kind}/{id}` Delete dictionary entry Removes a customer dictionary entry by identifier. Requires features: customers.settings.manage **Tags:** Customers **Requires authentication.** **Features:** customers.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | kind | path | any | Required | | id | path | any | Required | ### Responses **200** – Entry deleted Content-Type: `application/json` ```json { "success": true } ``` **404** – Entry not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/customers/dictionaries/:kind/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/customers/dictionaries/{kind}/{id}` Update dictionary entry Updates value, label, color, or icon for an existing customer dictionary entry. Requires features: customers.settings.manage **Tags:** Customers **Requires authentication.** **Features:** customers.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | kind | path | any | Required | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Updated dictionary entry Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": null, "color": null, "icon": null, "organizationId": null } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Entry not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Duplicate value conflict Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://open-mercato.dogtronic.biz/customers/dictionaries/:kind/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{}' ``` ## DELETE `/customers/people` Delete person Deletes a person by id. Request body or query may provide the identifier. Requires features: customers.people.manage **Tags:** Customers **Requires authentication.** **Features:** customers.people.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Person deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/customers/people" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/customers/people` List people Returns a paginated collection of people scoped to the authenticated organization. Requires features: customers.people.view **Tags:** Customers **Requires authentication.** **Features:** customers.people.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | email | query | any | Optional | | emailStartsWith | query | any | Optional | | emailContains | query | any | Optional | | status | query | any | Optional | | lifecycleStage | query | any | Optional | | source | query | any | Optional | | hasEmail | query | any | Optional | | hasPhone | query | any | Optional | | hasNextInteraction | query | any | Optional | | createdFrom | query | any | Optional | | createdTo | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | id | query | any | Optional | | tagIds | query | any | Optional | | tagIdsEmpty | query | any | Optional | ### Responses **200** – Paginated people Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "description": null, "owner_user_id": null, "primary_email": null, "primary_phone": null, "status": null, "lifecycle_stage": null, "source": null, "next_interaction_at": null, "next_interaction_name": null, "next_interaction_ref_id": null, "next_interaction_icon": null, "next_interaction_color": null, "organization_id": null, "tenant_id": null, "created_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/people?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/people` Create person Creates a person contact using scoped organization and tenant identifiers. Requires features: customers.people.manage **Tags:** Customers **Requires authentication.** **Features:** customers.people.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "nextInteraction": null, "firstName": "string", "lastName": "string", "companyEntityId": null } ``` ### Responses **201** – Person created Content-Type: `application/json` ```json { "id": null, "personId": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/customers/people" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "nextInteraction": null, "firstName": "string", "lastName": "string", "companyEntityId": null }' ``` ## PUT `/customers/people` Update person Updates contact details or custom fields for a person. Requires features: customers.people.manage **Tags:** Customers **Requires authentication.** **Features:** customers.people.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "nextInteraction": null, "companyEntityId": null } ``` ### Responses **200** – Person updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/customers/people" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "nextInteraction": null, "companyEntityId": null }' ``` ## GET `/customers/people/check-phone` Find person by phone digits Performs an exact digits comparison (stripping non-numeric characters) to determine whether a customer contact matches the provided phone fragment. Requires features: customers.people.view **Tags:** Customers **Requires authentication.** **Features:** customers.people.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | digits | query | any | Required | ### Responses **200** – Matching contact (if any) Content-Type: `application/json` ```json { "match": null } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/people/check-phone" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/people/{id}` Fetch person with related data Returns a person customer record with optional related resources such as addresses, comments, activities, deals, and todos. **Tags:** Customers ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | include | query | any | Optional | ### Responses **200** – Person detail payload Content-Type: `application/json` ```json { "person": { "id": "00000000-0000-4000-8000-000000000000", "displayName": null, "description": null, "ownerUserId": null, "primaryEmail": null, "primaryPhone": null, "status": null, "lifecycleStage": null, "source": null, "nextInteractionAt": null, "nextInteractionName": null, "nextInteractionRefId": null, "nextInteractionIcon": null, "nextInteractionColor": null, "organizationId": null, "tenantId": null, "createdAt": "string", "updatedAt": "string" }, "profile": null, "customFields": {}, "tags": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "color": null } ], "addresses": [ { "id": "00000000-0000-4000-8000-000000000000", "name": null, "purpose": null, "addressLine1": null, "addressLine2": null, "buildingNumber": null, "flatNumber": null, "city": null, "region": null, "postalCode": null, "country": null, "latitude": null, "longitude": null, "isPrimary": null, "createdAt": "string" } ], "comments": [ { "id": "00000000-0000-4000-8000-000000000000", "body": null, "authorUserId": null, "authorName": null, "authorEmail": null, "dealId": null, "createdAt": "string", "appearanceIcon": null, "appearanceColor": null } ], "activities": [ { "id": "00000000-0000-4000-8000-000000000000", "activityType": "string", "subject": null, "body": null, "occurredAt": null, "dealId": null, "authorUserId": null, "authorName": null, "authorEmail": null, "createdAt": "string", "appearanceIcon": null, "appearanceColor": null } ], "deals": [ { "id": "00000000-0000-4000-8000-000000000000", "title": null, "status": null, "pipelineStage": null, "valueAmount": null, "valueCurrency": null, "probability": null, "expectedCloseAt": null, "ownerUserId": null, "source": null, "createdAt": "string", "updatedAt": "string" } ], "todos": [ { "id": "00000000-0000-4000-8000-000000000000", "todoId": "00000000-0000-4000-8000-000000000000", "todoSource": "string", "createdAt": "string", "createdByUserId": null, "title": null, "isDone": null, "priority": null, "severity": null, "description": null, "dueAt": null, "todoOrganizationId": null, "customValues": null } ], "viewer": { "userId": null, "name": null, "email": null } } ``` **400** – Invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden for tenant/organization scope Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Person not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/people/:id" \ -H "Accept: application/json" ``` ## GET `/customers/settings/address-format` Retrieve address format Returns the current address formatting preference for the selected organization. Requires features: customers.settings.manage **Tags:** Customers **Requires authentication.** **Features:** customers.settings.manage ### Responses **200** – Current address format Content-Type: `application/json` ```json { "addressFormat": "string" } ``` **400** – Organization context missing Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/settings/address-format" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/settings/address-format` Update address format Updates the address format preference for the selected organization. Requires features: customers.settings.manage **Tags:** Customers **Requires authentication.** **Features:** customers.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "addressFormat": "line_first" } ``` ### Responses **200** – Updated address format Content-Type: `application/json` ```json { "addressFormat": "string" } ``` **400** – Invalid payload or organization context Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/customers/settings/address-format" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "addressFormat": "line_first" }' ``` ## DELETE `/customers/tags` Delete tag Deletes a tag identified by `id`. The identifier may be provided via body or query string. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Tag deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/customers/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/customers/tags` List tags Returns a paginated collection of tags scoped to the authenticated organization. Requires features: customers.activities.view **Tags:** Customers **Requires authentication.** **Features:** customers.activities.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated tags Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "slug": "string", "label": "string", "color": null, "description": null, "organization_id": null, "tenant_id": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/tags?page=1&pageSize=100" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/tags` Create tag Creates a tag scoped to the current tenant and organization. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "slug": "string", "label": "string" } ``` ### Responses **201** – Tag created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/customers/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "slug": "string", "label": "string" }' ``` ## PUT `/customers/tags` Update tag Updates label, color, or description for an existing tag. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Tag updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/customers/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## POST `/customers/tags/assign` Assign tag to customer entity Links a tag to a customer entity within the validated tenant / organization scope. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "tagId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **201** – Tag assigned to customer Content-Type: `application/json` ```json { "id": null } ``` **400** – Validation or assignment failed Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/customers/tags/assign" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "tagId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000" }' ``` ## POST `/customers/tags/unassign` Remove tag from customer entity Detaches a tag from a customer entity within the validated tenant / organization scope. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "tagId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Tag unassigned from customer Content-Type: `application/json` ```json { "id": null } ``` **400** – Validation or unassignment failed Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/customers/tags/unassign" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "tagId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/customers/todos` Unlink todo from customer Removes the association between a todo and the specified customer. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Todo unlinked Content-Type: `application/json` ```json { "linkId": null } ``` **400** – Invalid request or missing link id Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/customers/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/customers/todos` List todos linked to customers Returns paginated todo link entries filtered by completion, search term, or entity. Requires features: customers.activities.view **Tags:** Customers **Requires authentication.** **Features:** customers.activities.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | isDone | query | any | Optional | | organizationId | query | any | Optional | | entityId | query | any | Optional | ### Responses **200** – Paginated todo links Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "todoId": "00000000-0000-4000-8000-000000000000", "todoSource": "string", "todoTitle": null, "todoIsDone": null, "todoPriority": null, "todoSeverity": null, "todoDescription": null, "todoDueAt": null, "todoCustomValues": null, "todoOrganizationId": null, "organizationId": null, "tenantId": null, "createdAt": "string", "customer": { "id": null, "displayName": null, "kind": null } } ], "total": 1, "totalPages": 1 } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Unexpected error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/customers/todos?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/todos` Create todo and link to customer Creates a new todo (via the configured source entity) and links it to the specified customer record. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000", "title": "string", "todoSource": "example:todo" } ``` ### Responses **201** – Todo created and linked Content-Type: `application/json` ```json { "todoId": null, "linkId": null } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/customers/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000", "title": "string", "todoSource": "example:todo" }' ``` ## PUT `/customers/todos` Link existing todo to customer Links an existing todo record to a customer entity within the allowed scope. Requires features: customers.activities.manage **Tags:** Customers **Requires authentication.** **Features:** customers.activities.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000", "todoId": "00000000-0000-4000-8000-000000000000", "todoSource": "example:todo" } ``` ### Responses **200** – Todo linked Content-Type: `application/json` ```json { "linkId": null } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/customers/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000", "todoId": "00000000-0000-4000-8000-000000000000", "todoSource": "example:todo" }' ``` ## GET `/dashboards/layout` Load the current dashboard layout Returns the saved widget layout together with the widgets the current user is allowed to place. Requires features: dashboards.view **Tags:** Dashboards **Requires authentication.** **Features:** dashboards.view ### Responses **200** – Current dashboard layout and available widgets. Content-Type: `application/json` ```json { "layout": { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "widgetId": "string", "order": 1 } ] }, "allowedWidgetIds": [ "string" ], "canConfigure": true, "context": { "userId": "00000000-0000-4000-8000-000000000000", "tenantId": null, "organizationId": null, "userName": null, "userEmail": null, "userLabel": "string" }, "widgets": [ { "id": "string", "title": "string", "description": null, "defaultSize": "sm", "defaultEnabled": true, "defaultSettings": null, "features": [ "string" ], "moduleId": "string", "icon": null, "loaderKey": "string", "supportsRefresh": true } ] } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/dashboards/layout" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/dashboards/layout` Persist dashboard layout changes Saves the provided widget ordering, sizes, and settings for the current user. Requires features: dashboards.configure **Tags:** Dashboards **Requires authentication.** **Features:** dashboards.configure ### Request Body Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "widgetId": "string", "order": 1 } ] } ``` ### Responses **200** – Layout updated successfully. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid layout payload Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/dashboards/layout" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "items": [ { "id": "00000000-0000-4000-8000-000000000000", "widgetId": "string", "order": 1 } ] }' ``` ## PATCH `/dashboards/layout/{itemId}` Update a dashboard layout item Adjusts the size or settings for a single widget within the dashboard layout. Requires features: dashboards.configure **Tags:** Dashboards **Requires authentication.** **Features:** dashboards.configure ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | itemId | path | any | Required | ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Layout item updated. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid payload or missing item id Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Item not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://open-mercato.dogtronic.biz/dashboards/layout/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{}' ``` ## GET `/dashboards/roles/widgets` Fetch widget assignments for a role Returns the widgets explicitly assigned to the given role together with the evaluation scope. Requires features: dashboards.admin.assign-widgets **Tags:** Dashboards **Requires authentication.** **Features:** dashboards.admin.assign-widgets ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | roleId | query | any | Required | | tenantId | query | any | Optional | | organizationId | query | any | Optional | ### Responses **200** – Current widget configuration for the role. Content-Type: `application/json` ```json { "widgetIds": [ "string" ], "hasCustom": true, "scope": { "tenantId": null, "organizationId": null } } ``` **400** – Missing role identifier Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/dashboards/roles/widgets?roleId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/dashboards/roles/widgets` Update widgets assigned to a role Persists the widget list for a role within the provided tenant and organization scope. Requires features: dashboards.admin.assign-widgets **Tags:** Dashboards **Requires authentication.** **Features:** dashboards.admin.assign-widgets ### Request Body Content-Type: `application/json` ```json { "roleId": "00000000-0000-4000-8000-000000000000", "tenantId": null, "organizationId": null, "widgetIds": [ "string" ] } ``` ### Responses **200** – Widgets updated successfully. Content-Type: `application/json` ```json { "ok": true, "widgetIds": [ "string" ] } ``` **400** – Invalid payload or unknown widgets Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/dashboards/roles/widgets" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "roleId": "00000000-0000-4000-8000-000000000000", "tenantId": null, "organizationId": null, "widgetIds": [ "string" ] }' ``` ## GET `/dashboards/users/widgets` Read widget overrides for a user Returns the widgets inherited and explicitly configured for the requested user within the current scope. Requires features: dashboards.admin.assign-widgets **Tags:** Dashboards **Requires authentication.** **Features:** dashboards.admin.assign-widgets ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | userId | query | any | Required | | tenantId | query | any | Optional | | organizationId | query | any | Optional | ### Responses **200** – Widget settings for the user. Content-Type: `application/json` ```json { "mode": "inherit", "widgetIds": [ "string" ], "hasCustom": true, "effectiveWidgetIds": [ "string" ], "scope": { "tenantId": null, "organizationId": null } } ``` **400** – Missing user identifier Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/dashboards/users/widgets?userId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/dashboards/users/widgets` Update user-specific dashboard widgets Sets the widget override mode and allowed widgets for a user. Passing `mode: inherit` clears overrides. Requires features: dashboards.admin.assign-widgets **Tags:** Dashboards **Requires authentication.** **Features:** dashboards.admin.assign-widgets ### Request Body Content-Type: `application/json` ```json { "userId": "00000000-0000-4000-8000-000000000000", "tenantId": null, "organizationId": null, "mode": "inherit", "widgetIds": [ "string" ] } ``` ### Responses **200** – Overrides saved. Content-Type: `application/json` ```json { "ok": true, "mode": "inherit", "widgetIds": [ "string" ] } ``` **400** – Invalid payload or unknown widgets Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/dashboards/users/widgets" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "userId": "00000000-0000-4000-8000-000000000000", "tenantId": null, "organizationId": null, "mode": "inherit", "widgetIds": [ "string" ] }' ``` ## GET `/dashboards/widgets/catalog` List available dashboard widgets Returns the catalog of widgets that modules expose, including defaults and feature requirements. Requires features: dashboards.admin.assign-widgets **Tags:** Dashboards **Requires authentication.** **Features:** dashboards.admin.assign-widgets ### Responses **200** – Widgets available for assignment. Content-Type: `application/json` ```json { "items": [ { "id": "string", "title": "string", "description": null, "defaultSize": "sm", "defaultEnabled": true, "defaultSettings": null, "features": [ "string" ], "moduleId": "string", "icon": null, "loaderKey": "string", "supportsRefresh": true } ] } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/dashboards/widgets/catalog" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/dictionaries` List dictionaries Returns dictionaries accessible to the current organization, optionally including inactive records. Requires features: dictionaries.view **Tags:** Dictionaries **Requires authentication.** **Features:** dictionaries.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | includeInactive | query | any | Optional | ### Responses **200** – Dictionary collection. Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "name": "string", "description": null, "isSystem": true, "isActive": true, "managerVisibility": null, "organizationId": null, "createdAt": "string", "updatedAt": null } ] } ``` **500** – Failed to load dictionaries Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/dictionaries" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/dictionaries` Create dictionary Registers a dictionary scoped to the current organization. Requires features: dictionaries.manage **Tags:** Dictionaries **Requires authentication.** **Features:** dictionaries.manage ### Request Body Content-Type: `application/json` ```json { "key": "string", "name": "string" } ``` ### Responses **201** – Dictionary created. Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "name": "string", "description": null, "isSystem": true, "isActive": true, "managerVisibility": null, "organizationId": null, "createdAt": "string", "updatedAt": null } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Dictionary key already exists Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to create dictionary Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/dictionaries" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "key": "string", "name": "string" }' ``` ## DELETE `/dictionaries/{dictionaryId}` Delete dictionary Soft deletes the dictionary unless it is the protected currency dictionary. Requires features: dictionaries.manage **Tags:** Dictionaries **Requires authentication.** **Features:** dictionaries.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Responses **200** – Dictionary archived. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Protected dictionary cannot be deleted Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to delete dictionary Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/dictionaries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/dictionaries/{dictionaryId}` Get dictionary Returns details for the specified dictionary, including inheritance flags. Requires features: dictionaries.view **Tags:** Dictionaries **Requires authentication.** **Features:** dictionaries.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Responses **200** – Dictionary details. Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "name": "string", "description": null, "isSystem": true, "isActive": true, "managerVisibility": null, "organizationId": null, "createdAt": "string", "updatedAt": null } ``` **400** – Invalid parameters Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to load dictionary Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/dictionaries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/dictionaries/{dictionaryId}` Update dictionary Updates mutable attributes of the dictionary. Currency dictionaries are protected from modification. Requires features: dictionaries.manage **Tags:** Dictionaries **Requires authentication.** **Features:** dictionaries.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Dictionary updated. Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "name": "string", "description": null, "isSystem": true, "isActive": true, "managerVisibility": null, "organizationId": null, "createdAt": "string", "updatedAt": null } ``` **400** – Validation failed or protected dictionary Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Dictionary key already exists Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to update dictionary Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://open-mercato.dogtronic.biz/dictionaries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{}' ``` ## GET `/dictionaries/{dictionaryId}/entries` List dictionary entries Returns entries for the specified dictionary ordered alphabetically. Requires features: dictionaries.view **Tags:** Dictionaries **Requires authentication.** **Features:** dictionaries.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Responses **200** – Dictionary entries. Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": "string", "color": null, "icon": null, "createdAt": "string", "updatedAt": null } ] } ``` **400** – Invalid parameters Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to load dictionary entries Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/dictionaries/00000000-0000-4000-8000-000000000000/entries" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/dictionaries/{dictionaryId}/entries` Create dictionary entry Creates a new entry in the specified dictionary. Requires features: dictionaries.manage **Tags:** Dictionaries **Requires authentication.** **Features:** dictionaries.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "value": "string", "color": null, "icon": null } ``` ### Responses **201** – Dictionary entry created. Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": "string", "color": null, "icon": null, "createdAt": "string", "updatedAt": null } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to create dictionary entry Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/dictionaries/00000000-0000-4000-8000-000000000000/entries" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "value": "string", "color": null, "icon": null }' ``` ## DELETE `/dictionaries/{dictionaryId}/entries/{entryId}` Delete dictionary entry Deletes the specified dictionary entry via the command bus. Requires features: dictionaries.manage **Tags:** Dictionaries **Requires authentication.** **Features:** dictionaries.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | | entryId | path | any | Required | ### Responses **200** – Entry deleted. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary or entry not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to delete entry Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/dictionaries/00000000-0000-4000-8000-000000000000/entries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/dictionaries/{dictionaryId}/entries/{entryId}` Update dictionary entry Updates the specified dictionary entry using the command bus pipeline. Requires features: dictionaries.manage **Tags:** Dictionaries **Requires authentication.** **Features:** dictionaries.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | | entryId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "color": null, "icon": null } ``` ### Responses **200** – Dictionary entry updated. Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": "string", "color": null, "icon": null, "createdAt": "string", "updatedAt": null } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary or entry not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to update entry Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://open-mercato.dogtronic.biz/dictionaries/00000000-0000-4000-8000-000000000000/entries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "color": null, "icon": null }' ``` ## GET `/directory/organization-switcher` Load organization switcher menu Returns the hierarchical menu of organizations the current user may switch to within the active tenant. **Tags:** Directory **Requires authentication.** ### Responses **200** – Organization switcher payload. Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "depth": 1, "selectable": true, "children": [] } ], "selectedId": null, "canManage": true, "tenantId": null, "tenants": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "isActive": true } ], "isSuperAdmin": true } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/directory/organization-switcher" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/directory/organizations` Delete organization Soft deletes an organization identified by id. Requires features: directory.organizations.manage **Tags:** Directory **Requires authentication.** **Features:** directory.organizations.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Organization deleted. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/directory/organizations" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/directory/organizations` List organizations Returns organizations using options, tree, or paginated manage view depending on the `view` parameter. Requires features: directory.organizations.view **Tags:** Directory **Requires authentication.** **Features:** directory.organizations.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | view | query | any | Optional | | ids | query | any | Optional | | tenantId | query | any | Optional | | includeInactive | query | any | Optional | | status | query | any | Optional | ### Responses **200** – Organization data for the requested view. Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "parentId": null, "parentName": null, "tenantId": null, "tenantName": null, "rootId": null, "treePath": null } ] } ``` **400** – Invalid query or tenant scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/directory/organizations?page=1&pageSize=50&view=options" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/directory/organizations` Create organization Creates a new organization within a tenant and optionally assigns hierarchy relationships. Requires features: directory.organizations.manage **Tags:** Directory **Requires authentication.** **Features:** directory.organizations.manage ### Request Body Content-Type: `application/json` ```json { "name": "string", "parentId": null } ``` ### Responses **201** – Organization created. Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/directory/organizations" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "name": "string", "parentId": null }' ``` ## PUT `/directory/organizations` Update organization Updates organization details and hierarchy assignments. Requires features: directory.organizations.manage **Tags:** Directory **Requires authentication.** **Features:** directory.organizations.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "parentId": null } ``` ### Responses **200** – Organization updated. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/directory/organizations" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "parentId": null }' ``` ## DELETE `/directory/tenants` Delete tenant Soft deletes the tenant identified by id. Requires features: directory.tenants.manage **Tags:** Directory **Requires authentication.** **Features:** directory.tenants.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Tenant removed. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/directory/tenants" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/directory/tenants` List tenants Returns tenants visible to the current user with optional search and pagination. Requires features: directory.tenants.view **Tags:** Directory **Requires authentication.** **Features:** directory.tenants.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | isActive | query | any | Optional | ### Responses **200** – Paged list of tenants. Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "isActive": true, "createdAt": null, "updatedAt": null } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/directory/tenants?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/directory/tenants` Create tenant Creates a new tenant and returns its identifier. Requires features: directory.tenants.manage **Tags:** Directory **Requires authentication.** **Features:** directory.tenants.manage ### Request Body Content-Type: `application/json` ```json { "name": "string" } ``` ### Responses **201** – Tenant created. Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/directory/tenants" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "name": "string" }' ``` ## PUT `/directory/tenants` Update tenant Updates tenant properties such as name or activation state. Requires features: directory.tenants.manage **Tags:** Directory **Requires authentication.** **Features:** directory.tenants.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Tenant updated. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/directory/tenants" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/entities/definitions` Soft delete custom field definition Marks the specified definition inactive and tombstones it for the current scope. Requires features: entities.definitions.manage **Tags:** Entities **Requires authentication.** **Features:** entities.definitions.manage ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "key": "string" } ``` ### Responses **200** – Definition deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Missing entity id or key Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Definition not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/entities/definitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "entityId": "string", "key": "string" }' ``` ## GET `/entities/definitions` List active custom field definitions Returns active custom field definitions for the supplied entity ids, respecting tenant scope and tombstones. **Tags:** Entities **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityId | query | any | Optional | | entityIds | query | any | Optional | | fieldset | query | any | Optional | ### Responses **200** – Definition list Content-Type: `application/json` ```json { "items": [ { "key": "string", "kind": "string", "label": "string", "entityId": "string" } ] } ``` **400** – Missing entity id Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/entities/definitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/entities/definitions` Upsert custom field definition Creates or updates a custom field definition for the current tenant/org scope. Requires features: entities.definitions.manage **Tags:** Entities **Requires authentication.** **Features:** entities.definitions.manage ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "key": "string", "kind": "text" } ``` ### Responses **200** – Definition saved Content-Type: `application/json` ```json { "ok": true, "item": { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "kind": "string", "configJson": {} } } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/entities/definitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "entityId": "string", "key": "string", "kind": "text" }' ``` ## POST `/entities/definitions.batch` Save multiple custom field definitions Creates or updates multiple definitions for a single entity in one transaction. Requires features: entities.definitions.manage **Tags:** Entities **Requires authentication.** **Features:** entities.definitions.manage ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "definitions": [ { "key": "string", "kind": "text" } ] } ``` ### Responses **200** – Definitions saved Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation error Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Unexpected failure Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/entities/definitions.batch" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "entityId": "string", "definitions": [ { "key": "string", "kind": "text" } ] }' ``` ## GET `/entities/definitions.manage` Get management snapshot Returns scoped custom field definitions (including inactive tombstones) for administration interfaces. Requires features: entities.definitions.manage **Tags:** Entities **Requires authentication.** **Features:** entities.definitions.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityId | query | any | Required | ### Responses **200** – Scoped definitions and deleted keys Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "kind": "string", "configJson": null, "organizationId": null, "tenantId": null } ], "deletedKeys": [ "string" ] } ``` **400** – Missing entity id Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/entities/definitions.manage?entityId=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/entities/definitions.restore` Restore definition Reactivates a previously soft-deleted definition within the current tenant/org scope. Requires features: entities.definitions.manage **Tags:** Entities **Requires authentication.** **Features:** entities.definitions.manage ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "key": "string" } ``` ### Responses **200** – Definition restored Content-Type: `application/json` ```json { "ok": true } ``` **400** – Missing entity id or key Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Definition not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/entities/definitions.restore" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "entityId": "string", "key": "string" }' ``` ## DELETE `/entities/entities` Soft delete custom entity Marks the specified custom entity inactive within the current scope. Requires features: entities.definitions.manage **Tags:** Entities **Requires authentication.** **Features:** entities.definitions.manage ### Request Body Content-Type: `application/json` ```json { "entityId": "string" } ``` ### Responses **200** – Entity deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Missing entity id Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Entity not found in scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/entities/entities" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "entityId": "string" }' ``` ## GET `/entities/entities` List available entities Returns generated and custom entities scoped to the caller with field counts per entity. **Tags:** Entities **Requires authentication.** ### Responses **200** – List of entities Content-Type: `application/json` ```json { "items": [ { "entityId": "string", "source": "code", "label": "string", "count": 1 } ] } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/entities/entities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/entities/entities` Upsert custom entity Creates or updates a tenant/org scoped custom entity definition. Requires features: entities.definitions.manage **Tags:** Entities **Requires authentication.** **Features:** entities.definitions.manage ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "label": "string", "description": null, "showInSidebar": false } ``` ### Responses **200** – Entity saved Content-Type: `application/json` ```json { "ok": true, "item": { "id": "00000000-0000-4000-8000-000000000000", "entityId": "string", "label": "string" } } ``` **400** – Validation error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/entities/entities" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "entityId": "string", "label": "string", "description": null, "showInSidebar": false }' ``` ## DELETE `/entities/records` Delete record Soft deletes the specified record within the current tenant/org scope. Requires features: entities.records.manage **Tags:** Entities **Requires authentication.** **Features:** entities.records.manage ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "recordId": "string" } ``` ### Responses **200** – Record deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Missing entity id or record id Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Record not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Unexpected failure Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/entities/records" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "entityId": "string", "recordId": "string" }' ``` ## GET `/entities/records` List records Returns paginated records for the supplied entity. Supports custom field filters, exports, and soft-delete toggles. Requires features: entities.records.view **Tags:** Entities **Requires authentication.** **Features:** entities.records.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityId | query | any | Required | | page | query | any | Optional | | pageSize | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | withDeleted | query | any | Optional | | format | query | any | Optional | | exportScope | query | any | Optional | | export_scope | query | any | Optional | | all | query | any | Optional | | full | query | any | Optional | ### Responses **200** – Paginated records Content-Type: `application/json` ```json { "items": [ {} ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` **400** – Missing entity id Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Unexpected failure Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/entities/records?entityId=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/entities/records` Create record Creates a record for the given entity. When `recordId` is omitted or not a UUID the data engine will generate one automatically. Requires features: entities.records.manage **Tags:** Entities **Requires authentication.** **Features:** entities.records.manage ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "values": {} } ``` ### Responses **200** – Record created Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failure Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Unexpected failure Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/entities/records" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "entityId": "string", "values": {} }' ``` ## PUT `/entities/records` Update record Updates an existing record. If the provided recordId is not a UUID the record will be created instead to support optimistic flows. Requires features: entities.records.manage **Tags:** Entities **Requires authentication.** **Features:** entities.records.manage ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "recordId": "string", "values": {} } ``` ### Responses **200** – Record updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failure Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Unexpected failure Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/entities/records" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "entityId": "string", "recordId": "string", "values": {} }' ``` ## GET `/entities/relations/options` List relation options Returns up to 50 option entries for populating relation dropdowns, automatically resolving label fields when omitted. Requires features: entities.definitions.view **Tags:** Entities **Requires authentication.** **Features:** entities.definitions.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityId | query | any | Required | | labelField | query | any | Optional | | q | query | any | Optional | ### Responses **200** – Option list Content-Type: `application/json` ```json { "items": [ { "value": "string", "label": "string" } ] } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/entities/relations/options?entityId=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/entities/sidebar-entities` Get sidebar entities Returns custom entities flagged with `showInSidebar` for the current tenant/org scope. **Tags:** Entities **Requires authentication.** ### Responses **200** – Sidebar entities for navigation Content-Type: `application/json` ```json { "items": [ { "entityId": "string", "label": "string", "href": "string" } ] } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/entities/sidebar-entities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/example/assignees` List example assignees Returns mock assignee options filtered by the optional `q` query parameter. Requires features: example.todos.view **Tags:** Example **Requires authentication.** **Features:** example.todos.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | q | query | any | Optional | ### Responses **200** – Assignable users. Content-Type: `application/json` ```json { "items": [ { "value": "string", "label": "string" } ] } ``` **500** – Unexpected server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/example/assignees" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/example/blog/{id}` Fetch demo blog payload Returns a placeholder blog record containing the provided identifier. **Tags:** Example ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Placeholder blog payload. Content-Type: `application/json` ```json { "id": "string", "method": "GET" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/example/blog/string" \ -H "Accept: application/json" ``` ## POST `/example/blog/{id}` Create demo blog payload Echoes the provided identifier as a placeholder write endpoint. **Tags:** Example ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Placeholder confirmation. Content-Type: `application/json` ```json { "id": "string", "method": "POST" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/example/blog/string" \ -H "Accept: application/json" ``` ## GET `/example/organizations` Resolve organization labels Fetches organization names for the provided identifiers within the current tenant scope. Requires features: example.todos.view **Tags:** Example **Requires authentication.** **Features:** example.todos.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | ids | query | any | Optional | ### Responses **200** – Resolved organizations. Content-Type: `application/json` ```json { "items": [ { "value": "string", "label": "string" } ] } ``` **500** – Unexpected server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/example/organizations" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/example/tags` List example tags Returns tag options collected from custom field values and dictionary configuration. Requires features: example.todos.view **Tags:** Example **Requires authentication.** **Features:** example.todos.view ### Responses **200** – Available tag options. Content-Type: `application/json` ```json { "items": [ { "value": "string", "label": "string" } ] } ``` **500** – Failed to resolve tags Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/example/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/example/todos` Delete todo Deletes a todo by id. Provide the identifier in the request body. Requires features: example.todos.manage **Tags:** Example **Requires authentication.** **Features:** example.todos.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Todo deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/example/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/example/todos` List todos Returns a paginated collection of todos in the current tenant scope. Requires features: example.todos.view **Tags:** Example **Requires authentication.** **Features:** example.todos.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | title | query | any | Optional | | isDone | query | any | Optional | | withDeleted | query | any | Optional | | organizationId | query | any | Optional | | createdFrom | query | any | Optional | | createdTo | query | any | Optional | | format | query | any | Optional | ### Responses **200** – Paginated todos Content-Type: `application/json` ```json { "items": [ { "id": "string", "title": "string", "tenant_id": null, "organization_id": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/example/todos?page=1&pageSize=50&sortField=id&sortDir=asc&withDeleted=false&format=json" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/example/todos` Create todo Creates a todo record. Supports additional custom field keys prefixed with `cf_`. Requires features: example.todos.manage **Tags:** Example **Requires authentication.** **Features:** example.todos.manage ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **201** – Todo created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/example/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{}' ``` ## PUT `/example/todos` Update todo Updates an existing todo record by id. Accepts base fields and optional `cf_` custom fields. Requires features: example.todos.manage **Tags:** Example **Requires authentication.** **Features:** example.todos.manage ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Todo updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/example/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{}' ``` ## POST `/onboarding/onboarding` Self-service onboarding submission **Tags:** Onboarding ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/onboarding/onboarding" \ -H "Accept: application/json" ``` ## GET `/onboarding/onboarding/verify` Onboarding verification redirect **Tags:** Onboarding ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/onboarding/onboarding/verify" \ -H "Accept: application/json" ``` ## GET `/perspectives/{tableId}` Load perspectives for a table Returns personal perspectives and available role defaults for the requested table identifier. Requires features: perspectives.use **Tags:** Perspectives **Requires authentication.** **Features:** perspectives.use ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | tableId | path | any | Required | ### Responses **200** – Current perspectives and defaults. Content-Type: `application/json` ```json { "tableId": "string", "perspectives": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "tableId": "string", "settings": {}, "isDefault": true, "createdAt": "string", "updatedAt": null } ], "defaultPerspectiveId": null, "rolePerspectives": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "tableId": "string", "settings": {}, "isDefault": true, "createdAt": "string", "updatedAt": null, "roleId": "00000000-0000-4000-8000-000000000000", "tenantId": null, "organizationId": null, "roleName": null } ], "roles": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "hasPerspective": true, "hasDefault": true } ], "canApplyToRoles": true } ``` **400** – Invalid table identifier Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/perspectives/string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/perspectives/{tableId}` Create or update a perspective Saves a personal perspective and optionally applies the same configuration to selected roles. Requires features: perspectives.use **Tags:** Perspectives **Requires authentication.** **Features:** perspectives.use ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | tableId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "name": "string", "settings": {} } ``` ### Responses **200** – Perspective saved successfully. Content-Type: `application/json` ```json { "perspective": { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "tableId": "string", "settings": {}, "isDefault": true, "createdAt": "string", "updatedAt": null }, "rolePerspectives": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "tableId": "string", "settings": {}, "isDefault": true, "createdAt": "string", "updatedAt": null, "roleId": "00000000-0000-4000-8000-000000000000", "tenantId": null, "organizationId": null, "roleName": null } ], "clearedRoleIds": [ "00000000-0000-4000-8000-000000000000" ] } ``` **400** – Validation failed or invalid roles provided Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/perspectives/string" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "name": "string", "settings": {} }' ``` ## DELETE `/perspectives/{tableId}/roles/{roleId}` Clear role perspectives for a table Removes all role-level perspectives associated with the provided role identifier for the table. Requires features: perspectives.role_defaults **Tags:** Perspectives **Requires authentication.** **Features:** perspectives.role_defaults ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | tableId | path | any | Required | | roleId | path | any | Required | ### Responses **200** – Role perspectives cleared. Content-Type: `application/json` ```json { "success": true } ``` **400** – Invalid identifiers supplied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found in scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/perspectives/string/roles/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/perspectives/{tableId}/{perspectiveId}` Delete a personal perspective Removes a perspective owned by the current user for the given table. Requires features: perspectives.use **Tags:** Perspectives **Requires authentication.** **Features:** perspectives.use ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | tableId | path | any | Required | | perspectiveId | path | any | Required | ### Responses **200** – Perspective removed. Content-Type: `application/json` ```json { "success": true } ``` **400** – Invalid identifiers supplied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Perspective not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/perspectives/string/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/query_index/purge` Purge query index records Queues a purge job to remove indexed records for an entity type within the active scope. Requires features: query_index.purge **Tags:** Query Index **Requires authentication.** **Features:** query_index.purge ### Request Body Content-Type: `application/json` ```json { "entityType": "string" } ``` ### Responses **200** – Purge job accepted. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Missing entity type Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/query_index/purge" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "entityType": "string" }' ``` ## POST `/query_index/reindex` Trigger query index rebuild Queues a reindex job for the specified entity type within the current tenant scope. Requires features: query_index.reindex **Tags:** Query Index **Requires authentication.** **Features:** query_index.reindex ### Request Body Content-Type: `application/json` ```json { "entityType": "string" } ``` ### Responses **200** – Reindex job accepted. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Missing entity type Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/query_index/reindex" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "entityType": "string" }' ``` ## GET `/query_index/status` Inspect query index coverage Returns entity counts comparing base tables with the query index along with the latest job status. Requires features: query_index.status.view **Tags:** Query Index **Requires authentication.** **Features:** query_index.status.view ### Responses **200** – Current query index status. Content-Type: `application/json` ```json { "items": [ { "entityId": "string", "label": "string", "baseCount": null, "indexCount": null, "vectorCount": null, "ok": true, "job": { "status": "idle", "startedAt": null, "finishedAt": null, "heartbeatAt": null, "processedCount": null, "totalCount": null, "scope": null } } ], "errors": [ { "id": "string", "source": "string", "handler": "string", "entityType": null, "recordId": null, "tenantId": null, "organizationId": null, "message": "string", "stack": null, "payload": null, "occurredAt": "string" } ], "logs": [ { "id": "string", "source": "string", "handler": "string", "level": "info", "entityType": null, "recordId": null, "tenantId": null, "organizationId": null, "message": "string", "details": null, "occurredAt": "string" } ] } ``` **400** – Tenant or organization context required Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/query_index/status" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/adjustment-kinds` Delete sales adjustment kind Deletes an adjustment kind. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Sales adjustment kind deleted Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/adjustment-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{}' ``` ## GET `/sales/adjustment-kinds` List sales adjustment kinds Returns a paginated collection of sales adjustment kinds that belong to the current organization. Requires features: sales.orders.view **Tags:** Sales **Requires authentication.** **Features:** sales.orders.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated sales adjustment kinds Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": null, "color": null, "icon": null, "organizationId": null, "tenantId": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/adjustment-kinds?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/adjustment-kinds` Create sales adjustment kind Creates an adjustment kind. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **201** – Sales adjustment kind created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/adjustment-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{}' ``` ## PUT `/sales/adjustment-kinds` Update sales adjustment kind Updates an adjustment kind. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Sales adjustment kind updated Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/adjustment-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{}' ``` ## DELETE `/sales/channels` Delete sales channel Deletes a sales channel identified by id. Requires features: sales.channels.manage **Tags:** Sales **Requires authentication.** **Features:** sales.channels.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Sales channel deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/channels` List sales channels Manage sales channels to segment orders and pricing across marketplaces or stores. Requires features: sales.channels.manage **Tags:** Sales **Requires authentication.** **Features:** sales.channels.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | id | query | any | Optional | | ids | query | any | Optional | | isActive | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | withDeleted | query | any | Optional | ### Responses **200** – Paginated sales channels Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "code": null, "description": null, "statusEntryId": null, "isActive": true, "organizationId": null, "tenantId": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/channels?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/channels` Create sales channel Creates a new sales channel. Requires features: sales.channels.manage **Tags:** Sales **Requires authentication.** **Features:** sales.channels.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "code": "string" } ``` ### Responses **201** – Sales channel created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "code": "string" }' ``` ## PUT `/sales/channels` Update sales channel Updates an existing sales channel by id. Requires features: sales.channels.manage **Tags:** Sales **Requires authentication.** **Features:** sales.channels.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "code": "string" } ``` ### Responses **200** – Sales channel updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "code": "string" }' ``` ## DELETE `/sales/delivery-windows` Delete delivery window Deletes a delivery window identified by id. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Delivery window deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/delivery-windows" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/delivery-windows` List delivery windows Define delivery windows to communicate lead times and cut-off rules for sales orders. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | isActive | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | withDeleted | query | any | Optional | ### Responses **200** – Paginated delivery windows Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "code": null, "description": null, "leadTimeDays": null, "cutoffTime": null, "timezone": null, "isActive": true, "metadata": null, "organizationId": null, "tenantId": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/delivery-windows?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/delivery-windows` Create delivery window Creates a new delivery window. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "code": "string" } ``` ### Responses **201** – Delivery window created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/delivery-windows" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "code": "string" }' ``` ## PUT `/sales/delivery-windows` Update delivery window Updates an existing delivery window by id. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Delivery window updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/delivery-windows" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/sales/document-addresses` Delete document address Deletes a sales document address. **Tags:** Sales **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "documentId": "00000000-0000-4000-8000-000000000000", "documentKind": "order" } ``` ### Responses **200** – Document address deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/document-addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "documentId": "00000000-0000-4000-8000-000000000000", "documentKind": "order" }' ``` ## GET `/sales/document-addresses` List document addresss Returns a paginated collection of document addresss that belong to the current organization. **Tags:** Sales **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | documentId | query | any | Optional | | documentKind | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated document addresss Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "document_id": "00000000-0000-4000-8000-000000000000", "document_kind": "order", "customer_address_id": null, "name": null, "purpose": null, "company_name": null, "address_line1": "string", "address_line2": null, "building_number": null, "flat_number": null, "city": null, "region": null, "postal_code": null, "country": null, "latitude": null, "longitude": null, "created_at": "string", "updated_at": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/document-addresses?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/document-addresses` Create document address Creates a sales document address linked to an order or quote. **Tags:** Sales **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "documentId": "00000000-0000-4000-8000-000000000000", "documentKind": "order", "name": null, "purpose": null, "companyName": null, "addressLine1": "string", "addressLine2": null, "city": null, "region": null, "postalCode": null, "country": null, "buildingNumber": null, "flatNumber": null, "latitude": null, "longitude": null } ``` ### Responses **201** – Document address created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/document-addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "documentId": "00000000-0000-4000-8000-000000000000", "documentKind": "order", "name": null, "purpose": null, "companyName": null, "addressLine1": "string", "addressLine2": null, "city": null, "region": null, "postalCode": null, "country": null, "buildingNumber": null, "flatNumber": null, "latitude": null, "longitude": null }' ``` ## PUT `/sales/document-addresses` Update document address Updates a sales document address. **Tags:** Sales **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "id": "00000000-0000-4000-8000-000000000000", "documentId": "00000000-0000-4000-8000-000000000000", "documentKind": "order", "name": null, "purpose": null, "companyName": null, "addressLine1": "string", "addressLine2": null, "city": null, "region": null, "postalCode": null, "country": null, "buildingNumber": null, "flatNumber": null, "latitude": null, "longitude": null } ``` ### Responses **200** – Document address updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/document-addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "id": "00000000-0000-4000-8000-000000000000", "documentId": "00000000-0000-4000-8000-000000000000", "documentKind": "order", "name": null, "purpose": null, "companyName": null, "addressLine1": "string", "addressLine2": null, "city": null, "region": null, "postalCode": null, "country": null, "buildingNumber": null, "flatNumber": null, "latitude": null, "longitude": null }' ``` ## POST `/sales/document-numbers` Generate next number Generates the next sales order or quote number using configured formatting rules. **Tags:** Sales **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "kind": "order" } ``` ### Responses **200** – Generated number Content-Type: `application/json` ```json { "number": "string", "format": "string", "sequence": 1 } ``` **400** – Invalid input or scope missing Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/document-numbers" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "kind": "order" }' ``` ## DELETE `/sales/notes` Delete sales note Deletes a sales note. **Tags:** Sales **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Sales note deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/notes" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/notes` List sales notes Returns a paginated collection of sales notes that belong to the current organization. **Tags:** Sales **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | contextType | query | any | Optional | | contextId | query | any | Optional | | orderId | query | any | Optional | | quoteId | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated sales notes Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "context_type": "order", "context_id": "00000000-0000-4000-8000-000000000000", "order_id": null, "quote_id": null, "body": null, "author_user_id": null, "appearance_icon": null, "appearance_color": null, "organization_id": null, "tenant_id": null, "created_at": null, "updated_at": null } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/notes?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/notes` Create sales note Creates a note attached to a sales document. **Tags:** Sales **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "contextType": "order", "contextId": "00000000-0000-4000-8000-000000000000", "body": "string", "appearanceIcon": null, "appearanceColor": null } ``` ### Responses **201** – Sales note created Content-Type: `application/json` ```json { "id": null, "authorUserId": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/notes" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "contextType": "order", "contextId": "00000000-0000-4000-8000-000000000000", "body": "string", "appearanceIcon": null, "appearanceColor": null }' ``` ## PUT `/sales/notes` Update sales note Updates a sales note. **Tags:** Sales **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "appearanceIcon": null, "appearanceColor": null } ``` ### Responses **200** – Sales note updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/notes" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "appearanceIcon": null, "appearanceColor": null }' ``` ## DELETE `/sales/order-adjustments` Delete order adjustment Deletes an order adjustment and recalculates totals. **Tags:** Sales ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "orderId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Order adjustment deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/order-adjustments" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "orderId": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/order-adjustments` List order adjustments Returns a paginated collection of order adjustments that belong to the current organization. **Tags:** Sales ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | orderId | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated order adjustments Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "order_id": "00000000-0000-4000-8000-000000000000", "order_line_id": null, "scope": "string", "kind": "string", "code": null, "label": null, "calculator_key": null, "promotion_id": null, "rate": 1, "amount_net": 1, "amount_gross": 1, "currency_code": null, "metadata": null, "position": 1, "created_at": "string", "updated_at": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/order-adjustments?page=1&pageSize=50" \ -H "Accept: application/json" ``` ## POST `/sales/order-adjustments` Create order adjustment Creates an order adjustment and recalculates totals. **Tags:** Sales ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "orderId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **201** – Order adjustment created Content-Type: `application/json` ```json { "id": null, "orderId": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/order-adjustments" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "orderId": "00000000-0000-4000-8000-000000000000" }' ``` ## PUT `/sales/order-adjustments` Update order adjustment Updates an order adjustment and recalculates totals. **Tags:** Sales ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "orderId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Order adjustment updated Content-Type: `application/json` ```json { "id": null, "orderId": null } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/order-adjustments" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "orderId": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/sales/order-line-statuses` Delete order line status Deletes a order line status identified by id. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Order line status deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/order-line-statuses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/order-line-statuses` List order line statuses Manage custom order line statuses available for sales documents. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated order line statuses Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": null, "color": null, "icon": null, "organizationId": null, "tenantId": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/order-line-statuses?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/order-line-statuses` Create order line status Creates a new order line status. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "value": "string", "color": null, "icon": null } ``` ### Responses **201** – Order line status created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/order-line-statuses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "value": "string", "color": null, "icon": null }' ``` ## PUT `/sales/order-line-statuses` Update order line status Updates an existing order line status by id. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "color": null, "icon": null, "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Order line status updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/order-line-statuses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "color": null, "icon": null, "id": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/sales/order-lines` Delete order line Deletes an order line and recalculates totals. **Tags:** Sales ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "orderId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Order line deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/order-lines" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "orderId": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/order-lines` List order lines Returns a paginated collection of order lines that belong to the current organization. **Tags:** Sales ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | id | query | any | Optional | | orderId | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated order lines Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "order_id": "00000000-0000-4000-8000-000000000000", "line_number": 1, "kind": "string", "status_entry_id": null, "status": null, "product_id": null, "product_variant_id": null, "catalog_snapshot": null, "name": null, "description": null, "comment": null, "quantity": 1, "quantity_unit": null, "currency_code": "string", "unit_price_net": 1, "unit_price_gross": 1, "discount_amount": 1, "discount_percent": 1, "tax_rate": 1, "tax_amount": 1, "total_net_amount": 1, "total_gross_amount": 1, "configuration": null, "promotion_code": null, "promotion_snapshot": null, "metadata": null, "custom_field_set_id": null, "created_at": "string", "updated_at": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/order-lines?page=1&pageSize=50" \ -H "Accept: application/json" ``` ## POST `/sales/order-lines` Create order line Creates an order line and recalculates totals. **Tags:** Sales ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "orderId": "00000000-0000-4000-8000-000000000000", "currencyCode": "string", "quantity": 1 } ``` ### Responses **201** – Order line created Content-Type: `application/json` ```json { "id": null, "orderId": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/order-lines" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "orderId": "00000000-0000-4000-8000-000000000000", "currencyCode": "string", "quantity": 1 }' ``` ## PUT `/sales/order-lines` Update order line Updates an order line and recalculates totals. **Tags:** Sales ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "orderId": "00000000-0000-4000-8000-000000000000", "currencyCode": "string", "quantity": 1 } ``` ### Responses **200** – Order line updated Content-Type: `application/json` ```json { "id": null, "orderId": null } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/order-lines" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "orderId": "00000000-0000-4000-8000-000000000000", "currencyCode": "string", "quantity": 1 }' ``` ## DELETE `/sales/order-statuses` Delete order status Deletes a order status identified by id. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Order status deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/order-statuses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/order-statuses` List order statuses Manage the lifecycle states available for sales orders. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated order statuses Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": null, "color": null, "icon": null, "organizationId": null, "tenantId": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/order-statuses?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/order-statuses` Create order status Creates a new order status. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "value": "string", "color": null, "icon": null } ``` ### Responses **201** – Order status created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/order-statuses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "value": "string", "color": null, "icon": null }' ``` ## PUT `/sales/order-statuses` Update order status Updates an existing order status by id. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "color": null, "icon": null, "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Order status updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/order-statuses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "color": null, "icon": null, "id": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/sales/orders` Delete order Deletes a sales order. Requires features: sales.orders.manage **Tags:** Sales **Requires authentication.** **Features:** sales.orders.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Order deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/orders" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/orders` List orders Returns a paginated collection of orders that belong to the current organization. Requires features: sales.orders.view **Tags:** Sales **Requires authentication.** **Features:** sales.orders.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | id | query | any | Optional | | customerId | query | any | Optional | | channelId | query | any | Optional | | lineItemCountMin | query | any | Optional | | lineItemCountMax | query | any | Optional | | totalNetMin | query | any | Optional | | totalNetMax | query | any | Optional | | totalGrossMin | query | any | Optional | | totalGrossMax | query | any | Optional | | dateFrom | query | any | Optional | | dateTo | query | any | Optional | | tagIds | query | any | Optional | | tagIdsEmpty | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | withDeleted | query | any | Optional | ### Responses **200** – Paginated orders Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "orderNumber": null, "status": null, "statusEntryId": null, "customerEntityId": null, "customerContactId": null, "billingAddressId": null, "shippingAddressId": null, "customerReference": null, "externalReference": null, "comment": null, "placedAt": null, "expectedDeliveryAt": null, "customerSnapshot": null, "billingAddressSnapshot": null, "shippingAddressSnapshot": null, "shippingMethodId": null, "shippingMethodCode": null, "shippingMethodSnapshot": null, "paymentMethodId": null, "paymentMethodCode": null, "paymentMethodSnapshot": null, "currencyCode": null, "channelId": null, "organizationId": null, "tenantId": null, "validFrom": null, "validUntil": null, "lineItemCount": null, "subtotalNetAmount": null, "subtotalGrossAmount": null, "discountTotalAmount": null, "taxTotalAmount": null, "shippingNetAmount": null, "shippingGrossAmount": null, "surchargeTotalAmount": null, "grandTotalNetAmount": null, "grandTotalGrossAmount": null, "paidTotalAmount": null, "refundedTotalAmount": null, "outstandingAmount": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/orders?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/orders` Create order Creates a new sales order. Requires features: sales.orders.manage **Tags:** Sales **Requires authentication.** **Features:** sales.orders.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "currencyCode": "string" } ``` ### Responses **201** – Order created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/orders" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "currencyCode": "string" }' ``` ## PUT `/sales/orders` Order management Requires features: sales.orders.manage **Tags:** Sales **Requires authentication.** **Features:** sales.orders.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/orders" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/payment-methods` Delete payment method Deletes a payment method identified by id. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Payment method deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/payment-methods" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/payment-methods` List payment methods Configure payment options that can be assigned to sales orders and invoices. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | isActive | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | withDeleted | query | any | Optional | ### Responses **200** – Paginated payment methods Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "code": "string", "description": null, "providerKey": null, "terms": null, "isActive": true, "metadata": null, "providerSettings": null, "organizationId": null, "tenantId": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/payment-methods?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/payment-methods` Create payment method Creates a new payment method. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "code": "string" } ``` ### Responses **201** – Payment method created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/payment-methods" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "code": "string" }' ``` ## PUT `/sales/payment-methods` Update payment method Updates an existing payment method by id. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Payment method updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/payment-methods" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/sales/payment-statuses` Delete payment status Deletes a payment status identified by id. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Payment status deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/payment-statuses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/payment-statuses` List payment statuses Manage the lifecycle states available for payments. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated payment statuses Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": null, "color": null, "icon": null, "organizationId": null, "tenantId": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/payment-statuses?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/payment-statuses` Create payment status Creates a new payment status. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "value": "string", "color": null, "icon": null } ``` ### Responses **201** – Payment status created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/payment-statuses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "value": "string", "color": null, "icon": null }' ``` ## PUT `/sales/payment-statuses` Update payment status Updates an existing payment status by id. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "color": null, "icon": null, "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Payment status updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/payment-statuses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "color": null, "icon": null, "id": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/sales/payments` Delete payment Deletes a payment. Requires features: sales.payments.manage **Tags:** Sales **Requires authentication.** **Features:** sales.payments.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Payment deleted Content-Type: `application/json` ```json { "id": null, "orderTotals": null } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/payments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/payments` List payments Returns a paginated collection of payments that belong to the current organization. Requires features: sales.orders.view **Tags:** Sales **Requires authentication.** **Features:** sales.orders.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | orderId | query | any | Optional | | paymentMethodId | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated payments Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "order_id": null, "payment_method_id": null, "payment_method_name": null, "payment_method_code": null, "payment_reference": null, "status_entry_id": null, "status": null, "status_label": null, "amount": 1, "currency_code": "string", "captured_amount": null, "refunded_amount": null, "received_at": null, "captured_at": null, "custom_field_set_id": null, "customFieldSetId": null, "custom_values": null, "customValues": null, "custom_fields": null, "customFields": null, "metadata": null, "created_at": "string", "updated_at": null } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/payments?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/payments` Create payment Creates a payment for a sales order. Requires features: sales.payments.manage **Tags:** Sales **Requires authentication.** **Features:** sales.payments.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "amount": 1, "currencyCode": "string" } ``` ### Responses **201** – Payment created Content-Type: `application/json` ```json { "id": null, "orderTotals": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/payments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "amount": 1, "currencyCode": "string" }' ``` ## PUT `/sales/payments` Update payment Updates a payment. Requires features: sales.payments.manage **Tags:** Sales **Requires authentication.** **Features:** sales.payments.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Payment updated Content-Type: `application/json` ```json { "id": null, "orderTotals": null } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/payments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/price-kinds` List price kinds Lists available price kinds that can be used when pricing sales channels and offers. Requires features: sales.channels.manage **Tags:** Sales **Requires authentication.** **Features:** sales.channels.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | isActive | query | any | Optional | ### Responses **200** – Paginated price kinds Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "code": "string", "title": "string", "currency_code": null, "display_mode": "string", "is_active": true } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/price-kinds?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/quote-adjustments` Delete quote adjustment Deletes a quote adjustment and recalculates totals. **Tags:** Sales ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "quoteId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Quote adjustment deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/quote-adjustments" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "quoteId": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/quote-adjustments` List quote adjustments Returns a paginated collection of quote adjustments that belong to the current organization. **Tags:** Sales ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | quoteId | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated quote adjustments Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "quote_id": "00000000-0000-4000-8000-000000000000", "quote_line_id": null, "scope": "string", "kind": "string", "code": null, "label": null, "calculator_key": null, "promotion_id": null, "rate": 1, "amount_net": 1, "amount_gross": 1, "currency_code": null, "metadata": null, "position": 1, "created_at": "string", "updated_at": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/quote-adjustments?page=1&pageSize=50" \ -H "Accept: application/json" ``` ## POST `/sales/quote-adjustments` Create quote adjustment Creates a quote adjustment and recalculates totals. **Tags:** Sales ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "quoteId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **201** – Quote adjustment created Content-Type: `application/json` ```json { "id": null, "quoteId": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/quote-adjustments" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "quoteId": "00000000-0000-4000-8000-000000000000" }' ``` ## PUT `/sales/quote-adjustments` Update quote adjustment Updates a quote adjustment and recalculates totals. **Tags:** Sales ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "quoteId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Quote adjustment updated Content-Type: `application/json` ```json { "id": null, "quoteId": null } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/quote-adjustments" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "quoteId": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/sales/quote-lines` Delete quote line Deletes a quote line and recalculates totals. **Tags:** Sales ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "quoteId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Quote line deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/quote-lines" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000", "quoteId": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/quote-lines` List quote lines Returns a paginated collection of quote lines that belong to the current organization. **Tags:** Sales ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | id | query | any | Optional | | quoteId | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated quote lines Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "quote_id": "00000000-0000-4000-8000-000000000000", "line_number": 1, "kind": "string", "status_entry_id": null, "status": null, "product_id": null, "product_variant_id": null, "catalog_snapshot": null, "name": null, "description": null, "comment": null, "quantity": 1, "quantity_unit": null, "currency_code": "string", "unit_price_net": 1, "unit_price_gross": 1, "discount_amount": 1, "discount_percent": 1, "tax_rate": 1, "tax_amount": 1, "total_net_amount": 1, "total_gross_amount": 1, "configuration": null, "promotion_code": null, "promotion_snapshot": null, "metadata": null, "custom_field_set_id": null, "created_at": "string", "updated_at": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/quote-lines?page=1&pageSize=50" \ -H "Accept: application/json" ``` ## POST `/sales/quote-lines` Create quote line Creates a quote line and recalculates totals. **Tags:** Sales ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "quoteId": "00000000-0000-4000-8000-000000000000", "currencyCode": "string", "quantity": 1 } ``` ### Responses **201** – Quote line created Content-Type: `application/json` ```json { "id": null, "quoteId": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/quote-lines" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "quoteId": "00000000-0000-4000-8000-000000000000", "currencyCode": "string", "quantity": 1 }' ``` ## PUT `/sales/quote-lines` Update quote line Updates a quote line and recalculates totals. **Tags:** Sales ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "quoteId": "00000000-0000-4000-8000-000000000000", "currencyCode": "string", "quantity": 1 } ``` ### Responses **200** – Quote line updated Content-Type: `application/json` ```json { "id": null, "quoteId": null } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/quote-lines" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "quoteId": "00000000-0000-4000-8000-000000000000", "currencyCode": "string", "quantity": 1 }' ``` ## DELETE `/sales/quotes` Delete quote Deletes a sales quote. Requires features: sales.quotes.manage **Tags:** Sales **Requires authentication.** **Features:** sales.quotes.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Quote deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/quotes" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/quotes` List quotes Returns a paginated collection of quotes that belong to the current organization. Requires features: sales.quotes.view **Tags:** Sales **Requires authentication.** **Features:** sales.quotes.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | id | query | any | Optional | | customerId | query | any | Optional | | channelId | query | any | Optional | | lineItemCountMin | query | any | Optional | | lineItemCountMax | query | any | Optional | | totalNetMin | query | any | Optional | | totalNetMax | query | any | Optional | | totalGrossMin | query | any | Optional | | totalGrossMax | query | any | Optional | | dateFrom | query | any | Optional | | dateTo | query | any | Optional | | tagIds | query | any | Optional | | tagIdsEmpty | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | withDeleted | query | any | Optional | ### Responses **200** – Paginated quotes Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "quoteNumber": null, "status": null, "statusEntryId": null, "customerEntityId": null, "customerContactId": null, "billingAddressId": null, "shippingAddressId": null, "customerReference": null, "externalReference": null, "comment": null, "placedAt": null, "expectedDeliveryAt": null, "customerSnapshot": null, "billingAddressSnapshot": null, "shippingAddressSnapshot": null, "shippingMethodId": null, "shippingMethodCode": null, "shippingMethodSnapshot": null, "paymentMethodId": null, "paymentMethodCode": null, "paymentMethodSnapshot": null, "currencyCode": null, "channelId": null, "organizationId": null, "tenantId": null, "validFrom": null, "validUntil": null, "lineItemCount": null, "subtotalNetAmount": null, "subtotalGrossAmount": null, "discountTotalAmount": null, "taxTotalAmount": null, "shippingNetAmount": null, "shippingGrossAmount": null, "surchargeTotalAmount": null, "grandTotalNetAmount": null, "grandTotalGrossAmount": null, "paidTotalAmount": null, "refundedTotalAmount": null, "outstandingAmount": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/quotes?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/quotes` Create quote Creates a new sales quote. Requires features: sales.quotes.manage **Tags:** Sales **Requires authentication.** **Features:** sales.quotes.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "currencyCode": "string" } ``` ### Responses **201** – Quote created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/quotes" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "currencyCode": "string" }' ``` ## PUT `/sales/quotes` Quote management Requires features: sales.quotes.manage **Tags:** Sales **Requires authentication.** **Features:** sales.quotes.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/quotes" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/quotes/convert` Convert quote Creates a sales order from a quote and removes the original quote record. Requires features: sales.quotes.manage, sales.orders.manage **Tags:** Sales **Requires authentication.** **Features:** sales.quotes.manage, sales.orders.manage ### Request Body Content-Type: `application/json` ```json { "quoteId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Conversion succeeded Content-Type: `application/json` ```json { "orderId": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/quotes/convert" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "quoteId": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/settings/document-numbers` Get document numbering settings Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Responses **200** – Current numbering formats and counters Content-Type: `application/json` ```json { "orderNumberFormat": "string", "quoteNumberFormat": "string", "nextOrderNumber": 1, "nextQuoteNumber": 1 } ``` **400** – Missing scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/settings/document-numbers" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/settings/document-numbers` Update document numbering settings Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "orderNumberFormat": "string", "quoteNumberFormat": "string", "orderCustomerEditableStatuses": null, "orderAddressEditableStatuses": null } ``` ### Responses **200** – Updated numbering formats and counters Content-Type: `application/json` ```json { "orderNumberFormat": "string", "quoteNumberFormat": "string", "nextOrderNumber": 1, "nextQuoteNumber": 1 } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/settings/document-numbers" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "orderNumberFormat": "string", "quoteNumberFormat": "string", "orderCustomerEditableStatuses": null, "orderAddressEditableStatuses": null }' ``` ## GET `/sales/settings/order-editing` Get order editing guards Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Responses **200** – Current order editing guards Content-Type: `application/json` ```json { "orderCustomerEditableStatuses": null, "orderAddressEditableStatuses": null, "orderStatuses": [ { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": "string" } ] } ``` **400** – Missing scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/settings/order-editing" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/settings/order-editing` Update order editing guards Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "orderCustomerEditableStatuses": null, "orderAddressEditableStatuses": null } ``` ### Responses **200** – Updated order editing guards Content-Type: `application/json` ```json { "orderCustomerEditableStatuses": null, "orderAddressEditableStatuses": null, "orderStatuses": [ { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": "string" } ] } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/settings/order-editing" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "orderCustomerEditableStatuses": null, "orderAddressEditableStatuses": null }' ``` ## DELETE `/sales/shipment-statuses` Delete shipment status Deletes a shipment status identified by id. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Shipment status deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/shipment-statuses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/shipment-statuses` List shipment statuses Manage the lifecycle states available for shipments. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated shipment statuses Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": null, "color": null, "icon": null, "organizationId": null, "tenantId": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/shipment-statuses?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/shipment-statuses` Create shipment status Creates a new shipment status. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "value": "string", "color": null, "icon": null } ``` ### Responses **201** – Shipment status created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/shipment-statuses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "value": "string", "color": null, "icon": null }' ``` ## PUT `/sales/shipment-statuses` Update shipment status Updates an existing shipment status by id. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "color": null, "icon": null, "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Shipment status updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/shipment-statuses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "color": null, "icon": null, "id": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/sales/shipments` Delete shipment Deletes a shipment. **Tags:** Sales ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Shipment deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/shipments" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/shipments` List shipments Returns a paginated collection of shipments that belong to the current organization. **Tags:** Sales ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | orderId | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated shipments Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "order_id": "00000000-0000-4000-8000-000000000000", "shipment_number": null, "shipping_method_id": null, "shipping_method_code": null, "shipping_method_name": null, "status_entry_id": null, "status": null, "status_label": null, "carrier_name": null, "tracking_numbers": null, "shipped_at": null, "delivered_at": null, "weight_value": null, "weight_unit": null, "declared_value_net": null, "declared_value_gross": null, "currency_code": null, "notes": null, "metadata": null, "custom_values": null, "customValues": null, "custom_fields": null, "customFields": null, "items_snapshot": null, "itemsSnapshot": null, "created_at": "string", "updated_at": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/shipments?page=1&pageSize=50" \ -H "Accept: application/json" ``` ## POST `/sales/shipments` Create shipment Creates a shipment for an order. **Tags:** Sales ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "orderId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **201** – Shipment created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/shipments" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "orderId": "00000000-0000-4000-8000-000000000000" }' ``` ## PUT `/sales/shipments` Update shipment Updates a shipment. **Tags:** Sales ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Shipment updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/shipments" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/sales/shipping-methods` Delete shipping method Deletes a shipping method identified by id. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Shipping method deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/shipping-methods" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/shipping-methods` List shipping methods Maintain shipping services, carrier mappings, and pricing defaults for order fulfillment. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | currency | query | any | Optional | | isActive | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | withDeleted | query | any | Optional | ### Responses **200** – Paginated shipping methods Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "code": "string", "description": null, "carrierCode": null, "providerKey": null, "serviceLevel": null, "estimatedTransitDays": null, "baseRateNet": "string", "baseRateGross": "string", "currencyCode": null, "isActive": true, "metadata": null, "providerSettings": null, "organizationId": null, "tenantId": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/shipping-methods?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/shipping-methods` Create shipping method Creates a new shipping method. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "code": "string" } ``` ### Responses **201** – Shipping method created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/shipping-methods" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "code": "string" }' ``` ## PUT `/sales/shipping-methods` Update shipping method Updates an existing shipping method by id. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Shipping method updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/shipping-methods" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/sales/tags` Delete sales tag Deletes a sales tag. Requires features: sales.orders.manage **Tags:** Sales **Requires authentication.** **Features:** sales.orders.manage ### Responses **200** – Sales tag deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/tags` List sales tags Manage reusable tags to categorize sales orders and quotes. Requires features: sales.orders.view **Tags:** Sales **Requires authentication.** **Features:** sales.orders.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Paginated sales tags Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "slug": "string", "label": null, "color": null, "description": null, "organization_id": null, "tenant_id": null } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/tags?page=1&pageSize=100" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/tags` Create sales tag Creates a sales document tag. Requires features: sales.orders.manage **Tags:** Sales **Requires authentication.** **Features:** sales.orders.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "slug": "string", "label": "string" } ``` ### Responses **201** – Sales tag created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "slug": "string", "label": "string" }' ``` ## PUT `/sales/tags` Update sales tag Updates an existing sales tag. Requires features: sales.orders.manage **Tags:** Sales **Requires authentication.** **Features:** sales.orders.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Sales tag updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/sales/tax-rates` Delete tax rate Deletes a tax rate identified by `id`. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Deletion acknowledgement Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/sales/tax-rates" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## GET `/sales/tax-rates` List tax rates Returns a paginated list of sales tax rates for the current organization. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | country | query | any | Optional | | region | query | any | Optional | | channelId | query | any | Optional | | isCompound | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | withDeleted | query | any | Optional | ### Responses **200** – Paginated list of tax rates Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "code": null, "rate": 1, "countryCode": null, "regionCode": null, "postalCode": null, "city": null, "customerGroupId": null, "productCategoryId": null, "channelId": null, "priority": null, "isCompound": true, "isDefault": true, "metadata": null, "startsAt": null, "endsAt": null, "organizationId": null, "tenantId": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/sales/tax-rates?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/tax-rates` Create tax rate Creates a new tax rate record. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "code": "string", "rate": 1 } ``` ### Responses **201** – Identifier of the created tax rate Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/sales/tax-rates" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "code": "string", "rate": 1 }' ``` ## PUT `/sales/tax-rates` Update tax rate Updates an existing tax rate by identifier. Requires features: sales.settings.manage **Tags:** Sales **Requires authentication.** **Features:** sales.settings.manage ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Update acknowledgement Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://open-mercato.dogtronic.biz/sales/tax-rates" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "00000000-0000-4000-8000-000000000000" }' ``` ## DELETE `/vector/index` DELETE /vector/index Requires features: vector.manage **Tags:** Vector Search **Requires authentication.** **Features:** vector.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://open-mercato.dogtronic.biz/vector/index" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/vector/index` GET /vector/index Requires features: vector.search **Tags:** Vector Search **Requires authentication.** **Features:** vector.search ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/vector/index" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/vector/reindex` POST /vector/reindex Requires features: vector.reindex **Tags:** Vector Search **Requires authentication.** **Features:** vector.reindex ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/vector/reindex" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/vector/search` GET /vector/search Requires features: vector.search **Tags:** Vector Search **Requires authentication.** **Features:** vector.search ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/vector/search" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/vector/settings` GET /vector/settings Requires features: vector.view **Tags:** Vector Search **Requires authentication.** **Features:** vector.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://open-mercato.dogtronic.biz/vector/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/vector/settings` POST /vector/settings Requires features: vector.manage **Tags:** Vector Search **Requires authentication.** **Features:** vector.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://open-mercato.dogtronic.biz/vector/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ```