{ "items": [ { "key": "brand.brands", "module": "brand", "type": "crud", "revision": "320da6755a33b82f", "descriptors": { "en": { "schemaVersion": 1, "key": "brand.brands", "module": "brand", "type": "crud", "revision": "320da6755a33b82f", "title": "Brands", "layout": { "ops": { "list": "listBrands", "get": "getBrand", "create": "createBrand", "update": "updateBrand", "delete": "deleteBrand" }, "trash": { "list": "listBrandTrash", "restore": "restoreBrand", "columns": [ { "field": "code", "label": "Code", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Name", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "deletedAt", "label": "Deleted", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } }, { "field": "deletedByInfo", "label": "Deleted by", "widget": "user", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } } ] }, "search": true, "columns": [ { "field": "logoFileInfo", "label": "Logo", "widget": "image", "sort": null, "options": null, "currencyField": null, "download": "downloadFile", "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] } }, { "field": "code", "label": "Code", "widget": null, "sort": "code", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Name", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "active", "label": "Active", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "sortOrder", "label": "Order", "widget": "number", "sort": "sort_order", "options": null, "currencyField": null, "download": null, "schema": { "type": "number" } }, { "field": "updatedAt", "label": "Updated", "widget": "datetime", "sort": "updated_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "active", "label": "Active", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } } ], "form": [ { "field": "code", "label": "Code", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "fields": null }, { "field": "translations", "label": "Translations", "widget": "translations", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "lang", "name" ] }, "maxItems": 20, "default": [] }, "fields": [ { "field": "name", "label": "Name", "widget": "text", "on": [ "create", "update" ], "required": [ "create", "update" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "fields": null }, { "field": "description", "label": "Description", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "fields": null }, { "field": "slug", "label": "Slug", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "fields": null }, { "field": "metaTitle", "label": "Meta title", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "fields": null }, { "field": "metaDescription", "label": "Meta description", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "fields": null } ] }, { "field": "websiteUrl", "label": "Website", "widget": "url", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "uri", "maxLength": 500 }, { "type": "null" } ] }, "fields": null }, { "field": "logoFileId", "label": "Logo", "widget": "file", "on": [ "create", "update" ], "required": [], "options": null, "display": "logoFileInfo", "upload": "uploadFile", "download": "downloadFile", "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "fields": null }, { "field": "sortOrder", "label": "Order", "widget": "number", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "integer", "minimum": 0, "default": 0 }, "fields": null }, { "field": "active", "label": "Active", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null } ], "enums": {} }, "operations": { "createBrand": { "method": "POST", "path": "/api/v1/brands", "permissions": [ "brand.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "websiteUrl": { "anyOf": [ { "type": "string", "format": "uri", "maxLength": 500 }, { "type": "null" } ] }, "logoFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sortOrder": { "type": "integer", "minimum": 0, "default": 0 }, "active": { "type": "boolean", "default": true }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "lang", "name" ] }, "maxItems": 20, "default": [] } }, "required": [ "code" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logoFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "logoFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "websiteUrl", "logoFileId", "logoFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteBrand": { "method": "DELETE", "path": "/api/v1/brands/{id}", "permissions": [ "brand.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": { "type": "object", "properties": { "force": { "enum": [ "true", "false" ], "type": "string" } }, "required": [] }, "body": null, "response": null, "meta": null }, "downloadFile": { "method": "GET", "path": "/api/v1/files/{id}/content", "permissions": [ "files.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": "application/octet-stream", "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": null, "meta": null }, "getBrand": { "method": "GET", "path": "/api/v1/brands/{id}", "permissions": [ "brand.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logoFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "logoFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "websiteUrl", "logoFileId", "logoFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listBrandTrash": { "method": "GET", "path": "/api/v1/brands/trash", "permissions": [ "brand.restore" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "deleted_at", "-deleted_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-deleted_at`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: brands.code, brand_translations.name" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deletedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "deletedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "deletedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "code", "lang", "name", "deletedAt", "deletedBy", "deletedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listBrands": { "method": "GET", "path": "/api/v1/brands", "permissions": [ "brand.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "sort_order", "-sort_order", "code", "-code", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `sort_order`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: brands.code, brand_translations.name" }, "active": { "type": "string", "description": "eq: bool" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logoFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "logoFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "websiteUrl", "logoFileId", "logoFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "restoreBrand": { "method": "POST", "path": "/api/v1/brands/{id}/restore", "permissions": [ "brand.restore" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logoFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "logoFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "websiteUrl", "logoFileId", "logoFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "updateBrand": { "method": "PATCH", "path": "/api/v1/brands/{id}", "permissions": [ "brand.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "websiteUrl": { "anyOf": [ { "type": "string", "format": "uri", "maxLength": 500 }, { "type": "null" } ] }, "logoFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sortOrder": { "type": "integer", "minimum": 0 }, "active": { "type": "boolean" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "lang", "name" ] }, "maxItems": 20 } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logoFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "logoFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "websiteUrl", "logoFileId", "logoFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "uploadFile": { "method": "POST", "path": "/api/v1/files", "permissions": [ "files.write" ], "conditional": false, "features": [], "idempotent": false, "status": 201, "bodyContentType": "multipart/form-data", "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [] }, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" }, "storeId": { "type": "string", "format": "uuid" }, "ownerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "ownerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" } }, "required": [ "id", "name", "contentType", "size", "sha256", "storeId", "ownerId", "ownerInfo", "createdAt" ] }, "meta": null } } }, "vi": { "schemaVersion": 1, "key": "brand.brands", "module": "brand", "type": "crud", "revision": "320da6755a33b82f", "title": "Thương hiệu", "layout": { "ops": { "list": "listBrands", "get": "getBrand", "create": "createBrand", "update": "updateBrand", "delete": "deleteBrand" }, "trash": { "list": "listBrandTrash", "restore": "restoreBrand", "columns": [ { "field": "code", "label": "Mã", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Tên", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "deletedAt", "label": "Ngày xoá", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } }, { "field": "deletedByInfo", "label": "Người xoá", "widget": "user", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } } ] }, "search": true, "columns": [ { "field": "logoFileInfo", "label": "Logo", "widget": "image", "sort": null, "options": null, "currencyField": null, "download": "downloadFile", "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] } }, { "field": "code", "label": "Mã", "widget": null, "sort": "code", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Tên", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "active", "label": "Đang dùng", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "sortOrder", "label": "Thứ tự", "widget": "number", "sort": "sort_order", "options": null, "currencyField": null, "download": null, "schema": { "type": "number" } }, { "field": "updatedAt", "label": "Cập nhật", "widget": "datetime", "sort": "updated_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "active", "label": "Đang dùng", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } } ], "form": [ { "field": "code", "label": "Mã", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "fields": null }, { "field": "translations", "label": "Bản dịch", "widget": "translations", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "lang", "name" ] }, "maxItems": 20, "default": [] }, "fields": [ { "field": "name", "label": "Tên", "widget": "text", "on": [ "create", "update" ], "required": [ "create", "update" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "fields": null }, { "field": "description", "label": "Mô tả", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "fields": null }, { "field": "slug", "label": "Slug", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "fields": null }, { "field": "metaTitle", "label": "Tiêu đề SEO", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "fields": null }, { "field": "metaDescription", "label": "Mô tả SEO", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "fields": null } ] }, { "field": "websiteUrl", "label": "Website", "widget": "url", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "uri", "maxLength": 500 }, { "type": "null" } ] }, "fields": null }, { "field": "logoFileId", "label": "Logo", "widget": "file", "on": [ "create", "update" ], "required": [], "options": null, "display": "logoFileInfo", "upload": "uploadFile", "download": "downloadFile", "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "fields": null }, { "field": "sortOrder", "label": "Thứ tự", "widget": "number", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "integer", "minimum": 0, "default": 0 }, "fields": null }, { "field": "active", "label": "Đang dùng", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null } ], "enums": {} }, "operations": { "createBrand": { "method": "POST", "path": "/api/v1/brands", "permissions": [ "brand.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "websiteUrl": { "anyOf": [ { "type": "string", "format": "uri", "maxLength": 500 }, { "type": "null" } ] }, "logoFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sortOrder": { "type": "integer", "minimum": 0, "default": 0 }, "active": { "type": "boolean", "default": true }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "lang", "name" ] }, "maxItems": 20, "default": [] } }, "required": [ "code" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logoFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "logoFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "websiteUrl", "logoFileId", "logoFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteBrand": { "method": "DELETE", "path": "/api/v1/brands/{id}", "permissions": [ "brand.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": { "type": "object", "properties": { "force": { "enum": [ "true", "false" ], "type": "string" } }, "required": [] }, "body": null, "response": null, "meta": null }, "downloadFile": { "method": "GET", "path": "/api/v1/files/{id}/content", "permissions": [ "files.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": "application/octet-stream", "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": null, "meta": null }, "getBrand": { "method": "GET", "path": "/api/v1/brands/{id}", "permissions": [ "brand.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logoFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "logoFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "websiteUrl", "logoFileId", "logoFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listBrandTrash": { "method": "GET", "path": "/api/v1/brands/trash", "permissions": [ "brand.restore" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "deleted_at", "-deleted_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-deleted_at`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: brands.code, brand_translations.name" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deletedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "deletedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "deletedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "code", "lang", "name", "deletedAt", "deletedBy", "deletedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listBrands": { "method": "GET", "path": "/api/v1/brands", "permissions": [ "brand.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "sort_order", "-sort_order", "code", "-code", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `sort_order`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: brands.code, brand_translations.name" }, "active": { "type": "string", "description": "eq: bool" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logoFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "logoFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "websiteUrl", "logoFileId", "logoFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "restoreBrand": { "method": "POST", "path": "/api/v1/brands/{id}/restore", "permissions": [ "brand.restore" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logoFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "logoFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "websiteUrl", "logoFileId", "logoFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "updateBrand": { "method": "PATCH", "path": "/api/v1/brands/{id}", "permissions": [ "brand.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "websiteUrl": { "anyOf": [ { "type": "string", "format": "uri", "maxLength": 500 }, { "type": "null" } ] }, "logoFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sortOrder": { "type": "integer", "minimum": 0 }, "active": { "type": "boolean" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "lang", "name" ] }, "maxItems": 20 } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logoFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "logoFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "websiteUrl", "logoFileId", "logoFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "uploadFile": { "method": "POST", "path": "/api/v1/files", "permissions": [ "files.write" ], "conditional": false, "features": [], "idempotent": false, "status": 201, "bodyContentType": "multipart/form-data", "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [] }, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" }, "storeId": { "type": "string", "format": "uuid" }, "ownerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "ownerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" } }, "required": [ "id", "name", "contentType", "size", "sha256", "storeId", "ownerId", "ownerInfo", "createdAt" ] }, "meta": null } } } } }, { "key": "coupon.coupons", "module": "coupon", "type": "crud", "revision": "c5697ae07858c6ec", "descriptors": { "en": { "schemaVersion": 1, "key": "coupon.coupons", "module": "coupon", "type": "crud", "revision": "c5697ae07858c6ec", "title": "Coupons", "layout": { "ops": { "list": "listCoupons", "get": "getCoupon", "create": "createCoupon", "update": "updateCoupon", "delete": "deleteCoupon" }, "trash": { "list": "listCouponTrash", "restore": "restoreCoupon", "columns": [ { "field": "code", "label": "Code", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Name", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "deletedAt", "label": "Deleted", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } }, { "field": "deletedByInfo", "label": "Deleted by", "widget": "user", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } } ] }, "search": true, "columns": [ { "field": "code", "label": "Code", "widget": null, "sort": "code", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Name", "widget": null, "sort": "name", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "discountType", "label": "Type", "widget": "badge", "sort": null, "options": { "enum": "discount_type" }, "currencyField": null, "download": null, "schema": { "enum": [ "percent", "fixed" ], "type": "string" } }, { "field": "discountValue", "label": "Value", "widget": "qty", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "customerInfo.name", "label": "Customer", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "startsAt", "label": "Starts", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] } }, { "field": "endsAt", "label": "Ends", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] } }, { "field": "redeemedCount", "label": "Used", "widget": "number", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "number" } }, { "field": "active", "label": "Active", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } } ], "filters": [ { "param": "active", "label": "Active", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } }, { "param": "customer_id", "label": "Customer", "widget": "picker", "options": { "op": "listCustomers", "value": "id", "label": "name", "hint": "email", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } } ], "form": [ { "field": "code", "label": "Code", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$" }, "fields": null }, { "field": "name", "label": "Name", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "fields": null }, { "field": "discountType", "label": "Discount type", "widget": "select", "on": [ "create", "update" ], "required": [ "create" ], "options": { "enum": "discount_type" }, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "enum": [ "percent", "fixed" ], "type": "string" }, "fields": null }, { "field": "discountValue", "label": "Discount value", "widget": "qty", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, "fields": null }, { "field": "maxDiscount", "label": "Max discount", "widget": "money", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": "currency", "schema": { "anyOf": [ { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "fields": null }, { "field": "minSubtotal", "label": "Minimum subtotal", "widget": "money", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": "currency", "schema": { "anyOf": [ { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "fields": null }, { "field": "startsAt", "label": "Starts at", "widget": "datetime", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "fields": null }, { "field": "endsAt", "label": "Ends at", "widget": "datetime", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "fields": null }, { "field": "usageLimit", "label": "Usage limit", "widget": "number", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "fields": null }, { "field": "perCustomerLimit", "label": "Limit per customer", "widget": "number", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "fields": null }, { "field": "customerId", "label": "Only for customer", "widget": "picker", "on": [ "create", "update" ], "required": [], "options": { "op": "listCustomers", "value": "id", "label": "name", "hint": "email", "query": {} }, "display": "customerInfo.name", "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "fields": null }, { "field": "productIds", "label": "Only for products", "widget": "multipicker", "on": [ "create" ], "required": [], "options": { "op": "listProductOptions", "value": "id", "label": "name", "hint": "code", "query": {} }, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 200, "default": [] }, "fields": null }, { "field": "active", "label": "Active", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null }, { "field": "notes", "label": "Notes", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "fields": null } ], "enums": { "discount_type": { "percent": { "label": "Percent", "tone": "info" }, "fixed": { "label": "Fixed amount", "tone": "neutral" } } } }, "operations": { "createCoupon": { "method": "POST", "path": "/api/v1/coupons", "permissions": [ "coupon.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "active": { "type": "boolean", "default": true }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "discountType": { "enum": [ "percent", "fixed" ], "type": "string" }, "discountValue": { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, "maxDiscount": { "anyOf": [ { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "minSubtotal": { "anyOf": [ { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "usageLimit": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "perCustomerLimit": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "customerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "productIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 200, "default": [] } }, "required": [ "code", "name", "discountType", "discountValue" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "discountType": { "enum": [ "percent", "fixed" ], "type": "string" }, "discountValue": { "type": "string" }, "maxDiscount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "minSubtotal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "type": "string" }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "usageLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perCustomerLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "customerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] }, { "type": "null" } ] }, "products": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "productInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, { "type": "null" } ] } }, "required": [ "productId", "productInfo" ] } }, "redeemedCount": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "discountType", "discountValue", "maxDiscount", "minSubtotal", "currency", "startsAt", "endsAt", "usageLimit", "perCustomerLimit", "customerId", "customerInfo", "products", "redeemedCount", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteCoupon": { "method": "DELETE", "path": "/api/v1/coupons/{id}", "permissions": [ "coupon.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": { "type": "object", "properties": { "force": { "enum": [ "true", "false" ], "type": "string" } }, "required": [] }, "body": null, "response": null, "meta": null }, "getCoupon": { "method": "GET", "path": "/api/v1/coupons/{id}", "permissions": [ "coupon.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "discountType": { "enum": [ "percent", "fixed" ], "type": "string" }, "discountValue": { "type": "string" }, "maxDiscount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "minSubtotal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "type": "string" }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "usageLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perCustomerLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "customerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] }, { "type": "null" } ] }, "products": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "productInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, { "type": "null" } ] } }, "required": [ "productId", "productInfo" ] } }, "redeemedCount": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "discountType", "discountValue", "maxDiscount", "minSubtotal", "currency", "startsAt", "endsAt", "usageLimit", "perCustomerLimit", "customerId", "customerInfo", "products", "redeemedCount", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listCouponTrash": { "method": "GET", "path": "/api/v1/coupons/trash", "permissions": [ "coupon.restore" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "deleted_at", "-deleted_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-deleted_at`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: coupons.code, coupons.name" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "deletedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "deletedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "deletedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "code", "name", "deletedAt", "deletedBy", "deletedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listCoupons": { "method": "GET", "path": "/api/v1/coupons", "permissions": [ "coupon.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "name", "-name", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-created_at`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: coupons.code, coupons.name" }, "active": { "type": "string", "description": "eq: bool" }, "customer_id": { "type": "string", "description": "eq: uuid" }, "customer_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "discountType": { "enum": [ "percent", "fixed" ], "type": "string" }, "discountValue": { "type": "string" }, "maxDiscount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "minSubtotal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "type": "string" }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "usageLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perCustomerLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "customerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] }, { "type": "null" } ] }, "products": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "productInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, { "type": "null" } ] } }, "required": [ "productId", "productInfo" ] } }, "redeemedCount": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "discountType", "discountValue", "maxDiscount", "minSubtotal", "currency", "startsAt", "endsAt", "usageLimit", "perCustomerLimit", "customerId", "customerInfo", "products", "redeemedCount", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listCustomers": { "method": "GET", "path": "/api/v1/core/customers", "permissions": [ "core.view_customers" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "50", "minimum": 1, "maximum": 200 }, "cursor": { "type": "string", "maxLength": 254 }, "email": { "type": "string", "maxLength": 254, "format": "email" }, "q": { "type": "string", "maxLength": 100 }, "store": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "emailVerifiedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "phoneVerifiedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "deletionRequestedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "purgeAfter": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "stores": { "type": "array", "items": { "type": "string" } }, "erasable": { "type": "boolean" }, "editable": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" } }, "required": [ "id", "email", "name", "phone", "active", "emailVerifiedAt", "phoneVerifiedAt", "deletionRequestedAt", "purgeAfter", "stores", "erasable", "editable", "createdAt" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listProductOptions": { "method": "GET", "path": "/api/v1/products/options", "permissions": [ "product.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "sort_order", "-sort_order", "code", "-code", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `sort_order`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: products.code, product_translations.name" }, "status": { "type": "string", "description": "eq: one of: draft, active, archived" }, "status.in": { "type": "string", "description": "in: comma-separated enum values (max 100)" }, "featured": { "type": "string", "description": "eq: bool" }, "brand_id": { "type": "string", "description": "eq: uuid" }, "brand_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "brand_id.null": { "type": "string", "description": "null: `true` = is null, `false` = is not null" }, "category_id": { "type": "string", "description": "eq: uuid" }, "category_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "category_id.null": { "type": "string", "description": "null: `true` = is null, `false` = is not null" }, "base_uom_id": { "type": "string", "description": "eq: uuid" }, "base_uom_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "in_category": { "type": "string", "format": "uuid", "description": "Category id: products in that category OR any of its sub-categories (AND-ed with the other filters, e.g. `category_id`)" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "status": { "enum": [ "draft", "active", "archived" ], "type": "string" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shortDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] } }, "required": [ "id", "code", "status", "lang", "name", "shortDescription", "description", "slug", "metaTitle", "metaDescription" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "restoreCoupon": { "method": "POST", "path": "/api/v1/coupons/{id}/restore", "permissions": [ "coupon.restore" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "discountType": { "enum": [ "percent", "fixed" ], "type": "string" }, "discountValue": { "type": "string" }, "maxDiscount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "minSubtotal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "type": "string" }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "usageLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perCustomerLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "customerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] }, { "type": "null" } ] }, "products": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "productInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, { "type": "null" } ] } }, "required": [ "productId", "productInfo" ] } }, "redeemedCount": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "discountType", "discountValue", "maxDiscount", "minSubtotal", "currency", "startsAt", "endsAt", "usageLimit", "perCustomerLimit", "customerId", "customerInfo", "products", "redeemedCount", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "updateCoupon": { "method": "PATCH", "path": "/api/v1/coupons/{id}", "permissions": [ "coupon.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "discountType": { "enum": [ "percent", "fixed" ], "type": "string" }, "discountValue": { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, "maxDiscount": { "anyOf": [ { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "minSubtotal": { "anyOf": [ { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "usageLimit": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "perCustomerLimit": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "customerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "productIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 200 } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "discountType": { "enum": [ "percent", "fixed" ], "type": "string" }, "discountValue": { "type": "string" }, "maxDiscount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "minSubtotal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "type": "string" }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "usageLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perCustomerLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "customerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] }, { "type": "null" } ] }, "products": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "productInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, { "type": "null" } ] } }, "required": [ "productId", "productInfo" ] } }, "redeemedCount": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "discountType", "discountValue", "maxDiscount", "minSubtotal", "currency", "startsAt", "endsAt", "usageLimit", "perCustomerLimit", "customerId", "customerInfo", "products", "redeemedCount", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } }, "vi": { "schemaVersion": 1, "key": "coupon.coupons", "module": "coupon", "type": "crud", "revision": "c5697ae07858c6ec", "title": "Mã giảm giá", "layout": { "ops": { "list": "listCoupons", "get": "getCoupon", "create": "createCoupon", "update": "updateCoupon", "delete": "deleteCoupon" }, "trash": { "list": "listCouponTrash", "restore": "restoreCoupon", "columns": [ { "field": "code", "label": "Mã", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Tên", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "deletedAt", "label": "Ngày xoá", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } }, { "field": "deletedByInfo", "label": "Người xoá", "widget": "user", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } } ] }, "search": true, "columns": [ { "field": "code", "label": "Mã", "widget": null, "sort": "code", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Tên", "widget": null, "sort": "name", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "discountType", "label": "Kiểu", "widget": "badge", "sort": null, "options": { "enum": "discount_type" }, "currencyField": null, "download": null, "schema": { "enum": [ "percent", "fixed" ], "type": "string" } }, { "field": "discountValue", "label": "Mức giảm", "widget": "qty", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "customerInfo.name", "label": "Khách hàng", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "startsAt", "label": "Bắt đầu", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] } }, { "field": "endsAt", "label": "Kết thúc", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] } }, { "field": "redeemedCount", "label": "Đã dùng", "widget": "number", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "number" } }, { "field": "active", "label": "Đang dùng", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } } ], "filters": [ { "param": "active", "label": "Đang dùng", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } }, { "param": "customer_id", "label": "Khách hàng", "widget": "picker", "options": { "op": "listCustomers", "value": "id", "label": "name", "hint": "email", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } } ], "form": [ { "field": "code", "label": "Mã", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$" }, "fields": null }, { "field": "name", "label": "Tên", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "fields": null }, { "field": "discountType", "label": "Kiểu giảm", "widget": "select", "on": [ "create", "update" ], "required": [ "create" ], "options": { "enum": "discount_type" }, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "enum": [ "percent", "fixed" ], "type": "string" }, "fields": null }, { "field": "discountValue", "label": "Mức giảm", "widget": "qty", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, "fields": null }, { "field": "maxDiscount", "label": "Giảm tối đa", "widget": "money", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": "currency", "schema": { "anyOf": [ { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "fields": null }, { "field": "minSubtotal", "label": "Đơn tối thiểu", "widget": "money", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": "currency", "schema": { "anyOf": [ { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "fields": null }, { "field": "startsAt", "label": "Bắt đầu", "widget": "datetime", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "fields": null }, { "field": "endsAt", "label": "Kết thúc", "widget": "datetime", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "fields": null }, { "field": "usageLimit", "label": "Giới hạn lượt dùng", "widget": "number", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "fields": null }, { "field": "perCustomerLimit", "label": "Giới hạn mỗi khách", "widget": "number", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "fields": null }, { "field": "customerId", "label": "Chỉ cho khách", "widget": "picker", "on": [ "create", "update" ], "required": [], "options": { "op": "listCustomers", "value": "id", "label": "name", "hint": "email", "query": {} }, "display": "customerInfo.name", "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "fields": null }, { "field": "productIds", "label": "Chỉ cho sản phẩm", "widget": "multipicker", "on": [ "create" ], "required": [], "options": { "op": "listProductOptions", "value": "id", "label": "name", "hint": "code", "query": {} }, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 200, "default": [] }, "fields": null }, { "field": "active", "label": "Đang dùng", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null }, { "field": "notes", "label": "Ghi chú", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "fields": null } ], "enums": { "discount_type": { "percent": { "label": "Phần trăm", "tone": "info" }, "fixed": { "label": "Số tiền cố định", "tone": "neutral" } } } }, "operations": { "createCoupon": { "method": "POST", "path": "/api/v1/coupons", "permissions": [ "coupon.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "active": { "type": "boolean", "default": true }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "discountType": { "enum": [ "percent", "fixed" ], "type": "string" }, "discountValue": { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, "maxDiscount": { "anyOf": [ { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "minSubtotal": { "anyOf": [ { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "usageLimit": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "perCustomerLimit": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "customerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "productIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 200, "default": [] } }, "required": [ "code", "name", "discountType", "discountValue" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "discountType": { "enum": [ "percent", "fixed" ], "type": "string" }, "discountValue": { "type": "string" }, "maxDiscount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "minSubtotal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "type": "string" }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "usageLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perCustomerLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "customerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] }, { "type": "null" } ] }, "products": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "productInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, { "type": "null" } ] } }, "required": [ "productId", "productInfo" ] } }, "redeemedCount": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "discountType", "discountValue", "maxDiscount", "minSubtotal", "currency", "startsAt", "endsAt", "usageLimit", "perCustomerLimit", "customerId", "customerInfo", "products", "redeemedCount", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteCoupon": { "method": "DELETE", "path": "/api/v1/coupons/{id}", "permissions": [ "coupon.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": { "type": "object", "properties": { "force": { "enum": [ "true", "false" ], "type": "string" } }, "required": [] }, "body": null, "response": null, "meta": null }, "getCoupon": { "method": "GET", "path": "/api/v1/coupons/{id}", "permissions": [ "coupon.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "discountType": { "enum": [ "percent", "fixed" ], "type": "string" }, "discountValue": { "type": "string" }, "maxDiscount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "minSubtotal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "type": "string" }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "usageLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perCustomerLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "customerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] }, { "type": "null" } ] }, "products": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "productInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, { "type": "null" } ] } }, "required": [ "productId", "productInfo" ] } }, "redeemedCount": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "discountType", "discountValue", "maxDiscount", "minSubtotal", "currency", "startsAt", "endsAt", "usageLimit", "perCustomerLimit", "customerId", "customerInfo", "products", "redeemedCount", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listCouponTrash": { "method": "GET", "path": "/api/v1/coupons/trash", "permissions": [ "coupon.restore" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "deleted_at", "-deleted_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-deleted_at`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: coupons.code, coupons.name" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "deletedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "deletedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "deletedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "code", "name", "deletedAt", "deletedBy", "deletedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listCoupons": { "method": "GET", "path": "/api/v1/coupons", "permissions": [ "coupon.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "name", "-name", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-created_at`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: coupons.code, coupons.name" }, "active": { "type": "string", "description": "eq: bool" }, "customer_id": { "type": "string", "description": "eq: uuid" }, "customer_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "discountType": { "enum": [ "percent", "fixed" ], "type": "string" }, "discountValue": { "type": "string" }, "maxDiscount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "minSubtotal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "type": "string" }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "usageLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perCustomerLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "customerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] }, { "type": "null" } ] }, "products": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "productInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, { "type": "null" } ] } }, "required": [ "productId", "productInfo" ] } }, "redeemedCount": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "discountType", "discountValue", "maxDiscount", "minSubtotal", "currency", "startsAt", "endsAt", "usageLimit", "perCustomerLimit", "customerId", "customerInfo", "products", "redeemedCount", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listCustomers": { "method": "GET", "path": "/api/v1/core/customers", "permissions": [ "core.view_customers" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "50", "minimum": 1, "maximum": 200 }, "cursor": { "type": "string", "maxLength": 254 }, "email": { "type": "string", "maxLength": 254, "format": "email" }, "q": { "type": "string", "maxLength": 100 }, "store": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "emailVerifiedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "phoneVerifiedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "deletionRequestedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "purgeAfter": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "stores": { "type": "array", "items": { "type": "string" } }, "erasable": { "type": "boolean" }, "editable": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" } }, "required": [ "id", "email", "name", "phone", "active", "emailVerifiedAt", "phoneVerifiedAt", "deletionRequestedAt", "purgeAfter", "stores", "erasable", "editable", "createdAt" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listProductOptions": { "method": "GET", "path": "/api/v1/products/options", "permissions": [ "product.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "sort_order", "-sort_order", "code", "-code", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `sort_order`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: products.code, product_translations.name" }, "status": { "type": "string", "description": "eq: one of: draft, active, archived" }, "status.in": { "type": "string", "description": "in: comma-separated enum values (max 100)" }, "featured": { "type": "string", "description": "eq: bool" }, "brand_id": { "type": "string", "description": "eq: uuid" }, "brand_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "brand_id.null": { "type": "string", "description": "null: `true` = is null, `false` = is not null" }, "category_id": { "type": "string", "description": "eq: uuid" }, "category_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "category_id.null": { "type": "string", "description": "null: `true` = is null, `false` = is not null" }, "base_uom_id": { "type": "string", "description": "eq: uuid" }, "base_uom_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "in_category": { "type": "string", "format": "uuid", "description": "Category id: products in that category OR any of its sub-categories (AND-ed with the other filters, e.g. `category_id`)" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "status": { "enum": [ "draft", "active", "archived" ], "type": "string" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shortDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] } }, "required": [ "id", "code", "status", "lang", "name", "shortDescription", "description", "slug", "metaTitle", "metaDescription" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "restoreCoupon": { "method": "POST", "path": "/api/v1/coupons/{id}/restore", "permissions": [ "coupon.restore" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "discountType": { "enum": [ "percent", "fixed" ], "type": "string" }, "discountValue": { "type": "string" }, "maxDiscount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "minSubtotal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "type": "string" }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "usageLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perCustomerLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "customerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] }, { "type": "null" } ] }, "products": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "productInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, { "type": "null" } ] } }, "required": [ "productId", "productInfo" ] } }, "redeemedCount": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "discountType", "discountValue", "maxDiscount", "minSubtotal", "currency", "startsAt", "endsAt", "usageLimit", "perCustomerLimit", "customerId", "customerInfo", "products", "redeemedCount", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "updateCoupon": { "method": "PATCH", "path": "/api/v1/coupons/{id}", "permissions": [ "coupon.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "discountType": { "enum": [ "percent", "fixed" ], "type": "string" }, "discountValue": { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, "maxDiscount": { "anyOf": [ { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "minSubtotal": { "anyOf": [ { "type": "string", "pattern": "^-?(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "usageLimit": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "perCustomerLimit": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "customerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "productIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 200 } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "discountType": { "enum": [ "percent", "fixed" ], "type": "string" }, "discountValue": { "type": "string" }, "maxDiscount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "minSubtotal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "type": "string" }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "usageLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perCustomerLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "customerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] }, { "type": "null" } ] }, "products": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "productInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, { "type": "null" } ] } }, "required": [ "productId", "productInfo" ] } }, "redeemedCount": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "discountType", "discountValue", "maxDiscount", "minSubtotal", "currency", "startsAt", "endsAt", "usageLimit", "perCustomerLimit", "customerId", "customerInfo", "products", "redeemedCount", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } } } }, { "key": "customer_type.customer_types", "module": "customer_type", "type": "crud", "revision": "ed3c1b2e3fe75709", "descriptors": { "en": { "schemaVersion": 1, "key": "customer_type.customer_types", "module": "customer_type", "type": "crud", "revision": "ed3c1b2e3fe75709", "title": "Customer types", "layout": { "ops": { "list": "listCustomerTypes", "get": "getCustomerType", "create": "createCustomerType", "update": "updateCustomerType", "delete": "deleteCustomerType" }, "trash": { "list": "listCustomerTypeTrash", "restore": "restoreCustomerType", "columns": [ { "field": "code", "label": "Code", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Name", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "deletedAt", "label": "Deleted", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } }, { "field": "deletedByInfo", "label": "Deleted by", "widget": "user", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } } ] }, "search": true, "columns": [ { "field": "code", "label": "Code", "widget": null, "sort": "code", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Name", "widget": null, "sort": "name", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "active", "label": "Active", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "updatedAt", "label": "Updated", "widget": "datetime", "sort": "updated_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "active", "label": "Active", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } } ], "form": [ { "field": "code", "label": "Code", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "fields": null }, { "field": "name", "label": "Name", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "fields": null }, { "field": "active", "label": "Active", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null }, { "field": "notes", "label": "Notes", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "fields": null } ], "enums": {} }, "operations": { "createCustomerType": { "method": "POST", "path": "/api/v1/customer-types", "permissions": [ "customer_type.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "active": { "type": "boolean", "default": true }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [ "code", "name" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteCustomerType": { "method": "DELETE", "path": "/api/v1/customer-types/{id}", "permissions": [ "customer_type.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": { "type": "object", "properties": { "force": { "enum": [ "true", "false" ], "type": "string" } }, "required": [] }, "body": null, "response": null, "meta": null }, "getCustomerType": { "method": "GET", "path": "/api/v1/customer-types/{id}", "permissions": [ "customer_type.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listCustomerTypeTrash": { "method": "GET", "path": "/api/v1/customer-types/trash", "permissions": [ "customer_type.restore" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "deleted_at", "-deleted_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-deleted_at`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: customer_types.code, customer_types.name" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "deletedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "deletedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "deletedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "code", "name", "deletedAt", "deletedBy", "deletedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listCustomerTypes": { "method": "GET", "path": "/api/v1/customer-types", "permissions": [ "customer_type.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "name", "-name", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `name`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: customer_types.code, customer_types.name" }, "active": { "type": "string", "description": "eq: bool" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "restoreCustomerType": { "method": "POST", "path": "/api/v1/customer-types/{id}/restore", "permissions": [ "customer_type.restore" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "updateCustomerType": { "method": "PATCH", "path": "/api/v1/customer-types/{id}", "permissions": [ "customer_type.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } }, "vi": { "schemaVersion": 1, "key": "customer_type.customer_types", "module": "customer_type", "type": "crud", "revision": "ed3c1b2e3fe75709", "title": "Loại khách", "layout": { "ops": { "list": "listCustomerTypes", "get": "getCustomerType", "create": "createCustomerType", "update": "updateCustomerType", "delete": "deleteCustomerType" }, "trash": { "list": "listCustomerTypeTrash", "restore": "restoreCustomerType", "columns": [ { "field": "code", "label": "Mã", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Tên", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "deletedAt", "label": "Ngày xoá", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } }, { "field": "deletedByInfo", "label": "Người xoá", "widget": "user", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } } ] }, "search": true, "columns": [ { "field": "code", "label": "Mã", "widget": null, "sort": "code", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Tên", "widget": null, "sort": "name", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "active", "label": "Đang dùng", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "updatedAt", "label": "Cập nhật", "widget": "datetime", "sort": "updated_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "active", "label": "Đang dùng", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } } ], "form": [ { "field": "code", "label": "Mã", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "fields": null }, { "field": "name", "label": "Tên", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "fields": null }, { "field": "active", "label": "Đang dùng", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null }, { "field": "notes", "label": "Ghi chú", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "fields": null } ], "enums": {} }, "operations": { "createCustomerType": { "method": "POST", "path": "/api/v1/customer-types", "permissions": [ "customer_type.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "active": { "type": "boolean", "default": true }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [ "code", "name" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteCustomerType": { "method": "DELETE", "path": "/api/v1/customer-types/{id}", "permissions": [ "customer_type.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": { "type": "object", "properties": { "force": { "enum": [ "true", "false" ], "type": "string" } }, "required": [] }, "body": null, "response": null, "meta": null }, "getCustomerType": { "method": "GET", "path": "/api/v1/customer-types/{id}", "permissions": [ "customer_type.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listCustomerTypeTrash": { "method": "GET", "path": "/api/v1/customer-types/trash", "permissions": [ "customer_type.restore" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "deleted_at", "-deleted_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-deleted_at`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: customer_types.code, customer_types.name" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "deletedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "deletedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "deletedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "code", "name", "deletedAt", "deletedBy", "deletedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listCustomerTypes": { "method": "GET", "path": "/api/v1/customer-types", "permissions": [ "customer_type.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "name", "-name", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `name`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: customer_types.code, customer_types.name" }, "active": { "type": "string", "description": "eq: bool" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "restoreCustomerType": { "method": "POST", "path": "/api/v1/customer-types/{id}/restore", "permissions": [ "customer_type.restore" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "updateCustomerType": { "method": "PATCH", "path": "/api/v1/customer-types/{id}", "permissions": [ "customer_type.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } } } }, { "key": "customer_type_price_rule.customer_type_price_rules", "module": "customer_type_price_rule", "type": "crud", "revision": "6c0c059099c374b3", "descriptors": { "en": { "schemaVersion": 1, "key": "customer_type_price_rule.customer_type_price_rules", "module": "customer_type_price_rule", "type": "crud", "revision": "6c0c059099c374b3", "title": "Customer type prices", "layout": { "ops": { "list": "listCustomerTypePriceRules", "get": "getCustomerTypePriceRule", "create": "createCustomerTypePriceRule", "update": "updateCustomerTypePriceRule", "delete": "deleteCustomerTypePriceRule" }, "trash": null, "search": false, "columns": [ { "field": "customerTypeInfo.name", "label": "Customer type", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "priceListInfo.name", "label": "Price list", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "discountPct", "label": "Discount %", "widget": "qty", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "startsAt", "label": "Starts", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] } }, { "field": "endsAt", "label": "Ends", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] } }, { "field": "active", "label": "Active", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "updatedAt", "label": "Updated", "widget": "datetime", "sort": "updated_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "customer_type_id", "label": "Customer type", "widget": "picker", "options": { "op": "listCustomerTypeOptions", "value": "id", "label": "name", "hint": "code", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } }, { "param": "price_list_id", "label": "Price list", "widget": "picker", "options": { "op": "listPriceListOptions", "value": "id", "label": "name", "hint": "code", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } }, { "param": "active", "label": "Active", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } } ], "form": [ { "field": "customerTypeId", "label": "Customer type", "widget": "picker", "on": [ "create" ], "required": [ "create" ], "options": { "op": "listCustomerTypeOptions", "value": "id", "label": "name", "hint": "code", "query": { "active": "true" } }, "display": "customerTypeInfo.name", "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "format": "uuid" }, "fields": null }, { "field": "priceListId", "label": "Price list", "widget": "picker", "on": [ "create" ], "required": [ "create" ], "options": { "op": "listPriceListOptions", "value": "id", "label": "name", "hint": "code", "query": { "active": "true" } }, "display": "priceListInfo.name", "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "format": "uuid" }, "fields": null }, { "field": "discountPct", "label": "Discount %", "widget": "qty", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "pattern": "^(100(\\.0{1,2})?|[0-9]{1,2}(\\.[0-9]{1,2})?)$" }, { "type": "null" } ] }, "fields": null }, { "field": "startsAt", "label": "Starts at", "widget": "datetime", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "fields": null }, { "field": "endsAt", "label": "Ends at", "widget": "datetime", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "fields": null }, { "field": "active", "label": "Active", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null }, { "field": "notes", "label": "Notes", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "fields": null } ], "enums": {} }, "operations": { "createCustomerTypePriceRule": { "method": "POST", "path": "/api/v1/customer-type-price-rules", "permissions": [ "customer_type_price_rule.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "customerTypeId": { "type": "string", "format": "uuid" }, "priceListId": { "type": "string", "format": "uuid" }, "discountPct": { "anyOf": [ { "type": "string", "pattern": "^(100(\\.0{1,2})?|[0-9]{1,2}(\\.[0-9]{1,2})?)$" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "active": { "type": "boolean", "default": true }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [ "customerTypeId", "priceListId" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "customerTypeId": { "type": "string", "format": "uuid" }, "customerTypeInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "priceListId": { "type": "string", "format": "uuid" }, "priceListInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "discountPct": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "customerTypeId", "customerTypeInfo", "priceListId", "priceListInfo", "discountPct", "startsAt", "endsAt", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteCustomerTypePriceRule": { "method": "DELETE", "path": "/api/v1/customer-type-price-rules/{id}", "permissions": [ "customer_type_price_rule.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": null, "meta": null }, "getCustomerTypePriceRule": { "method": "GET", "path": "/api/v1/customer-type-price-rules/{id}", "permissions": [ "customer_type_price_rule.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "customerTypeId": { "type": "string", "format": "uuid" }, "customerTypeInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "priceListId": { "type": "string", "format": "uuid" }, "priceListInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "discountPct": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "customerTypeId", "customerTypeInfo", "priceListId", "priceListInfo", "discountPct", "startsAt", "endsAt", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listCustomerTypeOptions": { "method": "GET", "path": "/api/v1/customer-types/options", "permissions": [ "customer_type.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "name", "-name", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `name`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: customer_types.code, customer_types.name" }, "active": { "type": "string", "description": "eq: bool" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listCustomerTypePriceRules": { "method": "GET", "path": "/api/v1/customer-type-price-rules", "permissions": [ "customer_type_price_rule.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-created_at`" }, "customer_type_id": { "type": "string", "description": "eq: uuid" }, "price_list_id": { "type": "string", "description": "eq: uuid" }, "active": { "type": "string", "description": "eq: bool" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "customerTypeId": { "type": "string", "format": "uuid" }, "customerTypeInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "priceListId": { "type": "string", "format": "uuid" }, "priceListInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "discountPct": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "customerTypeId", "customerTypeInfo", "priceListId", "priceListInfo", "discountPct", "startsAt", "endsAt", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listPriceListOptions": { "method": "GET", "path": "/api/v1/price-lists/options", "permissions": [ "price_list.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "name", "-name", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `name`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: price_lists.code, price_lists.name" }, "active": { "type": "string", "description": "eq: bool" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "updateCustomerTypePriceRule": { "method": "PATCH", "path": "/api/v1/customer-type-price-rules/{id}", "permissions": [ "customer_type_price_rule.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "discountPct": { "anyOf": [ { "type": "string", "pattern": "^(100(\\.0{1,2})?|[0-9]{1,2}(\\.[0-9]{1,2})?)$" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "customerTypeId": { "type": "string", "format": "uuid" }, "customerTypeInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "priceListId": { "type": "string", "format": "uuid" }, "priceListInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "discountPct": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "customerTypeId", "customerTypeInfo", "priceListId", "priceListInfo", "discountPct", "startsAt", "endsAt", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } }, "vi": { "schemaVersion": 1, "key": "customer_type_price_rule.customer_type_price_rules", "module": "customer_type_price_rule", "type": "crud", "revision": "6c0c059099c374b3", "title": "Giá theo loại khách", "layout": { "ops": { "list": "listCustomerTypePriceRules", "get": "getCustomerTypePriceRule", "create": "createCustomerTypePriceRule", "update": "updateCustomerTypePriceRule", "delete": "deleteCustomerTypePriceRule" }, "trash": null, "search": false, "columns": [ { "field": "customerTypeInfo.name", "label": "Loại khách", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "priceListInfo.name", "label": "Bảng giá", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "discountPct", "label": "Giảm %", "widget": "qty", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "startsAt", "label": "Bắt đầu", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] } }, { "field": "endsAt", "label": "Kết thúc", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] } }, { "field": "active", "label": "Đang dùng", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "updatedAt", "label": "Cập nhật", "widget": "datetime", "sort": "updated_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "customer_type_id", "label": "Loại khách", "widget": "picker", "options": { "op": "listCustomerTypeOptions", "value": "id", "label": "name", "hint": "code", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } }, { "param": "price_list_id", "label": "Bảng giá", "widget": "picker", "options": { "op": "listPriceListOptions", "value": "id", "label": "name", "hint": "code", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } }, { "param": "active", "label": "Đang dùng", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } } ], "form": [ { "field": "customerTypeId", "label": "Loại khách", "widget": "picker", "on": [ "create" ], "required": [ "create" ], "options": { "op": "listCustomerTypeOptions", "value": "id", "label": "name", "hint": "code", "query": { "active": "true" } }, "display": "customerTypeInfo.name", "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "format": "uuid" }, "fields": null }, { "field": "priceListId", "label": "Bảng giá", "widget": "picker", "on": [ "create" ], "required": [ "create" ], "options": { "op": "listPriceListOptions", "value": "id", "label": "name", "hint": "code", "query": { "active": "true" } }, "display": "priceListInfo.name", "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "format": "uuid" }, "fields": null }, { "field": "discountPct", "label": "Giảm %", "widget": "qty", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "pattern": "^(100(\\.0{1,2})?|[0-9]{1,2}(\\.[0-9]{1,2})?)$" }, { "type": "null" } ] }, "fields": null }, { "field": "startsAt", "label": "Bắt đầu", "widget": "datetime", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "fields": null }, { "field": "endsAt", "label": "Kết thúc", "widget": "datetime", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "fields": null }, { "field": "active", "label": "Đang dùng", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null }, { "field": "notes", "label": "Ghi chú", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "fields": null } ], "enums": {} }, "operations": { "createCustomerTypePriceRule": { "method": "POST", "path": "/api/v1/customer-type-price-rules", "permissions": [ "customer_type_price_rule.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "customerTypeId": { "type": "string", "format": "uuid" }, "priceListId": { "type": "string", "format": "uuid" }, "discountPct": { "anyOf": [ { "type": "string", "pattern": "^(100(\\.0{1,2})?|[0-9]{1,2}(\\.[0-9]{1,2})?)$" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "active": { "type": "boolean", "default": true }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [ "customerTypeId", "priceListId" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "customerTypeId": { "type": "string", "format": "uuid" }, "customerTypeInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "priceListId": { "type": "string", "format": "uuid" }, "priceListInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "discountPct": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "customerTypeId", "customerTypeInfo", "priceListId", "priceListInfo", "discountPct", "startsAt", "endsAt", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteCustomerTypePriceRule": { "method": "DELETE", "path": "/api/v1/customer-type-price-rules/{id}", "permissions": [ "customer_type_price_rule.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": null, "meta": null }, "getCustomerTypePriceRule": { "method": "GET", "path": "/api/v1/customer-type-price-rules/{id}", "permissions": [ "customer_type_price_rule.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "customerTypeId": { "type": "string", "format": "uuid" }, "customerTypeInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "priceListId": { "type": "string", "format": "uuid" }, "priceListInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "discountPct": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "customerTypeId", "customerTypeInfo", "priceListId", "priceListInfo", "discountPct", "startsAt", "endsAt", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listCustomerTypeOptions": { "method": "GET", "path": "/api/v1/customer-types/options", "permissions": [ "customer_type.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "name", "-name", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `name`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: customer_types.code, customer_types.name" }, "active": { "type": "string", "description": "eq: bool" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listCustomerTypePriceRules": { "method": "GET", "path": "/api/v1/customer-type-price-rules", "permissions": [ "customer_type_price_rule.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-created_at`" }, "customer_type_id": { "type": "string", "description": "eq: uuid" }, "price_list_id": { "type": "string", "description": "eq: uuid" }, "active": { "type": "string", "description": "eq: bool" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "customerTypeId": { "type": "string", "format": "uuid" }, "customerTypeInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "priceListId": { "type": "string", "format": "uuid" }, "priceListInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "discountPct": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "customerTypeId", "customerTypeInfo", "priceListId", "priceListInfo", "discountPct", "startsAt", "endsAt", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listPriceListOptions": { "method": "GET", "path": "/api/v1/price-lists/options", "permissions": [ "price_list.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "name", "-name", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `name`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: price_lists.code, price_lists.name" }, "active": { "type": "string", "description": "eq: bool" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "updateCustomerTypePriceRule": { "method": "PATCH", "path": "/api/v1/customer-type-price-rules/{id}", "permissions": [ "customer_type_price_rule.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "discountPct": { "anyOf": [ { "type": "string", "pattern": "^(100(\\.0{1,2})?|[0-9]{1,2}(\\.[0-9]{1,2})?)$" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "customerTypeId": { "type": "string", "format": "uuid" }, "customerTypeInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "priceListId": { "type": "string", "format": "uuid" }, "priceListInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "discountPct": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "customerTypeId", "customerTypeInfo", "priceListId", "priceListInfo", "discountPct", "startsAt", "endsAt", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } } } }, { "key": "pre_order_setting.pre_order_settings", "module": "pre_order_setting", "type": "crud", "revision": "4170a15d68f13176", "descriptors": { "en": { "schemaVersion": 1, "key": "pre_order_setting.pre_order_settings", "module": "pre_order_setting", "type": "crud", "revision": "4170a15d68f13176", "title": "Pre-order settings", "layout": { "ops": { "list": "listPreOrderSettings", "get": "getPreOrderSetting", "create": "createPreOrderSetting", "update": "updatePreOrderSetting", "delete": "deletePreOrderSetting" }, "trash": { "list": "listPreOrderSettingTrash", "restore": "restorePreOrderSetting", "columns": [ { "field": "variantInfo.productName", "label": "Product", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "variantInfo.sku", "label": "SKU", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "deletedAt", "label": "Deleted", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } }, { "field": "deletedByInfo", "label": "Deleted by", "widget": "user", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } } ] }, "search": false, "columns": [ { "field": "variantInfo.productName", "label": "Product", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "variantInfo.sku", "label": "SKU", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "allowBackorder", "label": "Allow backorder", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "maxBackorderQty", "label": "Max backorder", "widget": "qty", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "expectedRestockAt", "label": "Expected restock", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] } }, { "field": "updatedAt", "label": "Updated", "widget": "datetime", "sort": "updated_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "allow_backorder", "label": "Allow backorder", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } }, { "param": "variant_id", "label": "Product variant", "widget": "picker", "options": { "op": "listProductVariantOptions", "value": "id", "label": "productName", "hint": "optionsLabel", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } } ], "form": [ { "field": "variantId", "label": "Product variant", "widget": "picker", "on": [ "create" ], "required": [ "create" ], "options": { "op": "listProductVariantOptions", "value": "id", "label": "productName", "hint": "optionsLabel", "query": {} }, "display": "variantInfo.productName", "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "format": "uuid" }, "fields": null }, { "field": "allowBackorder", "label": "Allow backorder", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null }, { "field": "maxBackorderQty", "label": "Max backorder quantity", "widget": "qty", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "fields": null }, { "field": "expectedRestockAt", "label": "Expected restock", "widget": "datetime", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "fields": null }, { "field": "notes", "label": "Notes", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "fields": null } ], "enums": {} }, "operations": { "createPreOrderSetting": { "method": "POST", "path": "/api/v1/pre-order-settings", "permissions": [ "pre_order_setting.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid" }, "allowBackorder": { "type": "boolean", "default": true }, "maxBackorderQty": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "expectedRestockAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [ "variantId" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "allowBackorder": { "type": "boolean" }, "maxBackorderQty": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expectedRestockAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "variantId", "variantInfo", "allowBackorder", "maxBackorderQty", "expectedRestockAt", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deletePreOrderSetting": { "method": "DELETE", "path": "/api/v1/pre-order-settings/{id}", "permissions": [ "pre_order_setting.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": { "type": "object", "properties": { "force": { "enum": [ "true", "false" ], "type": "string" } }, "required": [] }, "body": null, "response": null, "meta": null }, "getPreOrderSetting": { "method": "GET", "path": "/api/v1/pre-order-settings/{id}", "permissions": [ "pre_order_setting.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "allowBackorder": { "type": "boolean" }, "maxBackorderQty": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expectedRestockAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "variantId", "variantInfo", "allowBackorder", "maxBackorderQty", "expectedRestockAt", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listPreOrderSettingTrash": { "method": "GET", "path": "/api/v1/pre-order-settings/trash", "permissions": [ "pre_order_setting.restore" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "deleted_at", "-deleted_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-deleted_at`" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "deletedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "deletedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "deletedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "variantId", "variantInfo", "deletedAt", "deletedBy", "deletedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listPreOrderSettings": { "method": "GET", "path": "/api/v1/pre-order-settings", "permissions": [ "pre_order_setting.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-created_at`" }, "variant_id": { "type": "string", "description": "eq: uuid" }, "allow_backorder": { "type": "string", "description": "eq: bool" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "allowBackorder": { "type": "boolean" }, "maxBackorderQty": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expectedRestockAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "variantId", "variantInfo", "allowBackorder", "maxBackorderQty", "expectedRestockAt", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listProductVariantOptions": { "method": "GET", "path": "/api/v1/products/variants/options", "permissions": [ "product.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 200 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "sku", "-sku" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `sku`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: product_variants.sku, product_variants.barcode, products.code, product_translations.name" }, "active": { "type": "string", "description": "eq: bool" }, "product_id": { "type": "string", "description": "eq: uuid" }, "product_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "status": { "type": "string", "description": "eq: one of: draft, active, archived" }, "status.in": { "type": "string", "description": "in: comma-separated enum values (max 100)" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel", "price", "currency" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "restorePreOrderSetting": { "method": "POST", "path": "/api/v1/pre-order-settings/{id}/restore", "permissions": [ "pre_order_setting.restore" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "allowBackorder": { "type": "boolean" }, "maxBackorderQty": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expectedRestockAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "variantId", "variantInfo", "allowBackorder", "maxBackorderQty", "expectedRestockAt", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "updatePreOrderSetting": { "method": "PATCH", "path": "/api/v1/pre-order-settings/{id}", "permissions": [ "pre_order_setting.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "allowBackorder": { "type": "boolean" }, "maxBackorderQty": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "expectedRestockAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "allowBackorder": { "type": "boolean" }, "maxBackorderQty": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expectedRestockAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "variantId", "variantInfo", "allowBackorder", "maxBackorderQty", "expectedRestockAt", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } }, "vi": { "schemaVersion": 1, "key": "pre_order_setting.pre_order_settings", "module": "pre_order_setting", "type": "crud", "revision": "4170a15d68f13176", "title": "Đặt trước / bán vượt tồn", "layout": { "ops": { "list": "listPreOrderSettings", "get": "getPreOrderSetting", "create": "createPreOrderSetting", "update": "updatePreOrderSetting", "delete": "deletePreOrderSetting" }, "trash": { "list": "listPreOrderSettingTrash", "restore": "restorePreOrderSetting", "columns": [ { "field": "variantInfo.productName", "label": "Sản phẩm", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "variantInfo.sku", "label": "SKU", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "deletedAt", "label": "Ngày xoá", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } }, { "field": "deletedByInfo", "label": "Người xoá", "widget": "user", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } } ] }, "search": false, "columns": [ { "field": "variantInfo.productName", "label": "Sản phẩm", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "variantInfo.sku", "label": "SKU", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "allowBackorder", "label": "Cho bán vượt", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "maxBackorderQty", "label": "Bán vượt tối đa", "widget": "qty", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "expectedRestockAt", "label": "Dự kiến về hàng", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] } }, { "field": "updatedAt", "label": "Cập nhật", "widget": "datetime", "sort": "updated_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "allow_backorder", "label": "Cho bán vượt", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } }, { "param": "variant_id", "label": "Biến thể sản phẩm", "widget": "picker", "options": { "op": "listProductVariantOptions", "value": "id", "label": "productName", "hint": "optionsLabel", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } } ], "form": [ { "field": "variantId", "label": "Biến thể sản phẩm", "widget": "picker", "on": [ "create" ], "required": [ "create" ], "options": { "op": "listProductVariantOptions", "value": "id", "label": "productName", "hint": "optionsLabel", "query": {} }, "display": "variantInfo.productName", "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "format": "uuid" }, "fields": null }, { "field": "allowBackorder", "label": "Cho bán vượt", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null }, { "field": "maxBackorderQty", "label": "Bán vượt tối đa", "widget": "qty", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "fields": null }, { "field": "expectedRestockAt", "label": "Dự kiến về hàng", "widget": "datetime", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "fields": null }, { "field": "notes", "label": "Ghi chú", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "fields": null } ], "enums": {} }, "operations": { "createPreOrderSetting": { "method": "POST", "path": "/api/v1/pre-order-settings", "permissions": [ "pre_order_setting.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid" }, "allowBackorder": { "type": "boolean", "default": true }, "maxBackorderQty": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "expectedRestockAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [ "variantId" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "allowBackorder": { "type": "boolean" }, "maxBackorderQty": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expectedRestockAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "variantId", "variantInfo", "allowBackorder", "maxBackorderQty", "expectedRestockAt", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deletePreOrderSetting": { "method": "DELETE", "path": "/api/v1/pre-order-settings/{id}", "permissions": [ "pre_order_setting.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": { "type": "object", "properties": { "force": { "enum": [ "true", "false" ], "type": "string" } }, "required": [] }, "body": null, "response": null, "meta": null }, "getPreOrderSetting": { "method": "GET", "path": "/api/v1/pre-order-settings/{id}", "permissions": [ "pre_order_setting.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "allowBackorder": { "type": "boolean" }, "maxBackorderQty": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expectedRestockAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "variantId", "variantInfo", "allowBackorder", "maxBackorderQty", "expectedRestockAt", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listPreOrderSettingTrash": { "method": "GET", "path": "/api/v1/pre-order-settings/trash", "permissions": [ "pre_order_setting.restore" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "deleted_at", "-deleted_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-deleted_at`" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "deletedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "deletedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "deletedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "variantId", "variantInfo", "deletedAt", "deletedBy", "deletedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listPreOrderSettings": { "method": "GET", "path": "/api/v1/pre-order-settings", "permissions": [ "pre_order_setting.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-created_at`" }, "variant_id": { "type": "string", "description": "eq: uuid" }, "allow_backorder": { "type": "string", "description": "eq: bool" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "allowBackorder": { "type": "boolean" }, "maxBackorderQty": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expectedRestockAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "variantId", "variantInfo", "allowBackorder", "maxBackorderQty", "expectedRestockAt", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listProductVariantOptions": { "method": "GET", "path": "/api/v1/products/variants/options", "permissions": [ "product.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 200 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "sku", "-sku" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `sku`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: product_variants.sku, product_variants.barcode, products.code, product_translations.name" }, "active": { "type": "string", "description": "eq: bool" }, "product_id": { "type": "string", "description": "eq: uuid" }, "product_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "status": { "type": "string", "description": "eq: one of: draft, active, archived" }, "status.in": { "type": "string", "description": "in: comma-separated enum values (max 100)" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel", "price", "currency" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "restorePreOrderSetting": { "method": "POST", "path": "/api/v1/pre-order-settings/{id}/restore", "permissions": [ "pre_order_setting.restore" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "allowBackorder": { "type": "boolean" }, "maxBackorderQty": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expectedRestockAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "variantId", "variantInfo", "allowBackorder", "maxBackorderQty", "expectedRestockAt", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "updatePreOrderSetting": { "method": "PATCH", "path": "/api/v1/pre-order-settings/{id}", "permissions": [ "pre_order_setting.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "allowBackorder": { "type": "boolean" }, "maxBackorderQty": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "expectedRestockAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "allowBackorder": { "type": "boolean" }, "maxBackorderQty": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expectedRestockAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "variantId", "variantInfo", "allowBackorder", "maxBackorderQty", "expectedRestockAt", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } } } }, { "key": "product_category.categories", "module": "product_category", "type": "crud", "revision": "ff09bcfd9ff0f693", "descriptors": { "en": { "schemaVersion": 1, "key": "product_category.categories", "module": "product_category", "type": "crud", "revision": "ff09bcfd9ff0f693", "title": "Product categories", "layout": { "ops": { "list": "listProductCategories", "get": "getProductCategory", "create": "createProductCategory", "update": "updateProductCategory", "delete": "deleteProductCategory" }, "trash": null, "search": true, "columns": [ { "field": "imageFileInfo", "label": "Image", "widget": "image", "sort": null, "options": null, "currencyField": null, "download": "downloadFile", "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] } }, { "field": "code", "label": "Code", "widget": null, "sort": "code", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Name", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "parentInfo.name", "label": "Parent", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "sortOrder", "label": "Order", "widget": "number", "sort": "sort_order", "options": null, "currencyField": null, "download": null, "schema": { "type": "number" } }, { "field": "active", "label": "Active", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "updatedAt", "label": "Updated", "widget": "datetime", "sort": "updated_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "active", "label": "Active", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } }, { "param": "parent_id", "label": "Parent", "widget": "picker", "options": { "op": "listProductCategoryOptions", "value": "id", "label": "name", "hint": "code", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } } ], "form": [ { "field": "code", "label": "Code", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "fields": null }, { "field": "translations", "label": "Translations", "widget": "translations", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "lang", "name" ] }, "maxItems": 20, "default": [] }, "fields": [ { "field": "name", "label": "Name", "widget": "text", "on": [ "create", "update" ], "required": [ "create", "update" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "fields": null }, { "field": "description", "label": "Description", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "fields": null }, { "field": "slug", "label": "Slug", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "fields": null }, { "field": "metaTitle", "label": "Meta title", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "fields": null }, { "field": "metaDescription", "label": "Meta description", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "fields": null } ] }, { "field": "parentId", "label": "Parent", "widget": "picker", "on": [ "create", "update" ], "required": [], "options": { "op": "listProductCategoryOptions", "value": "id", "label": "name", "hint": "code", "query": {} }, "display": "parentInfo.name", "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "fields": null }, { "field": "imageFileId", "label": "Image", "widget": "file", "on": [ "create", "update" ], "required": [], "options": null, "display": "imageFileInfo", "upload": "uploadFile", "download": "downloadFile", "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "fields": null }, { "field": "sortOrder", "label": "Order", "widget": "number", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "integer", "minimum": 0, "default": 0 }, "fields": null }, { "field": "active", "label": "Active", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null } ], "enums": {} }, "operations": { "createProductCategory": { "method": "POST", "path": "/api/v1/product-categories", "permissions": [ "product_category.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "imageFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sortOrder": { "type": "integer", "minimum": 0, "default": 0 }, "active": { "type": "boolean", "default": true }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "lang", "name" ] }, "maxItems": 20, "default": [] } }, "required": [ "code" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "parentInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "path": { "type": "string" }, "active": { "type": "boolean" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "path", "active", "name" ] }, { "type": "null" } ] }, "path": { "type": "string" }, "depth": { "type": "number" }, "code": { "type": "string" }, "imageFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "imageFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "parentId", "parentInfo", "path", "depth", "code", "imageFileId", "imageFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteProductCategory": { "method": "DELETE", "path": "/api/v1/product-categories/{id}", "permissions": [ "product_category.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": null, "meta": null }, "downloadFile": { "method": "GET", "path": "/api/v1/files/{id}/content", "permissions": [ "files.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": "application/octet-stream", "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": null, "meta": null }, "getProductCategory": { "method": "GET", "path": "/api/v1/product-categories/{id}", "permissions": [ "product_category.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "parentInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "path": { "type": "string" }, "active": { "type": "boolean" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "path", "active", "name" ] }, { "type": "null" } ] }, "path": { "type": "string" }, "depth": { "type": "number" }, "code": { "type": "string" }, "imageFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "imageFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "parentId", "parentInfo", "path", "depth", "code", "imageFileId", "imageFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listProductCategories": { "method": "GET", "path": "/api/v1/product-categories", "permissions": [ "product_category.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "tree", "-tree", "sort_order", "-sort_order", "code", "-code", "path", "-path", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `tree`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: product_categories.code, product_category_translations.name" }, "active": { "type": "string", "description": "eq: bool" }, "parent_id": { "type": "string", "description": "eq: uuid" }, "parent_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "parent_id.null": { "type": "string", "description": "null: `true` = is null, `false` = is not null" }, "depth": { "type": "string", "description": "eq: int" }, "depth.lte": { "type": "string", "description": "lte: int" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "parentInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "path": { "type": "string" }, "active": { "type": "boolean" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "path", "active", "name" ] }, { "type": "null" } ] }, "path": { "type": "string" }, "depth": { "type": "number" }, "code": { "type": "string" }, "imageFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "imageFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "parentId", "parentInfo", "path", "depth", "code", "imageFileId", "imageFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listProductCategoryOptions": { "method": "GET", "path": "/api/v1/product-categories/options", "permissions": [ "product_category.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "1000", "minimum": 1, "maximum": 1000 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "tree", "-tree", "sort_order", "-sort_order", "code", "-code", "path", "-path", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `tree`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: product_categories.code, product_category_translations.name" }, "active": { "type": "string", "description": "eq: bool" }, "parent_id": { "type": "string", "description": "eq: uuid" }, "parent_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "parent_id.null": { "type": "string", "description": "null: `true` = is null, `false` = is not null" }, "depth": { "type": "string", "description": "eq: int" }, "depth.lte": { "type": "string", "description": "lte: int" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "parentInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "path": { "type": "string" }, "active": { "type": "boolean" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "path", "active", "name" ] }, { "type": "null" } ] }, "path": { "type": "string" }, "depth": { "type": "number" }, "code": { "type": "string" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] } }, "required": [ "id", "parentId", "parentInfo", "path", "depth", "code", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "updateProductCategory": { "method": "PATCH", "path": "/api/v1/product-categories/{id}", "permissions": [ "product_category.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "imageFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sortOrder": { "type": "integer", "minimum": 0 }, "active": { "type": "boolean" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "lang", "name" ] }, "maxItems": 20 } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "parentInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "path": { "type": "string" }, "active": { "type": "boolean" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "path", "active", "name" ] }, { "type": "null" } ] }, "path": { "type": "string" }, "depth": { "type": "number" }, "code": { "type": "string" }, "imageFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "imageFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "parentId", "parentInfo", "path", "depth", "code", "imageFileId", "imageFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "uploadFile": { "method": "POST", "path": "/api/v1/files", "permissions": [ "files.write" ], "conditional": false, "features": [], "idempotent": false, "status": 201, "bodyContentType": "multipart/form-data", "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [] }, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" }, "storeId": { "type": "string", "format": "uuid" }, "ownerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "ownerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" } }, "required": [ "id", "name", "contentType", "size", "sha256", "storeId", "ownerId", "ownerInfo", "createdAt" ] }, "meta": null } } }, "vi": { "schemaVersion": 1, "key": "product_category.categories", "module": "product_category", "type": "crud", "revision": "ff09bcfd9ff0f693", "title": "Danh mục sản phẩm", "layout": { "ops": { "list": "listProductCategories", "get": "getProductCategory", "create": "createProductCategory", "update": "updateProductCategory", "delete": "deleteProductCategory" }, "trash": null, "search": true, "columns": [ { "field": "imageFileInfo", "label": "Ảnh", "widget": "image", "sort": null, "options": null, "currencyField": null, "download": "downloadFile", "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] } }, { "field": "code", "label": "Mã", "widget": null, "sort": "code", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Tên", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "parentInfo.name", "label": "Danh mục cha", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "sortOrder", "label": "Thứ tự", "widget": "number", "sort": "sort_order", "options": null, "currencyField": null, "download": null, "schema": { "type": "number" } }, { "field": "active", "label": "Đang dùng", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "updatedAt", "label": "Cập nhật", "widget": "datetime", "sort": "updated_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "active", "label": "Đang dùng", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } }, { "param": "parent_id", "label": "Danh mục cha", "widget": "picker", "options": { "op": "listProductCategoryOptions", "value": "id", "label": "name", "hint": "code", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } } ], "form": [ { "field": "code", "label": "Mã", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "fields": null }, { "field": "translations", "label": "Bản dịch", "widget": "translations", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "lang", "name" ] }, "maxItems": 20, "default": [] }, "fields": [ { "field": "name", "label": "Tên", "widget": "text", "on": [ "create", "update" ], "required": [ "create", "update" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "fields": null }, { "field": "description", "label": "Mô tả", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "fields": null }, { "field": "slug", "label": "Slug", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "fields": null }, { "field": "metaTitle", "label": "Tiêu đề SEO", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "fields": null }, { "field": "metaDescription", "label": "Mô tả SEO", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "fields": null } ] }, { "field": "parentId", "label": "Danh mục cha", "widget": "picker", "on": [ "create", "update" ], "required": [], "options": { "op": "listProductCategoryOptions", "value": "id", "label": "name", "hint": "code", "query": {} }, "display": "parentInfo.name", "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "fields": null }, { "field": "imageFileId", "label": "Ảnh", "widget": "file", "on": [ "create", "update" ], "required": [], "options": null, "display": "imageFileInfo", "upload": "uploadFile", "download": "downloadFile", "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "fields": null }, { "field": "sortOrder", "label": "Thứ tự", "widget": "number", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "integer", "minimum": 0, "default": 0 }, "fields": null }, { "field": "active", "label": "Đang dùng", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null } ], "enums": {} }, "operations": { "createProductCategory": { "method": "POST", "path": "/api/v1/product-categories", "permissions": [ "product_category.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "imageFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sortOrder": { "type": "integer", "minimum": 0, "default": 0 }, "active": { "type": "boolean", "default": true }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "lang", "name" ] }, "maxItems": 20, "default": [] } }, "required": [ "code" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "parentInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "path": { "type": "string" }, "active": { "type": "boolean" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "path", "active", "name" ] }, { "type": "null" } ] }, "path": { "type": "string" }, "depth": { "type": "number" }, "code": { "type": "string" }, "imageFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "imageFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "parentId", "parentInfo", "path", "depth", "code", "imageFileId", "imageFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteProductCategory": { "method": "DELETE", "path": "/api/v1/product-categories/{id}", "permissions": [ "product_category.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": null, "meta": null }, "downloadFile": { "method": "GET", "path": "/api/v1/files/{id}/content", "permissions": [ "files.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": "application/octet-stream", "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": null, "meta": null }, "getProductCategory": { "method": "GET", "path": "/api/v1/product-categories/{id}", "permissions": [ "product_category.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "parentInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "path": { "type": "string" }, "active": { "type": "boolean" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "path", "active", "name" ] }, { "type": "null" } ] }, "path": { "type": "string" }, "depth": { "type": "number" }, "code": { "type": "string" }, "imageFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "imageFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "parentId", "parentInfo", "path", "depth", "code", "imageFileId", "imageFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listProductCategories": { "method": "GET", "path": "/api/v1/product-categories", "permissions": [ "product_category.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "tree", "-tree", "sort_order", "-sort_order", "code", "-code", "path", "-path", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `tree`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: product_categories.code, product_category_translations.name" }, "active": { "type": "string", "description": "eq: bool" }, "parent_id": { "type": "string", "description": "eq: uuid" }, "parent_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "parent_id.null": { "type": "string", "description": "null: `true` = is null, `false` = is not null" }, "depth": { "type": "string", "description": "eq: int" }, "depth.lte": { "type": "string", "description": "lte: int" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "parentInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "path": { "type": "string" }, "active": { "type": "boolean" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "path", "active", "name" ] }, { "type": "null" } ] }, "path": { "type": "string" }, "depth": { "type": "number" }, "code": { "type": "string" }, "imageFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "imageFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "parentId", "parentInfo", "path", "depth", "code", "imageFileId", "imageFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listProductCategoryOptions": { "method": "GET", "path": "/api/v1/product-categories/options", "permissions": [ "product_category.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "1000", "minimum": 1, "maximum": 1000 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "tree", "-tree", "sort_order", "-sort_order", "code", "-code", "path", "-path", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `tree`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: product_categories.code, product_category_translations.name" }, "active": { "type": "string", "description": "eq: bool" }, "parent_id": { "type": "string", "description": "eq: uuid" }, "parent_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "parent_id.null": { "type": "string", "description": "null: `true` = is null, `false` = is not null" }, "depth": { "type": "string", "description": "eq: int" }, "depth.lte": { "type": "string", "description": "lte: int" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "parentInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "path": { "type": "string" }, "active": { "type": "boolean" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "path", "active", "name" ] }, { "type": "null" } ] }, "path": { "type": "string" }, "depth": { "type": "number" }, "code": { "type": "string" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] } }, "required": [ "id", "parentId", "parentInfo", "path", "depth", "code", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "updateProductCategory": { "method": "PATCH", "path": "/api/v1/product-categories/{id}", "permissions": [ "product_category.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "imageFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sortOrder": { "type": "integer", "minimum": 0 }, "active": { "type": "boolean" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string", "maxLength": 250, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "lang", "name" ] }, "maxItems": 20 } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "parentInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "path": { "type": "string" }, "active": { "type": "boolean" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "path", "active", "name" ] }, { "type": "null" } ] }, "path": { "type": "string" }, "depth": { "type": "number" }, "code": { "type": "string" }, "imageFileId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "imageFileInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" } }, "required": [ "id", "name", "contentType", "size", "sha256" ] }, { "type": "null" } ] }, "sortOrder": { "type": "number" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "metaTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang", "name", "description", "slug", "metaTitle", "metaDescription" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "parentId", "parentInfo", "path", "depth", "code", "imageFileId", "imageFileInfo", "sortOrder", "active", "lang", "name", "description", "slug", "metaTitle", "metaDescription", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "uploadFile": { "method": "POST", "path": "/api/v1/files", "permissions": [ "files.write" ], "conditional": false, "features": [], "idempotent": false, "status": 201, "bodyContentType": "multipart/form-data", "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [] }, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" }, "storeId": { "type": "string", "format": "uuid" }, "ownerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "ownerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" } }, "required": [ "id", "name", "contentType", "size", "sha256", "storeId", "ownerId", "ownerInfo", "createdAt" ] }, "meta": null } } } } }, { "key": "stock.levels", "module": "stock", "type": "crud", "revision": "5d55965caa33384f", "descriptors": { "en": { "schemaVersion": 1, "key": "stock.levels", "module": "stock", "type": "crud", "revision": "5d55965caa33384f", "title": "Stock levels", "layout": { "ops": { "list": "listStockLevels", "get": "getStockLevel", "create": null, "update": "updateStockLevel", "delete": null }, "trash": null, "search": false, "columns": [ { "field": "warehouseInfo.name", "label": "Warehouse", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "variantInfo.productName", "label": "Product", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "variantInfo.sku", "label": "SKU", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "locationInfo.name", "label": "Location", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "trackingMode", "label": "Tracking", "widget": "badge", "sort": null, "options": { "enum": "tracking_mode" }, "currencyField": null, "download": null, "schema": { "enum": [ "none", "batch", "serial" ], "type": "string" } }, { "field": "onHand", "label": "On hand", "widget": "qty", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "reserved", "label": "Reserved", "widget": "qty", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "available", "label": "Available", "widget": "qty", "sort": "available", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "lowStockThreshold", "label": "Low stock at", "widget": "qty", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "isLow", "label": "Low", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "updatedAt", "label": "Updated", "widget": "datetime", "sort": "updated_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "warehouse_id", "label": "Warehouse", "widget": "picker", "options": { "op": "listWarehouseOptions", "value": "id", "label": "name", "hint": "code", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } }, { "param": "variant_id", "label": "Product variant", "widget": "picker", "options": { "op": "listProductVariantOptions", "value": "id", "label": "productName", "hint": "optionsLabel", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } }, { "param": "is_low", "label": "Low stock", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } } ], "form": [ { "field": "lowStockThreshold", "label": "Low stock threshold", "widget": "qty", "on": [ "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "fields": null } ], "enums": { "tracking_mode": { "none": { "label": "None", "tone": "neutral" }, "batch": { "label": "Batch", "tone": "info" }, "serial": { "label": "Serial", "tone": "info" } } } }, "operations": { "getStockLevel": { "method": "GET", "path": "/api/v1/stock/levels/{id}", "permissions": [ "stock.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "warehouseId": { "type": "string", "format": "uuid" }, "warehouseInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "locationId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "locationInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "enum": [ "zone", "shelf", "bin" ], "type": "string" } }, "required": [ "id", "code", "name", "type" ] }, { "type": "null" } ] }, "trackingMode": { "enum": [ "none", "batch", "serial" ], "type": "string" }, "onHand": { "type": "string" }, "reserved": { "type": "string" }, "available": { "type": "string" }, "lowStockThreshold": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isLow": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "warehouseId", "warehouseInfo", "variantId", "variantInfo", "locationId", "locationInfo", "trackingMode", "onHand", "reserved", "available", "lowStockThreshold", "isLow", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listProductVariantOptions": { "method": "GET", "path": "/api/v1/products/variants/options", "permissions": [ "product.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 200 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "sku", "-sku" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `sku`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: product_variants.sku, product_variants.barcode, products.code, product_translations.name" }, "active": { "type": "string", "description": "eq: bool" }, "product_id": { "type": "string", "description": "eq: uuid" }, "product_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "status": { "type": "string", "description": "eq: one of: draft, active, archived" }, "status.in": { "type": "string", "description": "in: comma-separated enum values (max 100)" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel", "price", "currency" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listStockLevels": { "method": "GET", "path": "/api/v1/stock/levels", "permissions": [ "stock.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "available", "-available", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `available`" }, "warehouse_id": { "type": "string", "description": "eq: uuid" }, "warehouse_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "variant_id": { "type": "string", "description": "eq: uuid" }, "variant_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "location_id": { "type": "string", "description": "eq: uuid" }, "location_id.null": { "type": "string", "description": "null: `true` = is null, `false` = is not null" }, "is_low": { "type": "string", "description": "eq: bool" }, "available.lte": { "type": "string", "description": "lte: decimal" }, "available.gt": { "type": "string", "description": "gt: decimal" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "warehouseId": { "type": "string", "format": "uuid" }, "warehouseInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "locationId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "locationInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "enum": [ "zone", "shelf", "bin" ], "type": "string" } }, "required": [ "id", "code", "name", "type" ] }, { "type": "null" } ] }, "trackingMode": { "enum": [ "none", "batch", "serial" ], "type": "string" }, "onHand": { "type": "string" }, "reserved": { "type": "string" }, "available": { "type": "string" }, "lowStockThreshold": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isLow": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "warehouseId", "warehouseInfo", "variantId", "variantInfo", "locationId", "locationInfo", "trackingMode", "onHand", "reserved", "available", "lowStockThreshold", "isLow", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listWarehouseOptions": { "method": "GET", "path": "/api/v1/warehouses/options", "permissions": [ "warehouse.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "name", "-name", "priority", "-priority", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `priority`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: warehouses.code, warehouses.name, warehouses.city" }, "active": { "type": "string", "description": "eq: bool" }, "is_default": { "type": "string", "description": "eq: bool" }, "type": { "type": "string", "description": "eq: one of: physical, virtual, dropship" }, "type.in": { "type": "string", "description": "in: comma-separated enum values (max 100)" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "isDefault": { "type": "boolean" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "isDefault", "active" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "updateStockLevel": { "method": "PATCH", "path": "/api/v1/stock/levels/{id}", "permissions": [ "stock.adjust" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "lowStockThreshold": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "locationId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "warehouseId": { "type": "string", "format": "uuid" }, "warehouseInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "locationId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "locationInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "enum": [ "zone", "shelf", "bin" ], "type": "string" } }, "required": [ "id", "code", "name", "type" ] }, { "type": "null" } ] }, "trackingMode": { "enum": [ "none", "batch", "serial" ], "type": "string" }, "onHand": { "type": "string" }, "reserved": { "type": "string" }, "available": { "type": "string" }, "lowStockThreshold": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isLow": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "warehouseId", "warehouseInfo", "variantId", "variantInfo", "locationId", "locationInfo", "trackingMode", "onHand", "reserved", "available", "lowStockThreshold", "isLow", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } }, "vi": { "schemaVersion": 1, "key": "stock.levels", "module": "stock", "type": "crud", "revision": "5d55965caa33384f", "title": "Tồn kho", "layout": { "ops": { "list": "listStockLevels", "get": "getStockLevel", "create": null, "update": "updateStockLevel", "delete": null }, "trash": null, "search": false, "columns": [ { "field": "warehouseInfo.name", "label": "Kho", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "variantInfo.productName", "label": "Sản phẩm", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "variantInfo.sku", "label": "SKU", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "locationInfo.name", "label": "Vị trí", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "trackingMode", "label": "Theo dõi", "widget": "badge", "sort": null, "options": { "enum": "tracking_mode" }, "currencyField": null, "download": null, "schema": { "enum": [ "none", "batch", "serial" ], "type": "string" } }, { "field": "onHand", "label": "Tồn thực", "widget": "qty", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "reserved", "label": "Đã giữ", "widget": "qty", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "available", "label": "Có thể bán", "widget": "qty", "sort": "available", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "lowStockThreshold", "label": "Ngưỡng thấp", "widget": "qty", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "isLow", "label": "Tồn thấp", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "updatedAt", "label": "Cập nhật", "widget": "datetime", "sort": "updated_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "warehouse_id", "label": "Kho", "widget": "picker", "options": { "op": "listWarehouseOptions", "value": "id", "label": "name", "hint": "code", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } }, { "param": "variant_id", "label": "Biến thể sản phẩm", "widget": "picker", "options": { "op": "listProductVariantOptions", "value": "id", "label": "productName", "hint": "optionsLabel", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } }, { "param": "is_low", "label": "Tồn thấp", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } } ], "form": [ { "field": "lowStockThreshold", "label": "Ngưỡng tồn thấp", "widget": "qty", "on": [ "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "fields": null } ], "enums": { "tracking_mode": { "none": { "label": "Không theo dõi", "tone": "neutral" }, "batch": { "label": "Theo lô", "tone": "info" }, "serial": { "label": "Theo serial", "tone": "info" } } } }, "operations": { "getStockLevel": { "method": "GET", "path": "/api/v1/stock/levels/{id}", "permissions": [ "stock.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "warehouseId": { "type": "string", "format": "uuid" }, "warehouseInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "locationId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "locationInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "enum": [ "zone", "shelf", "bin" ], "type": "string" } }, "required": [ "id", "code", "name", "type" ] }, { "type": "null" } ] }, "trackingMode": { "enum": [ "none", "batch", "serial" ], "type": "string" }, "onHand": { "type": "string" }, "reserved": { "type": "string" }, "available": { "type": "string" }, "lowStockThreshold": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isLow": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "warehouseId", "warehouseInfo", "variantId", "variantInfo", "locationId", "locationInfo", "trackingMode", "onHand", "reserved", "available", "lowStockThreshold", "isLow", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listProductVariantOptions": { "method": "GET", "path": "/api/v1/products/variants/options", "permissions": [ "product.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 200 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "sku", "-sku" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `sku`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: product_variants.sku, product_variants.barcode, products.code, product_translations.name" }, "active": { "type": "string", "description": "eq: bool" }, "product_id": { "type": "string", "description": "eq: uuid" }, "product_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "status": { "type": "string", "description": "eq: one of: draft, active, archived" }, "status.in": { "type": "string", "description": "in: comma-separated enum values (max 100)" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel", "price", "currency" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listStockLevels": { "method": "GET", "path": "/api/v1/stock/levels", "permissions": [ "stock.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "available", "-available", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `available`" }, "warehouse_id": { "type": "string", "description": "eq: uuid" }, "warehouse_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "variant_id": { "type": "string", "description": "eq: uuid" }, "variant_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "location_id": { "type": "string", "description": "eq: uuid" }, "location_id.null": { "type": "string", "description": "null: `true` = is null, `false` = is not null" }, "is_low": { "type": "string", "description": "eq: bool" }, "available.lte": { "type": "string", "description": "lte: decimal" }, "available.gt": { "type": "string", "description": "gt: decimal" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "warehouseId": { "type": "string", "format": "uuid" }, "warehouseInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "locationId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "locationInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "enum": [ "zone", "shelf", "bin" ], "type": "string" } }, "required": [ "id", "code", "name", "type" ] }, { "type": "null" } ] }, "trackingMode": { "enum": [ "none", "batch", "serial" ], "type": "string" }, "onHand": { "type": "string" }, "reserved": { "type": "string" }, "available": { "type": "string" }, "lowStockThreshold": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isLow": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "warehouseId", "warehouseInfo", "variantId", "variantInfo", "locationId", "locationInfo", "trackingMode", "onHand", "reserved", "available", "lowStockThreshold", "isLow", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listWarehouseOptions": { "method": "GET", "path": "/api/v1/warehouses/options", "permissions": [ "warehouse.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "name", "-name", "priority", "-priority", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `priority`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: warehouses.code, warehouses.name, warehouses.city" }, "active": { "type": "string", "description": "eq: bool" }, "is_default": { "type": "string", "description": "eq: bool" }, "type": { "type": "string", "description": "eq: one of: physical, virtual, dropship" }, "type.in": { "type": "string", "description": "in: comma-separated enum values (max 100)" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "isDefault": { "type": "boolean" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "isDefault", "active" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "updateStockLevel": { "method": "PATCH", "path": "/api/v1/stock/levels/{id}", "permissions": [ "stock.adjust" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "lowStockThreshold": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]{0,14})(\\.[0-9]{1,4})?$" }, { "type": "null" } ] }, "locationId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "warehouseId": { "type": "string", "format": "uuid" }, "warehouseInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "id", "code", "name", "active" ] }, { "type": "null" } ] }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "locationId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "locationInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "enum": [ "zone", "shelf", "bin" ], "type": "string" } }, "required": [ "id", "code", "name", "type" ] }, { "type": "null" } ] }, "trackingMode": { "enum": [ "none", "batch", "serial" ], "type": "string" }, "onHand": { "type": "string" }, "reserved": { "type": "string" }, "available": { "type": "string" }, "lowStockThreshold": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isLow": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "warehouseId", "warehouseInfo", "variantId", "variantInfo", "locationId", "locationInfo", "trackingMode", "onHand", "reserved", "available", "lowStockThreshold", "isLow", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } } } }, { "key": "supplier.suppliers", "module": "supplier", "type": "crud", "revision": "21c7fc38b65951b6", "descriptors": { "en": { "schemaVersion": 1, "key": "supplier.suppliers", "module": "supplier", "type": "crud", "revision": "21c7fc38b65951b6", "title": "Suppliers", "layout": { "ops": { "list": "listSuppliers", "get": "getSupplier", "create": "createSupplier", "update": "updateSupplier", "delete": "deleteSupplier" }, "trash": { "list": "listSupplierTrash", "restore": "restoreSupplier", "columns": [ { "field": "code", "label": "Code", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Name", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "deletedAt", "label": "Deleted", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } }, { "field": "deletedByInfo", "label": "Deleted by", "widget": "user", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } } ] }, "search": true, "columns": [ { "field": "code", "label": "Code", "widget": null, "sort": "code", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Name", "widget": null, "sort": "name", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "contactName", "label": "Contact", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "contactPhone", "label": "Phone", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "active", "label": "Active", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "updatedAt", "label": "Updated", "widget": "datetime", "sort": "updated_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "active", "label": "Active", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } } ], "form": [ { "field": "code", "label": "Code", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "fields": null }, { "field": "name", "label": "Name", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "fields": null }, { "field": "contactName", "label": "Contact name", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 150 }, { "type": "null" } ] }, "fields": null }, { "field": "contactEmail", "label": "Contact email", "widget": "email", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "null" } ] }, "fields": null }, { "field": "contactPhone", "label": "Contact phone", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\+?[0-9 .-]{8,20}$" }, { "type": "null" } ] }, "fields": null }, { "field": "address", "label": "Address", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "fields": null }, { "field": "taxCode", "label": "Tax code", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\d{10}(-\\d{3})?$|^\\d{13}$" }, { "type": "null" } ] }, "fields": null }, { "field": "paymentTermsDays", "label": "Payment terms (days)", "widget": "number", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 365 }, { "type": "null" } ] }, "fields": null }, { "field": "active", "label": "Active", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null }, { "field": "notes", "label": "Notes", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "fields": null } ], "enums": {} }, "operations": { "createSupplier": { "method": "POST", "path": "/api/v1/suppliers", "permissions": [ "supplier.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "contactName": { "anyOf": [ { "type": "string", "maxLength": 150 }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string", "pattern": "^\\+?[0-9 .-]{8,20}$" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "taxCode": { "anyOf": [ { "type": "string", "pattern": "^\\d{10}(-\\d{3})?$|^\\d{13}$" }, { "type": "null" } ] }, "paymentTermsDays": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 365 }, { "type": "null" } ] }, "active": { "type": "boolean", "default": true }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [ "code", "name" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "contactName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "taxCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "paymentTermsDays": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "contactName", "contactEmail", "contactPhone", "address", "taxCode", "paymentTermsDays", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteSupplier": { "method": "DELETE", "path": "/api/v1/suppliers/{id}", "permissions": [ "supplier.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": { "type": "object", "properties": { "force": { "enum": [ "true", "false" ], "type": "string" } }, "required": [] }, "body": null, "response": null, "meta": null }, "getSupplier": { "method": "GET", "path": "/api/v1/suppliers/{id}", "permissions": [ "supplier.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "contactName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "taxCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "paymentTermsDays": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "contactName", "contactEmail", "contactPhone", "address", "taxCode", "paymentTermsDays", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listSupplierTrash": { "method": "GET", "path": "/api/v1/suppliers/trash", "permissions": [ "supplier.restore" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "deleted_at", "-deleted_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-deleted_at`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: suppliers.code, suppliers.name" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "deletedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "deletedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "deletedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "code", "name", "deletedAt", "deletedBy", "deletedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listSuppliers": { "method": "GET", "path": "/api/v1/suppliers", "permissions": [ "supplier.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "name", "-name", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `name`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: suppliers.code, suppliers.name, suppliers.contact_name, suppliers.tax_code" }, "active": { "type": "string", "description": "eq: bool" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "contactName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "taxCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "paymentTermsDays": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "contactName", "contactEmail", "contactPhone", "address", "taxCode", "paymentTermsDays", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "restoreSupplier": { "method": "POST", "path": "/api/v1/suppliers/{id}/restore", "permissions": [ "supplier.restore" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "contactName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "taxCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "paymentTermsDays": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "contactName", "contactEmail", "contactPhone", "address", "taxCode", "paymentTermsDays", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "updateSupplier": { "method": "PATCH", "path": "/api/v1/suppliers/{id}", "permissions": [ "supplier.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "contactName": { "anyOf": [ { "type": "string", "maxLength": 150 }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string", "pattern": "^\\+?[0-9 .-]{8,20}$" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "taxCode": { "anyOf": [ { "type": "string", "pattern": "^\\d{10}(-\\d{3})?$|^\\d{13}$" }, { "type": "null" } ] }, "paymentTermsDays": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 365 }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "contactName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "taxCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "paymentTermsDays": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "contactName", "contactEmail", "contactPhone", "address", "taxCode", "paymentTermsDays", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } }, "vi": { "schemaVersion": 1, "key": "supplier.suppliers", "module": "supplier", "type": "crud", "revision": "21c7fc38b65951b6", "title": "Nhà cung cấp", "layout": { "ops": { "list": "listSuppliers", "get": "getSupplier", "create": "createSupplier", "update": "updateSupplier", "delete": "deleteSupplier" }, "trash": { "list": "listSupplierTrash", "restore": "restoreSupplier", "columns": [ { "field": "code", "label": "Mã", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Tên", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "deletedAt", "label": "Ngày xoá", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } }, { "field": "deletedByInfo", "label": "Người xoá", "widget": "user", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } } ] }, "search": true, "columns": [ { "field": "code", "label": "Mã", "widget": null, "sort": "code", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Tên", "widget": null, "sort": "name", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "contactName", "label": "Người liên hệ", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "contactPhone", "label": "Số điện thoại", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "active", "label": "Đang dùng", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "updatedAt", "label": "Cập nhật", "widget": "datetime", "sort": "updated_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "active", "label": "Đang dùng", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } } ], "form": [ { "field": "code", "label": "Mã", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "fields": null }, { "field": "name", "label": "Tên", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "fields": null }, { "field": "contactName", "label": "Người liên hệ", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 150 }, { "type": "null" } ] }, "fields": null }, { "field": "contactEmail", "label": "Email liên hệ", "widget": "email", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "null" } ] }, "fields": null }, { "field": "contactPhone", "label": "Số điện thoại", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\+?[0-9 .-]{8,20}$" }, { "type": "null" } ] }, "fields": null }, { "field": "address", "label": "Địa chỉ", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "fields": null }, { "field": "taxCode", "label": "Mã số thuế", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\d{10}(-\\d{3})?$|^\\d{13}$" }, { "type": "null" } ] }, "fields": null }, { "field": "paymentTermsDays", "label": "Hạn thanh toán (ngày)", "widget": "number", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 365 }, { "type": "null" } ] }, "fields": null }, { "field": "active", "label": "Đang dùng", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null }, { "field": "notes", "label": "Ghi chú", "widget": "textarea", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "fields": null } ], "enums": {} }, "operations": { "createSupplier": { "method": "POST", "path": "/api/v1/suppliers", "permissions": [ "supplier.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "contactName": { "anyOf": [ { "type": "string", "maxLength": 150 }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string", "pattern": "^\\+?[0-9 .-]{8,20}$" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "taxCode": { "anyOf": [ { "type": "string", "pattern": "^\\d{10}(-\\d{3})?$|^\\d{13}$" }, { "type": "null" } ] }, "paymentTermsDays": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 365 }, { "type": "null" } ] }, "active": { "type": "boolean", "default": true }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [ "code", "name" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "contactName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "taxCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "paymentTermsDays": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "contactName", "contactEmail", "contactPhone", "address", "taxCode", "paymentTermsDays", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteSupplier": { "method": "DELETE", "path": "/api/v1/suppliers/{id}", "permissions": [ "supplier.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": { "type": "object", "properties": { "force": { "enum": [ "true", "false" ], "type": "string" } }, "required": [] }, "body": null, "response": null, "meta": null }, "getSupplier": { "method": "GET", "path": "/api/v1/suppliers/{id}", "permissions": [ "supplier.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "contactName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "taxCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "paymentTermsDays": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "contactName", "contactEmail", "contactPhone", "address", "taxCode", "paymentTermsDays", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listSupplierTrash": { "method": "GET", "path": "/api/v1/suppliers/trash", "permissions": [ "supplier.restore" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "deleted_at", "-deleted_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-deleted_at`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: suppliers.code, suppliers.name" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "deletedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "deletedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "deletedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "code", "name", "deletedAt", "deletedBy", "deletedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listSuppliers": { "method": "GET", "path": "/api/v1/suppliers", "permissions": [ "supplier.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "name", "-name", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `name`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: suppliers.code, suppliers.name, suppliers.contact_name, suppliers.tax_code" }, "active": { "type": "string", "description": "eq: bool" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "contactName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "taxCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "paymentTermsDays": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "contactName", "contactEmail", "contactPhone", "address", "taxCode", "paymentTermsDays", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "restoreSupplier": { "method": "POST", "path": "/api/v1/suppliers/{id}/restore", "permissions": [ "supplier.restore" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "contactName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "taxCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "paymentTermsDays": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "contactName", "contactEmail", "contactPhone", "address", "taxCode", "paymentTermsDays", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "updateSupplier": { "method": "PATCH", "path": "/api/v1/suppliers/{id}", "permissions": [ "supplier.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "contactName": { "anyOf": [ { "type": "string", "maxLength": 150 }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string", "pattern": "^\\+?[0-9 .-]{8,20}$" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "taxCode": { "anyOf": [ { "type": "string", "pattern": "^\\d{10}(-\\d{3})?$|^\\d{13}$" }, { "type": "null" } ] }, "paymentTermsDays": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 365 }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "contactName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "taxCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "paymentTermsDays": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "contactName", "contactEmail", "contactPhone", "address", "taxCode", "paymentTermsDays", "active", "notes", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } } } }, { "key": "uom.uoms", "module": "uom", "type": "crud", "revision": "9089e9034ddbf16c", "descriptors": { "en": { "schemaVersion": 1, "key": "uom.uoms", "module": "uom", "type": "crud", "revision": "9089e9034ddbf16c", "title": "Units of measure", "layout": { "ops": { "list": "listUoms", "get": "getUom", "create": "createUom", "update": "updateUom", "delete": "deleteUom" }, "trash": { "list": "listUomTrash", "restore": "restoreUom", "columns": [ { "field": "code", "label": "Code", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Name", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "deletedAt", "label": "Deleted", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } }, { "field": "deletedByInfo", "label": "Deleted by", "widget": "user", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } } ] }, "search": true, "columns": [ { "field": "code", "label": "Code", "widget": null, "sort": "code", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Name", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "symbol", "label": "Symbol", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "category", "label": "Category", "widget": "badge", "sort": "category", "options": { "enum": "category" }, "currencyField": null, "download": null, "schema": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" } }, { "field": "allowFraction", "label": "Fractions", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "active", "label": "Active", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } } ], "filters": [ { "param": "active", "label": "Active", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } }, { "param": "category", "label": "Category", "widget": "select", "options": { "enum": "category" }, "schema": { "type": "string", "description": "eq: text" } } ], "form": [ { "field": "code", "label": "Code", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,29}$" }, "fields": null }, { "field": "category", "label": "Category", "widget": "select", "on": [ "create", "update" ], "required": [ "create" ], "options": { "enum": "category" }, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "fields": null }, { "field": "symbol", "label": "Symbol", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 10 }, { "type": "null" } ] }, "fields": null }, { "field": "allowFraction", "label": "Allow fractions", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": false }, "fields": null }, { "field": "active", "label": "Active", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null }, { "field": "translations", "label": "Translations", "widget": "translations", "on": [ "create" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "lang", "name" ] }, "maxItems": 20, "default": [] }, "fields": [ { "field": "name", "label": "Name", "widget": "text", "on": [ "create" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": null } ] } ], "enums": { "category": { "count": { "label": "Count", "tone": null }, "weight": { "label": "Weight", "tone": null }, "volume": { "label": "Volume", "tone": null }, "length": { "label": "Length", "tone": null }, "area": { "label": "Area", "tone": null }, "time": { "label": "Time", "tone": null }, "service": { "label": "Service", "tone": null }, "digital": { "label": "Digital", "tone": null }, "energy": { "label": "Energy", "tone": null } } } }, "operations": { "createUom": { "method": "POST", "path": "/api/v1/uoms", "permissions": [ "uom.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,29}$" }, "category": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "symbol": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 10 }, { "type": "null" } ] }, "allowFraction": { "type": "boolean", "default": false }, "active": { "type": "boolean", "default": true }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "lang", "name" ] }, "maxItems": 20, "default": [] } }, "required": [ "code", "category" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "category": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "allowFraction": { "type": "boolean" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" } }, "required": [ "lang", "name" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "category", "symbol", "allowFraction", "active", "lang", "name", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteUom": { "method": "DELETE", "path": "/api/v1/uoms/{id}", "permissions": [ "uom.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": { "type": "object", "properties": { "force": { "enum": [ "true", "false" ], "type": "string" } }, "required": [] }, "body": null, "response": null, "meta": null }, "getUom": { "method": "GET", "path": "/api/v1/uoms/{id}", "permissions": [ "uom.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "category": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "allowFraction": { "type": "boolean" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" } }, "required": [ "lang", "name" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "category", "symbol", "allowFraction", "active", "lang", "name", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listUomTrash": { "method": "GET", "path": "/api/v1/uoms/trash", "permissions": [ "uom.restore" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "deleted_at", "-deleted_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-deleted_at`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: uoms.code, uom_translations.name" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deletedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "deletedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "deletedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "code", "symbol", "lang", "name", "deletedAt", "deletedBy", "deletedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listUoms": { "method": "GET", "path": "/api/v1/uoms", "permissions": [ "uom.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "category", "-category", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `code`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: uoms.code, uom_translations.name" }, "active": { "type": "string", "description": "eq: bool" }, "category": { "type": "string", "description": "eq: text" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "category": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "allowFraction": { "type": "boolean" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" } }, "required": [ "lang", "name" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "category", "symbol", "allowFraction", "active", "lang", "name", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "restoreUom": { "method": "POST", "path": "/api/v1/uoms/{id}/restore", "permissions": [ "uom.restore" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "category": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "allowFraction": { "type": "boolean" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" } }, "required": [ "lang", "name" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "category", "symbol", "allowFraction", "active", "lang", "name", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "updateUom": { "method": "PATCH", "path": "/api/v1/uoms/{id}", "permissions": [ "uom.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,29}$" }, "category": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "symbol": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 10 }, { "type": "null" } ] }, "allowFraction": { "type": "boolean" }, "active": { "type": "boolean" } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "category": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "allowFraction": { "type": "boolean" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" } }, "required": [ "lang", "name" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "category", "symbol", "allowFraction", "active", "lang", "name", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } }, "vi": { "schemaVersion": 1, "key": "uom.uoms", "module": "uom", "type": "crud", "revision": "9089e9034ddbf16c", "title": "Đơn vị tính", "layout": { "ops": { "list": "listUoms", "get": "getUom", "create": "createUom", "update": "updateUom", "delete": "deleteUom" }, "trash": { "list": "listUomTrash", "restore": "restoreUom", "columns": [ { "field": "code", "label": "Mã", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Tên", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "deletedAt", "label": "Ngày xoá", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } }, { "field": "deletedByInfo", "label": "Người xoá", "widget": "user", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } } ] }, "search": true, "columns": [ { "field": "code", "label": "Mã", "widget": null, "sort": "code", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Tên", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "symbol", "label": "Ký hiệu", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "category", "label": "Nhóm", "widget": "badge", "sort": "category", "options": { "enum": "category" }, "currencyField": null, "download": null, "schema": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" } }, { "field": "allowFraction", "label": "Số lẻ", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "active", "label": "Đang dùng", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } } ], "filters": [ { "param": "active", "label": "Đang dùng", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } }, { "param": "category", "label": "Nhóm", "widget": "select", "options": { "enum": "category" }, "schema": { "type": "string", "description": "eq: text" } } ], "form": [ { "field": "code", "label": "Mã", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,29}$" }, "fields": null }, { "field": "category", "label": "Nhóm", "widget": "select", "on": [ "create", "update" ], "required": [ "create" ], "options": { "enum": "category" }, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "fields": null }, { "field": "symbol", "label": "Ký hiệu", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 10 }, { "type": "null" } ] }, "fields": null }, { "field": "allowFraction", "label": "Cho số lẻ", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": false }, "fields": null }, { "field": "active", "label": "Đang dùng", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null }, { "field": "translations", "label": "Bản dịch", "widget": "translations", "on": [ "create" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "lang", "name" ] }, "maxItems": 20, "default": [] }, "fields": [ { "field": "name", "label": "Tên", "widget": "text", "on": [ "create" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": null } ] } ], "enums": { "category": { "count": { "label": "Đếm", "tone": null }, "weight": { "label": "Khối lượng", "tone": null }, "volume": { "label": "Thể tích", "tone": null }, "length": { "label": "Chiều dài", "tone": null }, "area": { "label": "Diện tích", "tone": null }, "time": { "label": "Thời gian", "tone": null }, "service": { "label": "Dịch vụ", "tone": null }, "digital": { "label": "Kỹ thuật số", "tone": null }, "energy": { "label": "Năng lượng", "tone": null } } } }, "operations": { "createUom": { "method": "POST", "path": "/api/v1/uoms", "permissions": [ "uom.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,29}$" }, "category": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "symbol": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 10 }, { "type": "null" } ] }, "allowFraction": { "type": "boolean", "default": false }, "active": { "type": "boolean", "default": true }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "pattern": "^[a-z]{2,3}(-([A-Z][a-z]{3}|[A-Z]{2}|\\d{3}))?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "lang", "name" ] }, "maxItems": 20, "default": [] } }, "required": [ "code", "category" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "category": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "allowFraction": { "type": "boolean" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" } }, "required": [ "lang", "name" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "category", "symbol", "allowFraction", "active", "lang", "name", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteUom": { "method": "DELETE", "path": "/api/v1/uoms/{id}", "permissions": [ "uom.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": { "type": "object", "properties": { "force": { "enum": [ "true", "false" ], "type": "string" } }, "required": [] }, "body": null, "response": null, "meta": null }, "getUom": { "method": "GET", "path": "/api/v1/uoms/{id}", "permissions": [ "uom.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "category": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "allowFraction": { "type": "boolean" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" } }, "required": [ "lang", "name" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "category", "symbol", "allowFraction", "active", "lang", "name", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listUomTrash": { "method": "GET", "path": "/api/v1/uoms/trash", "permissions": [ "uom.restore" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "deleted_at", "-deleted_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-deleted_at`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: uoms.code, uom_translations.name" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deletedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "deletedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "deletedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "code", "symbol", "lang", "name", "deletedAt", "deletedBy", "deletedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listUoms": { "method": "GET", "path": "/api/v1/uoms", "permissions": [ "uom.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "category", "-category", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `code`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: uoms.code, uom_translations.name" }, "active": { "type": "string", "description": "eq: bool" }, "category": { "type": "string", "description": "eq: text" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "category": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "allowFraction": { "type": "boolean" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" } }, "required": [ "lang", "name" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "category", "symbol", "allowFraction", "active", "lang", "name", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "restoreUom": { "method": "POST", "path": "/api/v1/uoms/{id}/restore", "permissions": [ "uom.restore" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "category": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "allowFraction": { "type": "boolean" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" } }, "required": [ "lang", "name" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "category", "symbol", "allowFraction", "active", "lang", "name", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "updateUom": { "method": "PATCH", "path": "/api/v1/uoms/{id}", "permissions": [ "uom.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,29}$" }, "category": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "symbol": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 10 }, { "type": "null" } ] }, "allowFraction": { "type": "boolean" }, "active": { "type": "boolean" } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "category": { "enum": [ "count", "weight", "volume", "length", "area", "time", "service", "digital", "energy" ], "type": "string" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "allowFraction": { "type": "boolean" }, "active": { "type": "boolean" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "translations": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string" }, "name": { "type": "string" } }, "required": [ "lang", "name" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "category", "symbol", "allowFraction", "active", "lang", "name", "translations", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } } } }, { "key": "warehouse.warehouses", "module": "warehouse", "type": "crud", "revision": "2332e8656eea7e4d", "descriptors": { "en": { "schemaVersion": 1, "key": "warehouse.warehouses", "module": "warehouse", "type": "crud", "revision": "2332e8656eea7e4d", "title": "Warehouses", "layout": { "ops": { "list": "listWarehouses", "get": "getWarehouse", "create": "createWarehouse", "update": "updateWarehouse", "delete": "deleteWarehouse" }, "trash": { "list": "listWarehouseTrash", "restore": "restoreWarehouse", "columns": [ { "field": "code", "label": "Code", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Name", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "deletedAt", "label": "Deleted", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } }, { "field": "deletedByInfo", "label": "Deleted by", "widget": "user", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } } ] }, "search": true, "columns": [ { "field": "code", "label": "Code", "widget": null, "sort": "code", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Name", "widget": null, "sort": "name", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "type", "label": "Type", "widget": "badge", "sort": null, "options": { "enum": "type" }, "currencyField": null, "download": null, "schema": { "enum": [ "physical", "virtual", "dropship" ], "type": "string" } }, { "field": "city", "label": "City", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "isDefault", "label": "Default", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "priority", "label": "Priority", "widget": "number", "sort": "priority", "options": null, "currencyField": null, "download": null, "schema": { "type": "number" } }, { "field": "active", "label": "Active", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } } ], "filters": [ { "param": "active", "label": "Active", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } }, { "param": "is_default", "label": "Default", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } }, { "param": "type", "label": "Type", "widget": "select", "options": { "enum": "type" }, "schema": { "type": "string", "description": "eq: one of: physical, virtual, dropship" } } ], "form": [ { "field": "code", "label": "Code", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "fields": null }, { "field": "name", "label": "Name", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "fields": null }, { "field": "type", "label": "Type", "widget": "select", "on": [ "create", "update" ], "required": [], "options": { "enum": "type" }, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "enum": [ "physical", "virtual", "dropship" ], "type": "string", "default": "physical" }, "fields": null }, { "field": "addressLine", "label": "Address", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "fields": null }, { "field": "city", "label": "City", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 150 }, { "type": "null" } ] }, "fields": null }, { "field": "phone", "label": "Phone", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\+?[0-9 .-]{8,20}$" }, { "type": "null" } ] }, "fields": null }, { "field": "email", "label": "Email", "widget": "email", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "email", "maxLength": 255 }, { "type": "null" } ] }, "fields": null }, { "field": "isDefault", "label": "Default warehouse", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": false }, "fields": null }, { "field": "active", "label": "Active", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null }, { "field": "priority", "label": "Priority", "widget": "number", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "integer", "minimum": 0, "maximum": 1000000, "default": 0 }, "fields": null } ], "enums": { "type": { "physical": { "label": "Physical", "tone": "info" }, "virtual": { "label": "Virtual", "tone": "neutral" }, "dropship": { "label": "Dropship", "tone": "warning" } } } }, "operations": { "createWarehouse": { "method": "POST", "path": "/api/v1/warehouses", "permissions": [ "warehouse.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "type": { "enum": [ "physical", "virtual", "dropship" ], "type": "string", "default": "physical" }, "addressLine": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 150 }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string", "pattern": "^\\+?[0-9 .-]{8,20}$" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string", "format": "email", "maxLength": 255 }, { "type": "null" } ] }, "isDefault": { "type": "boolean", "default": false }, "active": { "type": "boolean", "default": true }, "priority": { "type": "integer", "minimum": 0, "maximum": 1000000, "default": 0 } }, "required": [ "code", "name" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "type": { "enum": [ "physical", "virtual", "dropship" ], "type": "string" }, "addressLine": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDefault": { "type": "boolean" }, "active": { "type": "boolean" }, "priority": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "type", "addressLine", "city", "phone", "email", "isDefault", "active", "priority", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteWarehouse": { "method": "DELETE", "path": "/api/v1/warehouses/{id}", "permissions": [ "warehouse.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": { "type": "object", "properties": { "force": { "enum": [ "true", "false" ], "type": "string" } }, "required": [] }, "body": null, "response": null, "meta": null }, "getWarehouse": { "method": "GET", "path": "/api/v1/warehouses/{id}", "permissions": [ "warehouse.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "type": { "enum": [ "physical", "virtual", "dropship" ], "type": "string" }, "addressLine": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDefault": { "type": "boolean" }, "active": { "type": "boolean" }, "priority": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "type", "addressLine", "city", "phone", "email", "isDefault", "active", "priority", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listWarehouseTrash": { "method": "GET", "path": "/api/v1/warehouses/trash", "permissions": [ "warehouse.restore" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "deleted_at", "-deleted_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-deleted_at`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: warehouses.code, warehouses.name" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "deletedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "deletedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "deletedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "code", "name", "deletedAt", "deletedBy", "deletedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listWarehouses": { "method": "GET", "path": "/api/v1/warehouses", "permissions": [ "warehouse.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "name", "-name", "priority", "-priority", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `priority`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: warehouses.code, warehouses.name, warehouses.city" }, "active": { "type": "string", "description": "eq: bool" }, "is_default": { "type": "string", "description": "eq: bool" }, "type": { "type": "string", "description": "eq: one of: physical, virtual, dropship" }, "type.in": { "type": "string", "description": "in: comma-separated enum values (max 100)" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "type": { "enum": [ "physical", "virtual", "dropship" ], "type": "string" }, "addressLine": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDefault": { "type": "boolean" }, "active": { "type": "boolean" }, "priority": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "type", "addressLine", "city", "phone", "email", "isDefault", "active", "priority", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "restoreWarehouse": { "method": "POST", "path": "/api/v1/warehouses/{id}/restore", "permissions": [ "warehouse.restore" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "type": { "enum": [ "physical", "virtual", "dropship" ], "type": "string" }, "addressLine": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDefault": { "type": "boolean" }, "active": { "type": "boolean" }, "priority": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "type", "addressLine", "city", "phone", "email", "isDefault", "active", "priority", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "updateWarehouse": { "method": "PATCH", "path": "/api/v1/warehouses/{id}", "permissions": [ "warehouse.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "type": { "enum": [ "physical", "virtual", "dropship" ], "type": "string" }, "addressLine": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 150 }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string", "pattern": "^\\+?[0-9 .-]{8,20}$" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string", "format": "email", "maxLength": 255 }, { "type": "null" } ] }, "isDefault": { "type": "boolean" }, "active": { "type": "boolean" }, "priority": { "type": "integer", "minimum": 0, "maximum": 1000000 } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "type": { "enum": [ "physical", "virtual", "dropship" ], "type": "string" }, "addressLine": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDefault": { "type": "boolean" }, "active": { "type": "boolean" }, "priority": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "type", "addressLine", "city", "phone", "email", "isDefault", "active", "priority", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } }, "vi": { "schemaVersion": 1, "key": "warehouse.warehouses", "module": "warehouse", "type": "crud", "revision": "2332e8656eea7e4d", "title": "Kho hàng", "layout": { "ops": { "list": "listWarehouses", "get": "getWarehouse", "create": "createWarehouse", "update": "updateWarehouse", "delete": "deleteWarehouse" }, "trash": { "list": "listWarehouseTrash", "restore": "restoreWarehouse", "columns": [ { "field": "code", "label": "Mã", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Tên", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "deletedAt", "label": "Ngày xoá", "widget": "datetime", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } }, { "field": "deletedByInfo", "label": "Người xoá", "widget": "user", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } } ] }, "search": true, "columns": [ { "field": "code", "label": "Mã", "widget": null, "sort": "code", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "name", "label": "Tên", "widget": null, "sort": "name", "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "type", "label": "Loại", "widget": "badge", "sort": null, "options": { "enum": "type" }, "currencyField": null, "download": null, "schema": { "enum": [ "physical", "virtual", "dropship" ], "type": "string" } }, { "field": "city", "label": "Thành phố", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "isDefault", "label": "Mặc định", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "priority", "label": "Ưu tiên", "widget": "number", "sort": "priority", "options": null, "currencyField": null, "download": null, "schema": { "type": "number" } }, { "field": "active", "label": "Đang dùng", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } } ], "filters": [ { "param": "active", "label": "Đang dùng", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } }, { "param": "is_default", "label": "Mặc định", "widget": "boolean", "options": null, "schema": { "type": "string", "description": "eq: bool" } }, { "param": "type", "label": "Loại", "widget": "select", "options": { "enum": "type" }, "schema": { "type": "string", "description": "eq: one of: physical, virtual, dropship" } } ], "form": [ { "field": "code", "label": "Mã", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "fields": null }, { "field": "name", "label": "Tên", "widget": "text", "on": [ "create", "update" ], "required": [ "create" ], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "fields": null }, { "field": "type", "label": "Loại", "widget": "select", "on": [ "create", "update" ], "required": [], "options": { "enum": "type" }, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "enum": [ "physical", "virtual", "dropship" ], "type": "string", "default": "physical" }, "fields": null }, { "field": "addressLine", "label": "Địa chỉ", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "fields": null }, { "field": "city", "label": "Thành phố", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "maxLength": 150 }, { "type": "null" } ] }, "fields": null }, { "field": "phone", "label": "Điện thoại", "widget": "text", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\+?[0-9 .-]{8,20}$" }, { "type": "null" } ] }, "fields": null }, { "field": "email", "label": "Email", "widget": "email", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "anyOf": [ { "type": "string", "format": "email", "maxLength": 255 }, { "type": "null" } ] }, "fields": null }, { "field": "isDefault", "label": "Kho mặc định", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": false }, "fields": null }, { "field": "active", "label": "Đang dùng", "widget": "switch", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "boolean", "default": true }, "fields": null }, { "field": "priority", "label": "Ưu tiên", "widget": "number", "on": [ "create", "update" ], "required": [], "options": null, "display": null, "upload": null, "download": null, "currencyField": null, "schema": { "type": "integer", "minimum": 0, "maximum": 1000000, "default": 0 }, "fields": null } ], "enums": { "type": { "physical": { "label": "Kho thật", "tone": "info" }, "virtual": { "label": "Kho ảo", "tone": "neutral" }, "dropship": { "label": "Dropship", "tone": "warning" } } } }, "operations": { "createWarehouse": { "method": "POST", "path": "/api/v1/warehouses", "permissions": [ "warehouse.create" ], "conditional": false, "features": [], "idempotent": true, "status": 201, "bodyContentType": "application/json", "rawResponse": null, "params": null, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "type": { "enum": [ "physical", "virtual", "dropship" ], "type": "string", "default": "physical" }, "addressLine": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 150 }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string", "pattern": "^\\+?[0-9 .-]{8,20}$" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string", "format": "email", "maxLength": 255 }, { "type": "null" } ] }, "isDefault": { "type": "boolean", "default": false }, "active": { "type": "boolean", "default": true }, "priority": { "type": "integer", "minimum": 0, "maximum": 1000000, "default": 0 } }, "required": [ "code", "name" ] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "type": { "enum": [ "physical", "virtual", "dropship" ], "type": "string" }, "addressLine": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDefault": { "type": "boolean" }, "active": { "type": "boolean" }, "priority": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "type", "addressLine", "city", "phone", "email", "isDefault", "active", "priority", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "deleteWarehouse": { "method": "DELETE", "path": "/api/v1/warehouses/{id}", "permissions": [ "warehouse.delete" ], "conditional": false, "features": [], "idempotent": true, "status": 204, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": { "type": "object", "properties": { "force": { "enum": [ "true", "false" ], "type": "string" } }, "required": [] }, "body": null, "response": null, "meta": null }, "getWarehouse": { "method": "GET", "path": "/api/v1/warehouses/{id}", "permissions": [ "warehouse.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "type": { "enum": [ "physical", "virtual", "dropship" ], "type": "string" }, "addressLine": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDefault": { "type": "boolean" }, "active": { "type": "boolean" }, "priority": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "type", "addressLine", "city", "phone", "email", "isDefault", "active", "priority", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "listWarehouseTrash": { "method": "GET", "path": "/api/v1/warehouses/trash", "permissions": [ "warehouse.restore" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "deleted_at", "-deleted_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-deleted_at`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: warehouses.code, warehouses.name" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "deletedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "deletedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "deletedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "code", "name", "deletedAt", "deletedBy", "deletedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listWarehouses": { "method": "GET", "path": "/api/v1/warehouses", "permissions": [ "warehouse.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "code", "-code", "name", "-name", "priority", "-priority", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `priority`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: warehouses.code, warehouses.name, warehouses.city" }, "active": { "type": "string", "description": "eq: bool" }, "is_default": { "type": "string", "description": "eq: bool" }, "type": { "type": "string", "description": "eq: one of: physical, virtual, dropship" }, "type.in": { "type": "string", "description": "in: comma-separated enum values (max 100)" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "type": { "enum": [ "physical", "virtual", "dropship" ], "type": "string" }, "addressLine": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDefault": { "type": "boolean" }, "active": { "type": "boolean" }, "priority": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "type", "addressLine", "city", "phone", "email", "isDefault", "active", "priority", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "restoreWarehouse": { "method": "POST", "path": "/api/v1/warehouses/{id}/restore", "permissions": [ "warehouse.restore" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": null, "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": null, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "type": { "enum": [ "physical", "virtual", "dropship" ], "type": "string" }, "addressLine": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDefault": { "type": "boolean" }, "active": { "type": "boolean" }, "priority": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "type", "addressLine", "city", "phone", "email", "isDefault", "active", "priority", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null }, "updateWarehouse": { "method": "PATCH", "path": "/api/v1/warehouses/{id}", "permissions": [ "warehouse.update" ], "conditional": false, "features": [], "idempotent": true, "status": 200, "bodyContentType": "application/json", "rawResponse": null, "params": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ] }, "query": null, "body": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "type": { "enum": [ "physical", "virtual", "dropship" ], "type": "string" }, "addressLine": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 150 }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string", "pattern": "^\\+?[0-9 .-]{8,20}$" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string", "format": "email", "maxLength": 255 }, { "type": "null" } ] }, "isDefault": { "type": "boolean" }, "active": { "type": "boolean" }, "priority": { "type": "integer", "minimum": 0, "maximum": 1000000 } }, "required": [] }, "response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "type": { "enum": [ "physical", "virtual", "dropship" ], "type": "string" }, "addressLine": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDefault": { "type": "boolean" }, "active": { "type": "boolean" }, "priority": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "createdByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "Z$" }, "updatedBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "updatedByInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "login": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "login", "name" ] }, { "type": "null" } ] } }, "required": [ "id", "storeId", "code", "name", "type", "addressLine", "city", "phone", "email", "isDefault", "active", "priority", "createdAt", "createdBy", "createdByInfo", "updatedAt", "updatedBy", "updatedByInfo" ] }, "meta": null } } } } }, { "key": "wishlist.wishlist_items", "module": "wishlist", "type": "crud", "revision": "b043163b3845de8d", "descriptors": { "en": { "schemaVersion": 1, "key": "wishlist.wishlist_items", "module": "wishlist", "type": "crud", "revision": "b043163b3845de8d", "title": "Wishlists", "layout": { "ops": { "list": "listWishlistItems", "get": null, "create": null, "update": null, "delete": null }, "trash": null, "search": false, "columns": [ { "field": "customerInfo.name", "label": "Customer", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "variantInfo.productName", "label": "Product", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "variantInfo.optionsLabel", "label": "Variant", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "onSale", "label": "On sale", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "createdAt", "label": "Added", "widget": "datetime", "sort": "created_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "customer_id", "label": "Customer", "widget": "picker", "options": { "op": "listCustomers", "value": "id", "label": "name", "hint": "email", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } }, { "param": "variant_id", "label": "Product variant", "widget": "picker", "options": { "op": "listProductVariantOptions", "value": "id", "label": "productName", "hint": "optionsLabel", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } } ], "form": [], "enums": {} }, "operations": { "listCustomers": { "method": "GET", "path": "/api/v1/core/customers", "permissions": [ "core.view_customers" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "50", "minimum": 1, "maximum": 200 }, "cursor": { "type": "string", "maxLength": 254 }, "email": { "type": "string", "maxLength": 254, "format": "email" }, "q": { "type": "string", "maxLength": 100 }, "store": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "emailVerifiedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "phoneVerifiedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "deletionRequestedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "purgeAfter": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "stores": { "type": "array", "items": { "type": "string" } }, "erasable": { "type": "boolean" }, "editable": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" } }, "required": [ "id", "email", "name", "phone", "active", "emailVerifiedAt", "phoneVerifiedAt", "deletionRequestedAt", "purgeAfter", "stores", "erasable", "editable", "createdAt" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listProductVariantOptions": { "method": "GET", "path": "/api/v1/products/variants/options", "permissions": [ "product.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 200 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "sku", "-sku" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `sku`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: product_variants.sku, product_variants.barcode, products.code, product_translations.name" }, "active": { "type": "string", "description": "eq: bool" }, "product_id": { "type": "string", "description": "eq: uuid" }, "product_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "status": { "type": "string", "description": "eq: one of: draft, active, archived" }, "status.in": { "type": "string", "description": "in: comma-separated enum values (max 100)" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel", "price", "currency" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listWishlistItems": { "method": "GET", "path": "/api/v1/wishlist", "permissions": [ "wishlist.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "created_at", "-created_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-created_at`" }, "customer_id": { "type": "string", "description": "eq: uuid" }, "variant_id": { "type": "string", "description": "eq: uuid" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "customerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] }, { "type": "null" } ] }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "onSale": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" } }, "required": [ "id", "customerId", "customerInfo", "variantId", "variantInfo", "onSale", "createdAt" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } } } }, "vi": { "schemaVersion": 1, "key": "wishlist.wishlist_items", "module": "wishlist", "type": "crud", "revision": "b043163b3845de8d", "title": "Danh sách yêu thích", "layout": { "ops": { "list": "listWishlistItems", "get": null, "create": null, "update": null, "delete": null }, "trash": null, "search": false, "columns": [ { "field": "customerInfo.name", "label": "Khách hàng", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "string" } }, { "field": "variantInfo.productName", "label": "Sản phẩm", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "variantInfo.optionsLabel", "label": "Biến thể", "widget": null, "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "field": "onSale", "label": "Đang giảm giá", "widget": "switch", "sort": null, "options": null, "currencyField": null, "download": null, "schema": { "type": "boolean" } }, { "field": "createdAt", "label": "Ngày thêm", "widget": "datetime", "sort": "created_at", "options": null, "currencyField": null, "download": null, "schema": { "type": "string", "format": "date-time", "pattern": "Z$" } } ], "filters": [ { "param": "customer_id", "label": "Khách hàng", "widget": "picker", "options": { "op": "listCustomers", "value": "id", "label": "name", "hint": "email", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } }, { "param": "variant_id", "label": "Biến thể sản phẩm", "widget": "picker", "options": { "op": "listProductVariantOptions", "value": "id", "label": "productName", "hint": "optionsLabel", "query": {} }, "schema": { "type": "string", "description": "eq: uuid" } } ], "form": [], "enums": {} }, "operations": { "listCustomers": { "method": "GET", "path": "/api/v1/core/customers", "permissions": [ "core.view_customers" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "50", "minimum": 1, "maximum": 200 }, "cursor": { "type": "string", "maxLength": 254 }, "email": { "type": "string", "maxLength": 254, "format": "email" }, "q": { "type": "string", "maxLength": 100 }, "store": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "emailVerifiedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "phoneVerifiedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "deletionRequestedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "purgeAfter": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "Z$" }, { "type": "null" } ] }, "stores": { "type": "array", "items": { "type": "string" } }, "erasable": { "type": "boolean" }, "editable": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" } }, "required": [ "id", "email", "name", "phone", "active", "emailVerifiedAt", "phoneVerifiedAt", "deletionRequestedAt", "purgeAfter", "stores", "erasable", "editable", "createdAt" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listProductVariantOptions": { "method": "GET", "path": "/api/v1/products/variants/options", "permissions": [ "product.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 200 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "sku", "-sku" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `sku`" }, "q": { "type": "string", "description": "Case-insensitive substring search in: product_variants.sku, product_variants.barcode, products.code, product_translations.name" }, "active": { "type": "string", "description": "eq: bool" }, "product_id": { "type": "string", "description": "eq: uuid" }, "product_id.in": { "type": "string", "description": "in: comma-separated uuid values (max 100)" }, "status": { "type": "string", "description": "eq: one of: draft, active, archived" }, "status.in": { "type": "string", "description": "in: comma-separated enum values (max 100)" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel", "price", "currency" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } }, "listWishlistItems": { "method": "GET", "path": "/api/v1/wishlist", "permissions": [ "wishlist.read" ], "conditional": false, "features": [], "idempotent": false, "status": 200, "bodyContentType": null, "rawResponse": null, "params": null, "query": { "type": "object", "properties": { "limit": { "type": "integer", "default": "20", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "description": "`meta.nextCursor` of the previous page" }, "sort": { "enum": [ "created_at", "-created_at" ], "type": "string", "description": "Sort field; prefix `-` for descending. Default `-created_at`" }, "customer_id": { "type": "string", "description": "eq: uuid" }, "variant_id": { "type": "string", "description": "eq: uuid" } }, "required": [] }, "body": null, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "customerInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] }, { "type": "null" } ] }, "variantId": { "type": "string", "format": "uuid" }, "variantInfo": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sku": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "productName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productId": { "type": "string", "format": "uuid" }, "productInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "code", "name" ] }, "optionsLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "sku", "barcode", "active", "productName", "productId", "productInfo", "optionsLabel" ] }, { "type": "null" } ] }, "onSale": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "Z$" } }, "required": [ "id", "customerId", "customerInfo", "variantId", "variantInfo", "onSale", "createdAt" ] } }, "meta": { "type": "object", "properties": { "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "nextCursor" ] } } } } } } ] }