{ "openapi": "3.0.2", "paths": { "/internal/admin/nova-merchant": { "get": { "summary": "Check if user is Nova merchant", "tags": [ "admin" ], "parameters": [], "operationId": "internal.admin.isNovaMerchant", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "novaMerchant": { "type": "boolean" } }, "required": [ "novaMerchant" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/admin/merchant-platform": { "get": { "summary": "Get merchant platform", "tags": [ "admin" ], "parameters": [], "operationId": "internal.admin.getMerchantPlatform", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "platform": { "type": "array", "items": { "type": "string", "enum": [ "nova", "legacy" ] } } }, "required": [ "platform" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/admin/validate-internal-user": { "get": { "summary": "Ensure requester is internal user", "tags": [ "admin" ], "parameters": [], "operationId": "internal.admin.validateInternalUser", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "internalUser": { "type": "boolean" } }, "required": [ "internalUser" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/admin/legacy-merchant-to-nova": { "post": { "summary": "Ensure merchant is in Postgres", "tags": [ "admin" ], "parameters": [], "operationId": "internal.admin.createNovaMerchantFromLegacy", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/": { "get": { "summary": "List articles by filters", "tags": [ "inventory", "article" ], "parameters": [ { "name": "filters", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "serviceLocationIds": { "type": "array", "items": { "type": "string" } }, "articleIds": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "anyOf": [ { "type": "array", "items": { "type": "boolean" } }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "number" } } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime" ] } }, "required": [ "id", "operator", "value" ], "additionalProperties": false } }, "name": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "code": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "skuName": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "skuCode": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "status": { "type": "string", "enum": [ "active", "inactive", "draft" ] }, "available": { "type": "boolean" }, "itemCosts": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "itemIncome": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "search": { "type": "string" } }, "additionalProperties": false } }, { "name": "pagination", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "size": { "type": "number" }, "page": { "type": "number" } }, "required": [ "size", "page" ], "additionalProperties": false } }, { "name": "orderBy", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "unavailability", "serviceLocation", "articleState", "skuName", "skuCode", "codes", "createdAt", "name", "status", "itemCosts", "itemIncome" ] }, "direction": { "type": "string", "enum": [ "asc", "desc" ] }, "attributeId": { "type": "string" } }, "required": [ "direction" ], "additionalProperties": false } }, { "name": "dateRange", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false } } ], "operationId": "internal.inventory.article.list", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "articles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codes": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "inactive", "draft" ] }, "parentId": { "nullable": true, "type": "string" }, "path": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "taxonomyCategory": { "nullable": true, "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "level": { "type": "number" }, "parentId": { "nullable": true, "type": "string" }, "isLeaf": { "type": "boolean" } }, "required": [ "id", "name", "fullName", "level", "parentId", "isLeaf" ], "additionalProperties": false }, "media": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "articleId": { "type": "string" }, "media": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" } }, "required": [ "fileId", "articleId", "orderIndex" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "articleId": { "type": "string" }, "document": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" }, "comment": { "nullable": true, "type": "string" } }, "required": [ "fileId", "articleId", "orderIndex", "comment" ], "additionalProperties": false } }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "groupId": { "nullable": true, "type": "string" }, "systemGroup": { "nullable": true, "type": "string", "enum": [ "sustainability", "system" ] }, "origin": { "type": "string", "enum": [ "article", "sku", "customer" ] } }, "required": [ "id", "name", "key", "value", "format", "groupId", "systemGroup", "origin" ], "additionalProperties": false } }, "sku": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "code": { "type": "string" } }, "required": [ "id", "name", "code" ], "additionalProperties": false }, "itemCosts": { "type": "number" }, "itemIncome": { "type": "number" }, "aggregateData": { "type": "object", "properties": { "totalCount": { "type": "number" }, "lastCreated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "lastUpdated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "totalCount", "lastCreated", "lastUpdated" ], "additionalProperties": false }, "unavailability": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "range": { "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "tenantId": { "type": "string" }, "articleId": { "nullable": true, "type": "string" }, "orderId": { "nullable": true, "type": "string" }, "blockerType": { "nullable": true, "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "range", "tenantId", "articleId", "orderId", "blockerType", "createdAt" ], "additionalProperties": false } }, "articleLocations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "articleId": { "type": "string" }, "serviceLocationId": { "nullable": true, "type": "string" }, "range": { "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "articleId", "serviceLocationId", "range", "createdAt" ], "additionalProperties": false } }, "articleState": { "type": "boolean" } }, "required": [ "id", "codes", "name", "status", "createdAt", "taxonomyCategoryId", "aggregateData", "unavailability", "articleLocations" ], "additionalProperties": false } }, "totalCount": { "type": "number" } }, "required": [ "articles", "totalCount" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "post": { "summary": "Create articles", "x-mint": { "mcp": { "enabled": true, "name": "Create new stock item", "description": "Create a new stock item in the inventory system." } }, "tags": [ "inventory", "article" ], "parameters": [], "operationId": "internal.inventory.article.create", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "article": { "type": "object", "properties": { "codes": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "inactive", "draft" ] }, "parentId": { "type": "string" }, "path": { "type": "string" }, "serviceLocationId": { "type": "string" }, "availableFrom": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "quantity": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "description": "attribute_value", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "skuId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "name", "status", "serviceLocationId", "taxonomyCategoryId" ], "additionalProperties": false }, "fileIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "article" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/available": { "get": { "summary": "List available articles for a given range and filters", "tags": [ "inventory", "article" ], "parameters": [ { "name": "filters", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "serviceLocationIds": { "type": "array", "items": { "type": "string" } }, "articleIds": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "anyOf": [ { "type": "array", "items": { "type": "boolean" } }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "number" } } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime" ] } }, "required": [ "id", "operator", "value" ], "additionalProperties": false } }, "name": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "code": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "skuName": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "skuCode": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "status": { "type": "string", "enum": [ "active", "inactive", "draft" ] }, "available": { "type": "boolean" }, "itemCosts": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "itemIncome": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "search": { "type": "string" } }, "additionalProperties": false } }, { "name": "pagination", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "size": { "type": "number" }, "page": { "type": "number" } }, "required": [ "size", "page" ], "additionalProperties": false } }, { "name": "orderBy", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "unavailability", "serviceLocation", "articleState", "skuName", "skuCode", "codes", "createdAt", "name", "status", "itemCosts", "itemIncome" ] }, "direction": { "type": "string", "enum": [ "asc", "desc" ] }, "attributeId": { "type": "string" } }, "required": [ "direction" ], "additionalProperties": false } }, { "name": "dateRange", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false } } ], "operationId": "internal.inventory.article.listAvailable", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "articles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codes": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "inactive", "draft" ] }, "parentId": { "nullable": true, "type": "string" }, "path": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "taxonomyCategory": { "nullable": true, "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "level": { "type": "number" }, "parentId": { "nullable": true, "type": "string" }, "isLeaf": { "type": "boolean" } }, "required": [ "id", "name", "fullName", "level", "parentId", "isLeaf" ], "additionalProperties": false }, "media": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "articleId": { "type": "string" }, "media": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" } }, "required": [ "fileId", "articleId", "orderIndex" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "articleId": { "type": "string" }, "document": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" }, "comment": { "nullable": true, "type": "string" } }, "required": [ "fileId", "articleId", "orderIndex", "comment" ], "additionalProperties": false } }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "groupId": { "nullable": true, "type": "string" }, "systemGroup": { "nullable": true, "type": "string", "enum": [ "sustainability", "system" ] }, "origin": { "type": "string", "enum": [ "article", "sku", "customer" ] } }, "required": [ "id", "name", "key", "value", "format", "groupId", "systemGroup", "origin" ], "additionalProperties": false } }, "sku": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "code": { "type": "string" } }, "required": [ "id", "name", "code" ], "additionalProperties": false }, "itemCosts": { "type": "number" }, "itemIncome": { "type": "number" }, "aggregateData": { "type": "object", "properties": { "totalCount": { "type": "number" }, "lastCreated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "lastUpdated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "totalCount", "lastCreated", "lastUpdated" ], "additionalProperties": false } }, "required": [ "id", "codes", "name", "status", "createdAt", "taxonomyCategoryId", "aggregateData" ], "additionalProperties": false } }, "totalCount": { "type": "number" } }, "required": [ "articles", "totalCount" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/create-many": { "post": { "summary": "Create many articles", "tags": [ "inventory", "article" ], "parameters": [], "operationId": "internal.inventory.article.createMany", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/field-values": { "get": { "summary": "Get unique values for a given field", "tags": [ "inventory", "article" ], "parameters": [ { "name": "field", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "name", "code" ] } } ], "operationId": "internal.inventory.article.getFieldValues", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/field-values-search": { "get": { "summary": "Search values for a given field", "tags": [ "inventory", "article" ], "parameters": [ { "name": "field", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "name", "code" ] } }, { "name": "search", "in": "query", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.searchFieldValues", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/unique-names": { "get": { "summary": "Get unique article names", "tags": [ "inventory", "article" ], "parameters": [], "operationId": "internal.inventory.article.getUniqueNames", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/{id}": { "get": { "summary": "Get article by ID", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.get", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "codes": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "inactive", "draft" ] }, "parentId": { "nullable": true, "type": "string" }, "path": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "taxonomyCategory": { "nullable": true, "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "level": { "type": "number" }, "parentId": { "nullable": true, "type": "string" }, "isLeaf": { "type": "boolean" } }, "required": [ "id", "name", "fullName", "level", "parentId", "isLeaf" ], "additionalProperties": false }, "media": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "articleId": { "type": "string" }, "media": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" } }, "required": [ "fileId", "articleId", "orderIndex" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "articleId": { "type": "string" }, "document": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" }, "comment": { "nullable": true, "type": "string" } }, "required": [ "fileId", "articleId", "orderIndex", "comment" ], "additionalProperties": false } }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "groupId": { "nullable": true, "type": "string" }, "systemGroup": { "nullable": true, "type": "string", "enum": [ "sustainability", "system" ] }, "origin": { "type": "string", "enum": [ "article", "sku", "customer" ] } }, "required": [ "id", "name", "key", "value", "format", "groupId", "systemGroup", "origin" ], "additionalProperties": false } }, "sku": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "code": { "type": "string" } }, "required": [ "id", "name", "code" ], "additionalProperties": false }, "itemCosts": { "type": "number" }, "itemIncome": { "type": "number" }, "aggregateData": { "type": "object", "properties": { "totalCount": { "type": "number" }, "lastCreated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "lastUpdated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "totalCount", "lastCreated", "lastUpdated" ], "additionalProperties": false }, "unavailability": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "range": { "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "tenantId": { "type": "string" }, "articleId": { "nullable": true, "type": "string" }, "orderId": { "nullable": true, "type": "string" }, "blockerType": { "nullable": true, "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "range", "tenantId", "articleId", "orderId", "blockerType", "createdAt" ], "additionalProperties": false } }, "articleLocations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "articleId": { "type": "string" }, "serviceLocationId": { "nullable": true, "type": "string" }, "range": { "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "articleId", "serviceLocationId", "range", "createdAt" ], "additionalProperties": false } }, "articleState": { "type": "boolean" } }, "required": [ "id", "codes", "name", "status", "createdAt", "taxonomyCategoryId", "aggregateData", "unavailability", "articleLocations" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "put": { "summary": "Update article", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "overwrite", "in": "query", "required": true, "schema": {} } ], "operationId": "internal.inventory.article.update", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "codes": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "inactive", "draft" ] }, "parentId": { "nullable": true, "type": "string" }, "path": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "taxonomyCategory": { "nullable": true, "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "level": { "type": "number" }, "parentId": { "nullable": true, "type": "string" }, "isLeaf": { "type": "boolean" } }, "required": [ "id", "name", "fullName", "level", "parentId", "isLeaf" ], "additionalProperties": false }, "media": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "articleId": { "type": "string" }, "media": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" } }, "required": [ "fileId", "articleId", "orderIndex" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "articleId": { "type": "string" }, "document": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" }, "comment": { "nullable": true, "type": "string" } }, "required": [ "fileId", "articleId", "orderIndex", "comment" ], "additionalProperties": false } }, "itemCosts": { "type": "number" }, "itemIncome": { "type": "number" }, "aggregateData": { "type": "object", "properties": { "totalCount": { "type": "number" }, "lastCreated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "lastUpdated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "totalCount", "lastCreated", "lastUpdated" ], "additionalProperties": false }, "availableFrom": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "serviceLocationId": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "description": "attribute_value", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "string", "nullable": true, "enum": [ null ] } ] } }, "skuId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "codes": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "inactive", "draft" ] }, "parentId": { "nullable": true, "type": "string" }, "path": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "taxonomyCategory": { "nullable": true, "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "level": { "type": "number" }, "parentId": { "nullable": true, "type": "string" }, "isLeaf": { "type": "boolean" } }, "required": [ "id", "name", "fullName", "level", "parentId", "isLeaf" ], "additionalProperties": false }, "media": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "articleId": { "type": "string" }, "media": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" } }, "required": [ "fileId", "articleId", "orderIndex" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "articleId": { "type": "string" }, "document": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" }, "comment": { "nullable": true, "type": "string" } }, "required": [ "fileId", "articleId", "orderIndex", "comment" ], "additionalProperties": false } }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "groupId": { "nullable": true, "type": "string" }, "systemGroup": { "nullable": true, "type": "string", "enum": [ "sustainability", "system" ] }, "origin": { "type": "string", "enum": [ "article", "sku", "customer" ] } }, "required": [ "id", "name", "key", "value", "format", "groupId", "systemGroup", "origin" ], "additionalProperties": false } }, "sku": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "code": { "type": "string" } }, "required": [ "id", "name", "code" ], "additionalProperties": false }, "itemCosts": { "type": "number" }, "itemIncome": { "type": "number" }, "aggregateData": { "type": "object", "properties": { "totalCount": { "type": "number" }, "lastCreated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "lastUpdated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "totalCount", "lastCreated", "lastUpdated" ], "additionalProperties": false } }, "required": [ "id", "codes", "name", "status", "createdAt", "taxonomyCategoryId", "aggregateData" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete article", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.delete", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/{id}/events": { "get": { "summary": "Get article events by article id", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.getEvents", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/{id}/ai-suggestion": { "get": { "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.getAiArticleDataSuggestion", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/{id}/custom-log-events": { "post": { "summary": "Create custom audit log event", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.createArticleLogEvent", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "comment": { "nullable": true, "type": "string" } }, "required": [ "name", "comment" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/{id}/scheduled-events": { "post": { "summary": "Create article scheduled event", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.createScheduledEvent", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "comment": { "nullable": true, "type": "string" }, "type": { "type": "string", "enum": [ "reservation", "note" ] }, "startDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "name", "comment", "type", "startDate", "endDate" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "articleId": { "type": "string" }, "startDate": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "type": { "type": "string", "enum": [ "reservation", "note" ] }, "name": { "nullable": true, "type": "string" }, "comment": { "nullable": true, "type": "string" }, "tenantId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "articleId", "startDate", "endDate", "type", "name", "comment", "tenantId", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "get": { "summary": "Get article scheduled events by article id", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.getScheduledEvents", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/{id}/scheduled-events/{eventId}": { "delete": { "summary": "Delete article scheduled event", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.deleteScheduledEvent", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "put": { "summary": "Update article scheduled event", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.updateScheduledEvent", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "comment": { "nullable": true, "type": "string" }, "type": { "type": "string", "enum": [ "reservation", "note" ] }, "startDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "name", "comment", "type", "startDate", "endDate" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "articleId": { "type": "string" }, "startDate": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "type": { "type": "string", "enum": [ "reservation", "note" ] }, "name": { "nullable": true, "type": "string" }, "comment": { "nullable": true, "type": "string" }, "tenantId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "articleId", "startDate", "endDate", "type", "name", "comment", "tenantId", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/delete-all": { "post": { "summary": "Delete all articles, optionally excluding some", "tags": [ "inventory", "article" ], "parameters": [], "operationId": "internal.inventory.article.deleteAll", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "excludedIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "excludedIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/{id}/inactivate": { "post": { "summary": "Set article as inactive", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.setAsInactive", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "success", "message" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/{id}/location": { "post": { "summary": "Update article location", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.updateArticleLocation", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "when": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "serviceLocationId": { "type": "string" } }, "required": [ "when", "serviceLocationId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "articleId": { "type": "string" }, "serviceLocationId": { "nullable": true, "type": "string" }, "range": { "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "articleId", "serviceLocationId", "range", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/{id}/transfer-location": { "post": { "summary": "Transfer article location", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.transferArticleLocation", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "serviceLocationId": { "type": "string" }, "dispatchDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "estimatedArrival": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "serviceLocationId", "dispatchDate", "estimatedArrival" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "articleId": { "type": "string" }, "serviceLocationId": { "nullable": true, "type": "string" }, "range": { "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "articleId", "serviceLocationId", "range", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/attributes/group": { "get": { "summary": "Get group by attribute key", "tags": [ "inventory", "article" ], "parameters": [ { "name": "attributeKey", "in": "query", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.getGroupByAttributeKey", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "group": { "type": "string" } }, "required": [ "group" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/grouped": { "get": { "summary": "List articles grouped by field", "tags": [ "inventory", "article" ], "parameters": [ { "name": "filters", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "serviceLocationIds": { "type": "array", "items": { "type": "string" } }, "articleIds": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "anyOf": [ { "type": "array", "items": { "type": "boolean" } }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "number" } } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime" ] } }, "required": [ "id", "operator", "value" ], "additionalProperties": false } }, "name": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "code": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "skuName": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "skuCode": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "status": { "type": "string", "enum": [ "active", "inactive", "draft" ] }, "available": { "type": "boolean" }, "itemCosts": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "itemIncome": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "search": { "type": "string" } }, "additionalProperties": false } }, { "name": "pagination", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "size": { "type": "number" }, "page": { "type": "number" } }, "required": [ "size", "page" ], "additionalProperties": false } }, { "name": "orderBy", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "unavailability", "serviceLocation", "articleState", "skuName", "skuCode", "codes", "createdAt", "name", "status", "itemCosts", "itemIncome" ] }, "direction": { "type": "string", "enum": [ "asc", "desc" ] }, "attributeId": { "type": "string" } }, "required": [ "direction" ], "additionalProperties": false } }, { "name": "dateRange", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false } }, { "name": "groupFields", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "groupKeys", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "operationId": "internal.inventory.article.listGrouped", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/validate-code": { "get": { "tags": [ "inventory", "article" ], "parameters": [ { "name": "code", "in": "query", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.validateCode", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "isUnique": { "type": "boolean" } }, "required": [ "isUnique" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/validate-codes": { "post": { "summary": "Validate codes to ensure they are unique and valid", "tags": [ "inventory", "article" ], "parameters": [], "operationId": "internal.inventory.article.validateCodes", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "codes": { "type": "array", "items": { "type": "string" } } }, "required": [ "codes" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "invalid": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "reason": { "type": "string", "enum": [ "existing" ] } }, "required": [ "code", "reason" ], "additionalProperties": false } } }, "required": [ "invalid" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/{id}/media": { "post": { "summary": "Link media to an article", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.linkMedia", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "fileIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Unlink media from an article", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fileIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "operationId": "internal.inventory.article.unlinkMedia", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/{id}/reorder-media": { "post": { "summary": "Reorder media of an article", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.reorderMedia", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "fileIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/{id}/documents": { "post": { "summary": "Link documents to an article", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.linkDocuments", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "fileIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Unlink documents from an article", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fileIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "operationId": "internal.inventory.article.unlinkDocuments", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/{id}/documents/comments": { "post": { "summary": "Add a comment to a document", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.addDocumentComment", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileId": { "type": "string" }, "comment": { "type": "string" } }, "required": [ "fileId", "comment" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/{id}/reorder-documents": { "post": { "summary": "Reorder documents of an article", "tags": [ "inventory", "article" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.article.reorderDocuments", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "fileIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/unauthenticated-link-media": { "post": { "summary": "Link media to an article without authentication", "tags": [ "inventory", "article" ], "parameters": [], "operationId": "internal.inventory.article.unauthenticatedLinkMedia", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "fileIds": { "type": "array", "items": { "type": "string" } }, "articleId": { "type": "string" } }, "required": [ "id", "fileIds", "articleId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/has-multiple-values": { "post": { "summary": "Check if multiple articles have different values for a field", "tags": [ "inventory", "article" ], "parameters": [], "operationId": "internal.inventory.article.hasMultipleValues", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "articleIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "articleIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldsWithMultipleValues": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "string", "nullable": true, "enum": [ null ] }, { "type": "array", "items": { "type": "string" } }, { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "level": { "type": "number" }, "parentId": { "nullable": true, "type": "string" }, "isLeaf": { "type": "boolean" } }, "required": [ "id", "name", "fullName", "level", "parentId", "isLeaf" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "code": { "type": "string" } }, "required": [ "id", "name", "code" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } ] }, "count": { "type": "number" }, "articleIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "value", "count", "articleIds" ], "additionalProperties": false } } }, "required": [ "fieldName", "values" ], "additionalProperties": false } }, "totalArticles": { "type": "number" } }, "required": [ "fieldsWithMultipleValues", "totalArticles" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/articles/has-multiple-attribute-values": { "post": { "summary": "Check if multiple articles have different values for an attribute", "tags": [ "inventory", "article" ], "parameters": [], "operationId": "internal.inventory.article.hasMultipleAttributeValues", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "articleIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "articleIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "attributesWithMultipleValues": { "type": "array", "items": { "type": "object", "properties": { "attributeKey": { "type": "string" }, "attributeName": { "type": "string" }, "attributeId": { "type": "string" }, "format": { "type": "string" }, "articleIds": { "type": "array", "items": { "type": "string" } }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "string", "nullable": true, "enum": [ null ] } ] }, "count": { "type": "number" }, "articleIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "value", "count", "articleIds" ], "additionalProperties": false } } }, "required": [ "attributeKey", "attributeName", "attributeId", "format", "articleIds", "values" ], "additionalProperties": false } }, "totalArticles": { "type": "number" } }, "required": [ "attributesWithMultipleValues", "totalArticles" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/unavailabilities/": { "get": { "summary": "List unavailabilities by filters", "tags": [ "inventory", "unavailability" ], "parameters": [ { "name": "pagination", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "size": { "type": "number" }, "page": { "type": "number" } }, "required": [ "size", "page" ], "additionalProperties": false } }, { "name": "orderBy", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id", "range", "tenantId", "articleId", "orderId", "blockerType", "createdAt" ] }, "direction": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field", "direction" ], "additionalProperties": false } } ], "operationId": "internal.inventory.unavailability.list", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "unavailabilities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "range": { "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "tenantId": { "type": "string" }, "articleId": { "nullable": true, "type": "string" }, "orderId": { "nullable": true, "type": "string" }, "blockerType": { "nullable": true, "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "range", "tenantId", "articleId", "orderId", "blockerType", "createdAt" ], "additionalProperties": false } }, "totalCount": { "type": "number" } }, "required": [ "unavailabilities" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "post": { "summary": "Create an unavailability range for an article", "tags": [ "inventory", "unavailability" ], "parameters": [], "operationId": "internal.inventory.unavailability.create", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "articleId": { "type": "string" }, "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "orderId": { "type": "string" }, "orderStockItemId": { "type": "string" }, "blockerType": { "type": "string" }, "scheduledEventId": { "type": "string" } }, "required": [ "articleId", "start", "end" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "range": { "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "tenantId": { "type": "string" }, "articleId": { "nullable": true, "type": "string" }, "orderId": { "nullable": true, "type": "string" }, "blockerType": { "nullable": true, "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "range", "tenantId", "articleId", "orderId", "blockerType", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/unavailabilities/{id}": { "put": { "summary": "Force assigns an article to an unavailability", "tags": [ "inventory", "unavailability" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.unavailability.update", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "articleId": { "nullable": true, "type": "string" }, "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "range": { "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "tenantId": { "type": "string" }, "articleId": { "nullable": true, "type": "string" }, "orderId": { "nullable": true, "type": "string" }, "blockerType": { "nullable": true, "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "range", "tenantId", "articleId", "orderId", "blockerType", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/article-ledger/": { "get": { "summary": "List article ledgers by filters", "tags": [ "inventory", "articleLedgers" ], "parameters": [ { "name": "filters", "in": "query", "required": true, "style": "deepObject", "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "articleId": { "type": "string" }, "group": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "value": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } ] } }, "timestamp": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "changeType": { "type": "string", "enum": [ "initial", "update", "depreciation" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "orderId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "scheduledEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "additionalProperties": false } }, { "name": "pagination", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "size": { "type": "number" }, "page": { "type": "number" } }, "required": [ "size", "page" ], "additionalProperties": false } }, { "name": "orderBy", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id", "articleId", "group", "name", "description", "value", "timestamp", "changeType", "createdAt", "orderId", "scheduledEventId" ] }, "direction": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field", "direction" ], "additionalProperties": false } } ], "operationId": "internal.inventory.articleLedgers.list", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "articleLedgers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "articleId": { "type": "string" }, "group": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "value": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } ] } }, "timestamp": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "changeType": { "type": "string", "enum": [ "initial", "update", "depreciation" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "orderId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "scheduledEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "articleId", "group", "name", "value", "timestamp", "changeType", "createdAt" ], "additionalProperties": false } }, "totalCount": { "type": "number" } }, "required": [ "articleLedgers", "totalCount" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "post": { "summary": "Create an article ledger", "tags": [ "inventory", "articleLedgers" ], "parameters": [], "operationId": "internal.inventory.articleLedgers.create", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "articleId": { "type": "string" }, "group": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "value": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } ] } }, "changeType": { "type": "string", "enum": [ "initial", "update", "depreciation" ] }, "orderId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "scheduledEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "articleId", "group", "name", "value", "changeType" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "articleId": { "type": "string" }, "group": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "value": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } ] } }, "timestamp": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "changeType": { "type": "string", "enum": [ "initial", "update", "depreciation" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "orderId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "scheduledEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "articleId", "group", "name", "value", "timestamp", "changeType", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/article-ledger/{id}": { "put": { "summary": "Update an article ledger", "tags": [ "inventory", "articleLedgers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.articleLedgers.update", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "articleId": { "type": "string" }, "group": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "value": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } ] } }, "timestamp": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "changeType": { "type": "string", "enum": [ "initial", "update", "depreciation" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "orderId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "scheduledEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "articleId": { "type": "string" }, "group": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "value": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } ] } }, "timestamp": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "changeType": { "type": "string", "enum": [ "initial", "update", "depreciation" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "orderId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "scheduledEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "articleId", "group", "name", "value", "timestamp", "changeType", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete an article ledger", "tags": [ "inventory", "articleLedgers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.articleLedgers.delete", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/article-ledger/financial-totals": { "get": { "summary": "Calculate financial totals for an article based on change type", "tags": [ "inventory", "articleLedgers" ], "parameters": [ { "name": "articleId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "group", "in": "query", "schema": { "type": "string", "enum": [ "income", "cost" ] } } ], "operationId": "internal.inventory.articleLedgers.calculateFinancialTotals", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" } }, "required": [ "total" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/reports/utilisation": { "get": { "summary": "Get inventory article utilisation by period", "tags": [ "inventory", "reports" ], "parameters": [ { "name": "period", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "months", "weeks", "days" ] } }, { "name": "year", "in": "query", "required": true, "schema": {} }, { "name": "month", "in": "query", "schema": {} }, { "name": "articleFilters", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "filters": { "type": "object", "properties": { "serviceLocationIds": { "type": "array", "items": { "type": "string" } }, "articleIds": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "anyOf": [ { "type": "array", "items": { "type": "boolean" } }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "number" } } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime" ] } }, "required": [ "id", "operator", "value" ], "additionalProperties": false } }, "name": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "code": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "skuName": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "skuCode": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "status": { "type": "string", "enum": [ "active", "inactive", "draft" ] }, "available": { "type": "boolean" }, "itemCosts": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "itemIncome": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "number" } } }, "required": [ "operator", "value" ], "additionalProperties": false } } ] }, "search": { "type": "string" } }, "additionalProperties": false }, "pagination": { "type": "object", "properties": { "size": { "type": "number" }, "page": { "type": "number" } }, "required": [ "size", "page" ], "additionalProperties": false }, "orderBy": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "unavailability", "serviceLocation", "articleState", "skuName", "skuCode", "codes", "createdAt", "name", "status", "itemCosts", "itemIncome" ] }, "direction": { "type": "string", "enum": [ "asc", "desc" ] }, "attributeId": { "type": "string" } }, "required": [ "direction" ], "additionalProperties": false }, "dateRange": { "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false } }, "additionalProperties": false } } ], "operationId": "internal.inventory.reports.utilisation", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "orders": { "type": "object", "additionalProperties": { "type": "number" } }, "quantities": { "type": "object", "additionalProperties": { "type": "number" } }, "utilisation": { "type": "object", "additionalProperties": { "type": "object", "properties": { "totalAvailable": { "type": "number" }, "totalUnavailable": { "type": "number" }, "utilisationPercentage": { "type": "number" } }, "required": [ "totalAvailable", "totalUnavailable", "utilisationPercentage" ], "additionalProperties": false } } }, "required": [ "orders", "quantities", "utilisation" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/": { "get": { "summary": "List catalog items", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "filters", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "serviceLocationIds": { "type": "array", "items": { "type": "string" } }, "ids": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "draft" ] }, "search": { "type": "string" } }, "additionalProperties": false } } ], "operationId": "internal.inventory.catalog.list", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "post": { "summary": "Create catalog item", "tags": [ "inventory", "catalog" ], "parameters": [], "operationId": "internal.inventory.catalog.create", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "status": { "type": "string", "enum": [ "active", "draft" ] }, "inventoryTrackingEnabled": { "type": "boolean" }, "documents": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "catalogItemId": { "type": "string" }, "document": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" }, "comment": { "nullable": true, "type": "string" } }, "required": [ "fileId", "catalogItemId", "orderIndex", "comment" ], "additionalProperties": false } }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "filters": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "quantity": { "type": "number" } }, "required": [ "label", "filters", "quantity" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "isVisible": { "type": "boolean" }, "variantRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variantValueId": { "type": "string" }, "baseRuleId": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "filters": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "label", "filters", "quantity", "createdAt" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "variantValueId", "baseRuleId", "conditions", "quantity", "createdAt" ], "additionalProperties": false } } }, "required": [ "label", "conditions", "quantity", "isVisible" ], "additionalProperties": false } }, "serviceLocationId": { "type": "string" } }, "required": [ "name", "description", "taxonomyCategoryId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "status": { "type": "string", "enum": [ "active", "draft" ] }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "filters": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "label", "filters", "quantity", "createdAt" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "isVisible": { "type": "boolean" }, "variantRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variantValueId": { "type": "string" }, "baseRuleId": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "filters": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "label", "filters", "quantity", "createdAt" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "variantValueId", "baseRuleId", "conditions", "quantity", "createdAt" ], "additionalProperties": false } } }, "required": [ "id", "label", "conditions", "quantity", "createdAt", "isVisible" ], "additionalProperties": false } }, "serviceLocationLinks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "serviceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "publicName": { "nullable": true, "type": "string" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" }, "description": { "nullable": true, "type": "string" }, "address": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "state": { "nullable": true, "type": "string" }, "city": { "nullable": true, "type": "string" }, "street": { "nullable": true, "type": "string" }, "zipCode": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "phone": { "nullable": true, "type": "string" }, "openingHours": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "validityDateRange": { "nullable": true, "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekday": { "nullable": true, "type": "number", "minimum": 1, "maximum": 7 }, "specificDate": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timeRanges": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } }, "isClosed": { "default": false, "type": "boolean" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "validityDateRange", "weekday", "specificDate", "timeRanges", "isClosed", "id", "serviceLocationId", "createdAt" ], "additionalProperties": false } }, "timezone": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Brazil/Acre", "Australia/ACT", "America/Adak", "Africa/Addis_Ababa", "Australia/Adelaide", "Asia/Aden", "US/Alaska", "US/Aleutian", "Africa/Algiers", "Asia/Almaty", "Asia/Amman", "Europe/Amsterdam", "Asia/Anadyr", "America/Anchorage", "Europe/Andorra", "America/Anguilla", "Indian/Antananarivo", "America/Antigua", "Pacific/Apia", "Asia/Aqtau", "Asia/Aqtobe", "America/Araguaina", "US/Arizona", "America/Aruba", "Asia/Ashgabat", "Asia/Ashkhabad", "Africa/Asmara", "Africa/Asmera", "Europe/Astrakhan", "America/Asuncion", "Europe/Athens", "America/Atikokan", "America/Atka", "Canada/Atlantic", "Asia/Atyrau", "Pacific/Auckland", "Atlantic/Azores", "Asia/Baghdad", "America/Bahia", "America/Bahia_Banderas", "Asia/Bahrain", "Mexico/BajaNorte", "Mexico/BajaSur", "Asia/Baku", "Africa/Bamako", "Asia/Bangkok", "Africa/Bangui", "Africa/Banjul", "America/Barbados", "Asia/Barnaul", "Asia/Beirut", "America/Belem", "Europe/Belfast", "Europe/Belgrade", "America/Belize", "Europe/Berlin", "Atlantic/Bermuda", "America/North_Dakota/Beulah", "Asia/Bishkek", "Africa/Bissau", "America/Blanc-Sablon", "Africa/Blantyre", "America/Boa_Vista", "America/Bogota", "America/Boise", "Pacific/Bougainville", "Europe/Bratislava", "Africa/Brazzaville", "Australia/Brisbane", "Australia/Broken_Hill", "Asia/Brunei", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "America/Buenos_Aires", "America/Argentina/Buenos_Aires", "Africa/Bujumbura", "Europe/Busingen", "Africa/Cairo", "Asia/Calcutta", "America/Cambridge_Bay", "America/Campo_Grande", "Atlantic/Canary", "Australia/Canberra", "America/Cancun", "Atlantic/Cape_Verde", "America/Caracas", "Africa/Casablanca", "Antarctica/Casey", "America/Catamarca", "America/Argentina/Catamarca", "America/Cayenne", "America/Cayman", "America/North_Dakota/Center", "US/Central", "Canada/Central", "CET", "Africa/Ceuta", "Indian/Chagos", "Pacific/Chatham", "America/Chicago", "America/Chihuahua", "Europe/Chisinau", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Indian/Christmas", "Asia/Chungking", "Pacific/Chuuk", "Indian/Cocos", "Asia/Colombo", "America/Argentina/ComodRivadavia", "Indian/Comoro", "Africa/Conakry", "Chile/Continental", "Europe/Copenhagen", "America/Coral_Harbour", "America/Cordoba", "America/Argentina/Cordoba", "America/Costa_Rica", "America/Creston", "CST6CDT", "Cuba", "America/Cuiaba", "America/Curacao", "Australia/Currie", "Asia/Dacca", "Africa/Dakar", "Asia/Damascus", "America/Danmarkshavn", "Africa/Dar_es_Salaam", "Australia/Darwin", "Antarctica/Davis", "America/Dawson", "America/Dawson_Creek", "Brazil/DeNoronha", "America/Denver", "America/Detroit", "Asia/Dhaka", "Asia/Dili", "Africa/Djibouti", "America/Dominica", "Africa/Douala", "Asia/Dubai", "Europe/Dublin", "Antarctica/DumontDUrville", "Asia/Dushanbe", "Brazil/East", "US/East-Indiana", "Pacific/Easter", "Chile/EasterIsland", "US/Eastern", "Canada/Eastern", "America/Edmonton", "EET", "Pacific/Efate", "Egypt", "Eire", "America/Eirunepe", "Africa/El_Aaiun", "America/El_Salvador", "Pacific/Enderbury", "America/Ensenada", "EST", "EST5EDT", "Australia/Eucla", "Atlantic/Faeroe", "Pacific/Fakaofo", "Asia/Famagusta", "Atlantic/Faroe", "Pacific/Fiji", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "Africa/Freetown", "Pacific/Funafuti", "Africa/Gaborone", "Pacific/Galapagos", "Pacific/Gambier", "Asia/Gaza", "GB", "GB-Eire", "Mexico/General", "Europe/Gibraltar", "America/Glace_Bay", "Etc/GMT", "GMT", "GMT-0", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT+0", "GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT0", "GMT0", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "Etc/Greenwich", "Greenwich", "America/Grenada", "Pacific/Guadalcanal", "America/Guadeloupe", "Pacific/Guam", "America/Guatemala", "America/Guayaquil", "Europe/Guernsey", "America/Guyana", "America/Halifax", "Africa/Harare", "Asia/Harbin", "America/Havana", "US/Hawaii", "Asia/Hebron", "Europe/Helsinki", "America/Hermosillo", "Asia/Ho_Chi_Minh", "Australia/Hobart", "Asia/Hong_Kong", "Hongkong", "Pacific/Honolulu", "Asia/Hovd", "HST", "Iceland", "US/Indiana-Starke", "America/Indiana/Indianapolis", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "Iran", "Asia/Irkutsk", "Europe/Isle_of_Man", "Israel", "Asia/Istanbul", "Europe/Istanbul", "Asia/Jakarta", "Jamaica", "America/Jamaica", "Atlantic/Jan_Mayen", "Japan", "Asia/Jayapura", "Europe/Jersey", "Asia/Jerusalem", "Africa/Johannesburg", "Pacific/Johnston", "Africa/Juba", "America/Jujuy", "America/Argentina/Jujuy", "America/Juneau", "Asia/Kabul", "Europe/Kaliningrad", "Asia/Kamchatka", "Africa/Kampala", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Indian/Kerguelen", "Asia/Khandyga", "Africa/Khartoum", "Europe/Kiev", "Africa/Kigali", "Africa/Kinshasa", "Pacific/Kiritimati", "Europe/Kirov", "America/Indiana/Knox", "America/Knox_IN", "Asia/Kolkata", "Pacific/Kosrae", "America/Kralendijk", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Kwajalein", "Pacific/Kwajalein", "America/La_Paz", "America/Argentina/La_Rioja", "Africa/Lagos", "Australia/LHI", "Africa/Libreville", "Libya", "America/Lima", "Australia/Lindeman", "Europe/Lisbon", "Europe/Ljubljana", "Africa/Lome", "Europe/London", "Arctic/Longyearbyen", "Australia/Lord_Howe", "America/Los_Angeles", "America/Louisville", "America/Kentucky/Louisville", "America/Lower_Princes", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Europe/Luxembourg", "Asia/Macao", "Asia/Macau", "America/Maceio", "Antarctica/Macquarie", "Atlantic/Madeira", "Europe/Madrid", "Asia/Magadan", "Indian/Mahe", "Pacific/Majuro", "Asia/Makassar", "Africa/Malabo", "Indian/Maldives", "Europe/Malta", "America/Managua", "America/Manaus", "Asia/Manila", "Africa/Maputo", "America/Indiana/Marengo", "Europe/Mariehamn", "America/Marigot", "Pacific/Marquesas", "America/Martinique", "Africa/Maseru", "America/Matamoros", "Indian/Mauritius", "Antarctica/Mawson", "Indian/Mayotte", "America/Mazatlan", "Africa/Mbabane", "Antarctica/McMurdo", "Australia/Melbourne", "America/Mendoza", "America/Argentina/Mendoza", "America/Menominee", "America/Merida", "MET", "America/Metlakatla", "America/Mexico_City", "US/Michigan", "Pacific/Midway", "Europe/Minsk", "America/Miquelon", "Africa/Mogadishu", "Europe/Monaco", "America/Moncton", "Africa/Monrovia", "America/Monterrey", "America/Montevideo", "America/Kentucky/Monticello", "America/Montreal", "America/Montserrat", "Europe/Moscow", "US/Mountain", "Canada/Mountain", "MST", "MST7MDT", "Asia/Muscat", "Africa/Nairobi", "America/Nassau", "Pacific/Nauru", "Navajo", "Africa/Ndjamena", "America/North_Dakota/New_Salem", "America/New_York", "Canada/Newfoundland", "Africa/Niamey", "Europe/Nicosia", "Asia/Nicosia", "America/Nipigon", "Pacific/Niue", "America/Nome", "Pacific/Norfolk", "America/Noronha", "Australia/North", "Africa/Nouakchott", "Pacific/Noumea", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Australia/NSW", "America/Nuuk", "NZ", "NZ-CHAT", "America/Ojinaga", "Asia/Omsk", "Asia/Oral", "Europe/Oslo", "Africa/Ouagadougou", "US/Pacific", "Canada/Pacific", "Pacific/Pago_Pago", "Pacific/Palau", "Antarctica/Palmer", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "Europe/Paris", "Australia/Perth", "America/Indiana/Petersburg", "Asia/Phnom_Penh", "America/Phoenix", "Pacific/Pitcairn", "Europe/Podgorica", "Pacific/Pohnpei", "Poland", "Pacific/Ponape", "Asia/Pontianak", "Pacific/Port_Moresby", "America/Port_of_Spain", "America/Port-au-Prince", "America/Porto_Acre", "America/Porto_Velho", "Africa/Porto-Novo", "Portugal", "Europe/Prague", "PRC", "PST8PDT", "America/Puerto_Rico", "America/Punta_Arenas", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Australia/Queensland", "Asia/Qyzylorda", "America/Rainy_River", "Asia/Rangoon", "America/Rankin_Inlet", "Pacific/Rarotonga", "America/Recife", "America/Regina", "America/Resolute", "Indian/Reunion", "Atlantic/Reykjavik", "Europe/Riga", "America/Rio_Branco", "America/Argentina/Rio_Gallegos", "Asia/Riyadh", "ROC", "ROK", "Europe/Rome", "America/Rosario", "Antarctica/Rothera", "Asia/Saigon", "Pacific/Saipan", "Asia/Sakhalin", "America/Argentina/Salta", "Europe/Samara", "Asia/Samarkand", "Pacific/Samoa", "US/Samoa", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "Europe/San_Marino", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "Africa/Sao_Tome", "Europe/Sarajevo", "Europe/Saratov", "Canada/Saskatchewan", "America/Scoresbysund", "Asia/Seoul", "Asia/Shanghai", "America/Shiprock", "Europe/Simferopol", "Asia/Singapore", "Singapore", "America/Sitka", "Europe/Skopje", "Europe/Sofia", "Australia/South", "Atlantic/South_Georgia", "Antarctica/South_Pole", "Asia/Srednekolymsk", "America/St_Barthelemy", "Atlantic/St_Helena", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "Atlantic/Stanley", "Europe/Stockholm", "America/Swift_Current", "Australia/Sydney", "Antarctica/Syowa", "Pacific/Tahiti", "Asia/Taipei", "Europe/Tallinn", "Pacific/Tarawa", "Asia/Tashkent", "Australia/Tasmania", "Asia/Tbilisi", "America/Tegucigalpa", "Asia/Tehran", "Asia/Tel_Aviv", "America/Indiana/Tell_City", "Asia/Thimbu", "Asia/Thimphu", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "Africa/Timbuktu", "Europe/Tirane", "Europe/Tiraspol", "Asia/Tokyo", "Asia/Tomsk", "Pacific/Tongatapu", "America/Toronto", "America/Tortola", "Africa/Tripoli", "Antarctica/Troll", "Pacific/Truk", "America/Argentina/Tucuman", "Africa/Tunis", "Turkey", "Etc/UCT", "UCT", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Europe/Ulyanovsk", "Etc/Universal", "Universal", "Asia/Urumqi", "America/Argentina/Ushuaia", "Asia/Ust-Nera", "UTC", "Etc/UTC", "Europe/Uzhgorod", "Europe/Vaduz", "America/Vancouver", "Europe/Vatican", "America/Indiana/Vevay", "Australia/Victoria", "Europe/Vienna", "Asia/Vientiane", "Europe/Vilnius", "America/Indiana/Vincennes", "America/Virgin", "Asia/Vladivostok", "Europe/Volgograd", "Antarctica/Vostok", "W-SU", "Pacific/Wake", "Pacific/Wallis", "Europe/Warsaw", "Brazil/West", "Australia/West", "WET", "America/Whitehorse", "America/Indiana/Winamac", "Africa/Windhoek", "America/Winnipeg", "America/Yakutat", "Asia/Yakutsk", "Australia/Yancowinna", "Asia/Yangon", "Pacific/Yap", "Asia/Yekaterinburg", "America/Yellowknife", "Asia/Yerevan", "Canada/Yukon", "Europe/Zagreb", "Europe/Zaporozhye", "Etc/Zulu", "Zulu", "Europe/Zurich" ] }, "orderFulfillmentEnabled": { "type": "boolean" }, "orderFulfillmentUseSpecificRules": { "type": "boolean" }, "orderReturnsEnabled": { "type": "boolean" }, "orderReturnsUseSpecificRules": { "type": "boolean" }, "salesChannelAdmin": { "type": "boolean" }, "salesChannelOnline": { "type": "boolean" }, "salesChannelStore": { "type": "boolean" }, "fulfillmentRules": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "ruleType": { "type": "string", "enum": [ "fulfillment", "order_return" ] }, "purchaseType": { "type": "string", "enum": [ "booking", "sales", "subscription", "buyback" ] }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inStoreEnabled": { "type": "boolean" }, "shippingEnabled": { "type": "boolean" }, "localDeliveryEnabled": { "type": "boolean" } }, "required": [ "ruleType", "purchaseType" ], "additionalProperties": false } }, "tenantId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "archivedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "name", "isDefault", "isActive", "timezone", "tenantId", "createdAt" ], "additionalProperties": false } }, "required": [ "id", "catalogItemId", "serviceLocationId", "createdAt" ], "additionalProperties": false } }, "pricingTables": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isDefault": { "type": "boolean" }, "bookingsEnabled": { "type": "boolean" }, "salesEnabled": { "type": "boolean" }, "subscriptionsEnabled": { "type": "boolean" }, "bookingPricingRows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekdays": { "nullable": true, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } }, "timeOfDayRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "timeUnitAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "timeUnitPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeCalculation": { "type": "string", "enum": [ "standard", "cap_to_closing" ] }, "counterTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitCalculationType": { "type": "string", "enum": [ "add", "multiply" ] }, "isHidden": { "type": "boolean" }, "isDynamicPricing": { "type": "boolean" }, "tax": { "type": "number", "minimum": 0 }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "label", "weekdays", "timeOfDayRange", "timeUnit", "timeUnitAmount", "timeUnitPrice", "timeCalculation", "counterTimeUnitPrice", "additionalTimeUnitPrice", "additionalTimeUnitCalculationType", "isHidden", "isDynamicPricing", "tax", "isEnabled" ], "additionalProperties": false } }, "salesPricingRows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "compareAtPrice": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tax": { "type": "number", "minimum": 0 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "price", "compareAtPrice", "tax", "isEnabled" ], "additionalProperties": false } }, "subscriptionPricingRows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "commitmentPeriodUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "commitmentPeriodAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "paymentCycleUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "paymentCycleAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "autoRenewal": { "type": "string", "enum": [ "none", "monthly" ] }, "tax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "price", "commitmentPeriodUnit", "commitmentPeriodAmount", "paymentCycleUnit", "paymentCycleAmount", "autoRenewal", "tax", "isEnabled" ], "additionalProperties": false } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantName": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "type": "string" }, "orderIndex": { "type": "number" } }, "required": [ "id", "variantId", "value", "orderIndex" ], "additionalProperties": false } }, "booking": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rateMultiplier": { "type": "number" }, "basePricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "additionalRateMultiplier": { "type": "number" } }, "required": [ "id", "rateMultiplier", "basePricingRowId" ], "additionalProperties": false } }, "sales": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rateMultiplier": { "type": "number" }, "basePricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "rateMultiplier", "basePricingRowId" ], "additionalProperties": false } }, "subscription": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rateMultiplier": { "type": "number" }, "basePricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "rateMultiplier", "basePricingRowId" ], "additionalProperties": false } }, "rateMultiplier": { "type": "number" } }, "required": [ "id", "variantName", "values", "booking", "sales", "subscription", "rateMultiplier" ], "additionalProperties": false } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "catalogItemId", "label", "availabilityRange", "isDefault", "bookingsEnabled", "salesEnabled", "subscriptionsEnabled", "bookingPricingRows", "salesPricingRows", "subscriptionPricingRows", "createdAt" ], "additionalProperties": false } }, "taxonomyCategory": { "nullable": true, "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "level": { "type": "number" }, "parentId": { "nullable": true, "type": "string" }, "isLeaf": { "type": "boolean" } }, "required": [ "id", "name", "fullName", "level", "parentId", "isLeaf" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "inventoryTrackingEnabled": { "type": "boolean" }, "media": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "catalogItemId": { "type": "string" }, "media": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" } }, "required": [ "fileId", "catalogItemId", "orderIndex" ], "additionalProperties": false } }, "documents": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "catalogItemId": { "type": "string" }, "document": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" }, "comment": { "nullable": true, "type": "string" } }, "required": [ "fileId", "catalogItemId", "orderIndex", "comment" ], "additionalProperties": false } }, "tags": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "string" }, "resource": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "value", "resource", "createdAt", "updatedAt" ], "additionalProperties": false } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "orderIndex": { "type": "number" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "type": "string" }, "orderIndex": { "type": "number" } }, "required": [ "id", "variantId", "value", "orderIndex" ], "additionalProperties": false } } }, "required": [ "id", "catalogItemId", "name", "orderIndex" ], "additionalProperties": false } }, "checkoutRequirements": { "type": "object", "properties": { "assignToCustomer": { "type": "boolean" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "attributeFormat": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } }, "required": [ "assignToCustomer", "fields" ], "additionalProperties": false } }, "required": [ "id", "name", "description", "taxonomyCategoryId", "createdAt", "inventoryTrackingEnabled" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/storefront-data": { "get": { "summary": "List catalog items with availability and pricing", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, { "name": "existingSelection", "in": "query", "schema": { "type": "array", "items": { "type": "object", "properties": { "selectionId": { "description": "Selection ID, used to identify the selection in response", "type": "string" }, "catalogItemId": { "type": "string" }, "selectedVariants": { "type": "object", "additionalProperties": { "type": "string" } }, "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pricingRowId": { "nullable": true, "type": "string" }, "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "selectionId", "catalogItemId", "quantity", "pricingRowId", "start", "end" ], "additionalProperties": false } } }, { "name": "catalogItemFilters", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "serviceLocationIds": { "type": "array", "items": { "type": "string" } }, "ids": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "draft" ] }, "search": { "type": "string" } }, "additionalProperties": false } } ], "operationId": "internal.inventory.catalog.listStorefrontData", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/storefront-data": { "get": { "summary": "Get catalog item storefront data", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, { "name": "selectedVariants", "in": "query", "schema": { "type": "object", "additionalProperties": { "description": "Variant Value ID", "type": "string" } } }, { "name": "catalogItemFilters", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "serviceLocationIds": { "type": "array", "items": { "type": "string" } }, "ids": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "draft" ] }, "search": { "type": "string" } }, "additionalProperties": false } }, { "name": "existingSelection", "in": "query", "schema": { "type": "array", "items": { "type": "object", "properties": { "selectionId": { "description": "Selection ID, used to identify the selection in response", "type": "string" }, "catalogItemId": { "type": "string" }, "selectedVariants": { "type": "object", "additionalProperties": { "type": "string" } }, "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pricingRowId": { "nullable": true, "type": "string" }, "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "selectionId", "catalogItemId", "quantity", "pricingRowId", "start", "end" ], "additionalProperties": false } } } ], "operationId": "internal.inventory.catalog.getStorefrontData", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "imageUrls": { "nullable": true, "type": "array", "items": { "type": "string" } }, "purchaseOptions": { "type": "array", "items": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] } }, "bookingPricingTypes": { "type": "array", "items": { "type": "string", "enum": [ "fixed", "dynamic" ] } }, "priceFrom": { "nullable": true, "type": "object", "properties": { "amount": { "type": "number" }, "timePeriod": { "nullable": true, "type": "object", "properties": { "unit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "value": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 } }, "required": [ "unit", "value" ], "additionalProperties": false } }, "required": [ "amount", "timePeriod" ], "additionalProperties": false }, "availability": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false }, "byVariantValue": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false } } }, "required": [ "total", "byVariantValue" ], "additionalProperties": false }, "byLocation": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false }, "byVariantValue": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false } } }, "required": [ "total", "byVariantValue" ], "additionalProperties": false } } }, "required": [ "total", "byLocation" ], "additionalProperties": false }, "variants": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "values" ], "additionalProperties": false } }, "bookingOptions": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "pricingRowId": { "type": "string" }, "label": { "nullable": true, "type": "string" }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "timeUnitAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "timeUnitPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "isDynamicPricing": { "type": "boolean" }, "variantPriceContributions": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "variantValueId": { "type": "string" }, "priceContribution": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "variantId", "variantValueId", "priceContribution" ], "additionalProperties": false } }, "availability": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false }, "byVariantValue": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false } } }, "required": [ "total", "byVariantValue" ], "additionalProperties": false }, "byLocation": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false }, "byVariantValue": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false } } }, "required": [ "total", "byVariantValue" ], "additionalProperties": false } } }, "required": [ "total", "byLocation" ], "additionalProperties": false }, "valid": { "type": "boolean" }, "invalidReason": { "type": "string" }, "calculatedPrice": { "nullable": true, "type": "number" } }, "required": [ "pricingRowId", "label", "timeUnit", "timeUnitAmount", "timeUnitPrice", "isDynamicPricing", "variantPriceContributions", "availability", "valid", "calculatedPrice" ], "additionalProperties": false } }, "salesOption": { "nullable": true, "type": "object", "properties": { "pricingRowId": { "type": "string" }, "basePrice": { "type": "number" }, "compareAtPrice": { "nullable": true, "type": "number" }, "tax": { "type": "number" }, "variantPriceContributions": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "variantValueId": { "type": "string" }, "priceContribution": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "variantId", "variantValueId", "priceContribution" ], "additionalProperties": false } }, "availability": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false }, "byVariantValue": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false } } }, "required": [ "total", "byVariantValue" ], "additionalProperties": false }, "byLocation": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false }, "byVariantValue": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false } } }, "required": [ "total", "byVariantValue" ], "additionalProperties": false } } }, "required": [ "total", "byLocation" ], "additionalProperties": false }, "calculatedPrice": { "nullable": true, "type": "number" } }, "required": [ "pricingRowId", "basePrice", "compareAtPrice", "tax", "variantPriceContributions", "availability", "calculatedPrice" ], "additionalProperties": false }, "checkoutRequirements": { "type": "object", "properties": { "assignToCustomer": { "type": "boolean" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "attributeFormat": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } }, "required": [ "assignToCustomer", "fields" ], "additionalProperties": false } }, "required": [ "id", "name", "description", "imageUrls", "purchaseOptions", "bookingPricingTypes", "priceFrom", "availability", "variants", "bookingOptions", "salesOption" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}": { "get": { "summary": "Get catalog item", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.get", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "status": { "type": "string", "enum": [ "active", "draft" ] }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "filters": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "label", "filters", "quantity", "createdAt" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "isVisible": { "type": "boolean" }, "variantRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variantValueId": { "type": "string" }, "baseRuleId": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "filters": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "label", "filters", "quantity", "createdAt" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "variantValueId", "baseRuleId", "conditions", "quantity", "createdAt" ], "additionalProperties": false } } }, "required": [ "id", "label", "conditions", "quantity", "createdAt", "isVisible" ], "additionalProperties": false } }, "serviceLocationLinks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "serviceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "publicName": { "nullable": true, "type": "string" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" }, "description": { "nullable": true, "type": "string" }, "address": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "state": { "nullable": true, "type": "string" }, "city": { "nullable": true, "type": "string" }, "street": { "nullable": true, "type": "string" }, "zipCode": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "phone": { "nullable": true, "type": "string" }, "openingHours": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "validityDateRange": { "nullable": true, "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekday": { "nullable": true, "type": "number", "minimum": 1, "maximum": 7 }, "specificDate": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timeRanges": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } }, "isClosed": { "default": false, "type": "boolean" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "validityDateRange", "weekday", "specificDate", "timeRanges", "isClosed", "id", "serviceLocationId", "createdAt" ], "additionalProperties": false } }, "timezone": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Brazil/Acre", "Australia/ACT", "America/Adak", "Africa/Addis_Ababa", "Australia/Adelaide", "Asia/Aden", "US/Alaska", "US/Aleutian", "Africa/Algiers", "Asia/Almaty", "Asia/Amman", "Europe/Amsterdam", "Asia/Anadyr", "America/Anchorage", "Europe/Andorra", "America/Anguilla", "Indian/Antananarivo", "America/Antigua", "Pacific/Apia", "Asia/Aqtau", "Asia/Aqtobe", "America/Araguaina", "US/Arizona", "America/Aruba", "Asia/Ashgabat", "Asia/Ashkhabad", "Africa/Asmara", "Africa/Asmera", "Europe/Astrakhan", "America/Asuncion", "Europe/Athens", "America/Atikokan", "America/Atka", "Canada/Atlantic", "Asia/Atyrau", "Pacific/Auckland", "Atlantic/Azores", "Asia/Baghdad", "America/Bahia", "America/Bahia_Banderas", "Asia/Bahrain", "Mexico/BajaNorte", "Mexico/BajaSur", "Asia/Baku", "Africa/Bamako", "Asia/Bangkok", "Africa/Bangui", "Africa/Banjul", "America/Barbados", "Asia/Barnaul", "Asia/Beirut", "America/Belem", "Europe/Belfast", "Europe/Belgrade", "America/Belize", "Europe/Berlin", "Atlantic/Bermuda", "America/North_Dakota/Beulah", "Asia/Bishkek", "Africa/Bissau", "America/Blanc-Sablon", "Africa/Blantyre", "America/Boa_Vista", "America/Bogota", "America/Boise", "Pacific/Bougainville", "Europe/Bratislava", "Africa/Brazzaville", "Australia/Brisbane", "Australia/Broken_Hill", "Asia/Brunei", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "America/Buenos_Aires", "America/Argentina/Buenos_Aires", "Africa/Bujumbura", "Europe/Busingen", "Africa/Cairo", "Asia/Calcutta", "America/Cambridge_Bay", "America/Campo_Grande", "Atlantic/Canary", "Australia/Canberra", "America/Cancun", "Atlantic/Cape_Verde", "America/Caracas", "Africa/Casablanca", "Antarctica/Casey", "America/Catamarca", "America/Argentina/Catamarca", "America/Cayenne", "America/Cayman", "America/North_Dakota/Center", "US/Central", "Canada/Central", "CET", "Africa/Ceuta", "Indian/Chagos", "Pacific/Chatham", "America/Chicago", "America/Chihuahua", "Europe/Chisinau", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Indian/Christmas", "Asia/Chungking", "Pacific/Chuuk", "Indian/Cocos", "Asia/Colombo", "America/Argentina/ComodRivadavia", "Indian/Comoro", "Africa/Conakry", "Chile/Continental", "Europe/Copenhagen", "America/Coral_Harbour", "America/Cordoba", "America/Argentina/Cordoba", "America/Costa_Rica", "America/Creston", "CST6CDT", "Cuba", "America/Cuiaba", "America/Curacao", "Australia/Currie", "Asia/Dacca", "Africa/Dakar", "Asia/Damascus", "America/Danmarkshavn", "Africa/Dar_es_Salaam", "Australia/Darwin", "Antarctica/Davis", "America/Dawson", "America/Dawson_Creek", "Brazil/DeNoronha", "America/Denver", "America/Detroit", "Asia/Dhaka", "Asia/Dili", "Africa/Djibouti", "America/Dominica", "Africa/Douala", "Asia/Dubai", "Europe/Dublin", "Antarctica/DumontDUrville", "Asia/Dushanbe", "Brazil/East", "US/East-Indiana", "Pacific/Easter", "Chile/EasterIsland", "US/Eastern", "Canada/Eastern", "America/Edmonton", "EET", "Pacific/Efate", "Egypt", "Eire", "America/Eirunepe", "Africa/El_Aaiun", "America/El_Salvador", "Pacific/Enderbury", "America/Ensenada", "EST", "EST5EDT", "Australia/Eucla", "Atlantic/Faeroe", "Pacific/Fakaofo", "Asia/Famagusta", "Atlantic/Faroe", "Pacific/Fiji", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "Africa/Freetown", "Pacific/Funafuti", "Africa/Gaborone", "Pacific/Galapagos", "Pacific/Gambier", "Asia/Gaza", "GB", "GB-Eire", "Mexico/General", "Europe/Gibraltar", "America/Glace_Bay", "Etc/GMT", "GMT", "GMT-0", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT+0", "GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT0", "GMT0", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "Etc/Greenwich", "Greenwich", "America/Grenada", "Pacific/Guadalcanal", "America/Guadeloupe", "Pacific/Guam", "America/Guatemala", "America/Guayaquil", "Europe/Guernsey", "America/Guyana", "America/Halifax", "Africa/Harare", "Asia/Harbin", "America/Havana", "US/Hawaii", "Asia/Hebron", "Europe/Helsinki", "America/Hermosillo", "Asia/Ho_Chi_Minh", "Australia/Hobart", "Asia/Hong_Kong", "Hongkong", "Pacific/Honolulu", "Asia/Hovd", "HST", "Iceland", "US/Indiana-Starke", "America/Indiana/Indianapolis", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "Iran", "Asia/Irkutsk", "Europe/Isle_of_Man", "Israel", "Asia/Istanbul", "Europe/Istanbul", "Asia/Jakarta", "Jamaica", "America/Jamaica", "Atlantic/Jan_Mayen", "Japan", "Asia/Jayapura", "Europe/Jersey", "Asia/Jerusalem", "Africa/Johannesburg", "Pacific/Johnston", "Africa/Juba", "America/Jujuy", "America/Argentina/Jujuy", "America/Juneau", "Asia/Kabul", "Europe/Kaliningrad", "Asia/Kamchatka", "Africa/Kampala", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Indian/Kerguelen", "Asia/Khandyga", "Africa/Khartoum", "Europe/Kiev", "Africa/Kigali", "Africa/Kinshasa", "Pacific/Kiritimati", "Europe/Kirov", "America/Indiana/Knox", "America/Knox_IN", "Asia/Kolkata", "Pacific/Kosrae", "America/Kralendijk", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Kwajalein", "Pacific/Kwajalein", "America/La_Paz", "America/Argentina/La_Rioja", "Africa/Lagos", "Australia/LHI", "Africa/Libreville", "Libya", "America/Lima", "Australia/Lindeman", "Europe/Lisbon", "Europe/Ljubljana", "Africa/Lome", "Europe/London", "Arctic/Longyearbyen", "Australia/Lord_Howe", "America/Los_Angeles", "America/Louisville", "America/Kentucky/Louisville", "America/Lower_Princes", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Europe/Luxembourg", "Asia/Macao", "Asia/Macau", "America/Maceio", "Antarctica/Macquarie", "Atlantic/Madeira", "Europe/Madrid", "Asia/Magadan", "Indian/Mahe", "Pacific/Majuro", "Asia/Makassar", "Africa/Malabo", "Indian/Maldives", "Europe/Malta", "America/Managua", "America/Manaus", "Asia/Manila", "Africa/Maputo", "America/Indiana/Marengo", "Europe/Mariehamn", "America/Marigot", "Pacific/Marquesas", "America/Martinique", "Africa/Maseru", "America/Matamoros", "Indian/Mauritius", "Antarctica/Mawson", "Indian/Mayotte", "America/Mazatlan", "Africa/Mbabane", "Antarctica/McMurdo", "Australia/Melbourne", "America/Mendoza", "America/Argentina/Mendoza", "America/Menominee", "America/Merida", "MET", "America/Metlakatla", "America/Mexico_City", "US/Michigan", "Pacific/Midway", "Europe/Minsk", "America/Miquelon", "Africa/Mogadishu", "Europe/Monaco", "America/Moncton", "Africa/Monrovia", "America/Monterrey", "America/Montevideo", "America/Kentucky/Monticello", "America/Montreal", "America/Montserrat", "Europe/Moscow", "US/Mountain", "Canada/Mountain", "MST", "MST7MDT", "Asia/Muscat", "Africa/Nairobi", "America/Nassau", "Pacific/Nauru", "Navajo", "Africa/Ndjamena", "America/North_Dakota/New_Salem", "America/New_York", "Canada/Newfoundland", "Africa/Niamey", "Europe/Nicosia", "Asia/Nicosia", "America/Nipigon", "Pacific/Niue", "America/Nome", "Pacific/Norfolk", "America/Noronha", "Australia/North", "Africa/Nouakchott", "Pacific/Noumea", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Australia/NSW", "America/Nuuk", "NZ", "NZ-CHAT", "America/Ojinaga", "Asia/Omsk", "Asia/Oral", "Europe/Oslo", "Africa/Ouagadougou", "US/Pacific", "Canada/Pacific", "Pacific/Pago_Pago", "Pacific/Palau", "Antarctica/Palmer", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "Europe/Paris", "Australia/Perth", "America/Indiana/Petersburg", "Asia/Phnom_Penh", "America/Phoenix", "Pacific/Pitcairn", "Europe/Podgorica", "Pacific/Pohnpei", "Poland", "Pacific/Ponape", "Asia/Pontianak", "Pacific/Port_Moresby", "America/Port_of_Spain", "America/Port-au-Prince", "America/Porto_Acre", "America/Porto_Velho", "Africa/Porto-Novo", "Portugal", "Europe/Prague", "PRC", "PST8PDT", "America/Puerto_Rico", "America/Punta_Arenas", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Australia/Queensland", "Asia/Qyzylorda", "America/Rainy_River", "Asia/Rangoon", "America/Rankin_Inlet", "Pacific/Rarotonga", "America/Recife", "America/Regina", "America/Resolute", "Indian/Reunion", "Atlantic/Reykjavik", "Europe/Riga", "America/Rio_Branco", "America/Argentina/Rio_Gallegos", "Asia/Riyadh", "ROC", "ROK", "Europe/Rome", "America/Rosario", "Antarctica/Rothera", "Asia/Saigon", "Pacific/Saipan", "Asia/Sakhalin", "America/Argentina/Salta", "Europe/Samara", "Asia/Samarkand", "Pacific/Samoa", "US/Samoa", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "Europe/San_Marino", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "Africa/Sao_Tome", "Europe/Sarajevo", "Europe/Saratov", "Canada/Saskatchewan", "America/Scoresbysund", "Asia/Seoul", "Asia/Shanghai", "America/Shiprock", "Europe/Simferopol", "Asia/Singapore", "Singapore", "America/Sitka", "Europe/Skopje", "Europe/Sofia", "Australia/South", "Atlantic/South_Georgia", "Antarctica/South_Pole", "Asia/Srednekolymsk", "America/St_Barthelemy", "Atlantic/St_Helena", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "Atlantic/Stanley", "Europe/Stockholm", "America/Swift_Current", "Australia/Sydney", "Antarctica/Syowa", "Pacific/Tahiti", "Asia/Taipei", "Europe/Tallinn", "Pacific/Tarawa", "Asia/Tashkent", "Australia/Tasmania", "Asia/Tbilisi", "America/Tegucigalpa", "Asia/Tehran", "Asia/Tel_Aviv", "America/Indiana/Tell_City", "Asia/Thimbu", "Asia/Thimphu", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "Africa/Timbuktu", "Europe/Tirane", "Europe/Tiraspol", "Asia/Tokyo", "Asia/Tomsk", "Pacific/Tongatapu", "America/Toronto", "America/Tortola", "Africa/Tripoli", "Antarctica/Troll", "Pacific/Truk", "America/Argentina/Tucuman", "Africa/Tunis", "Turkey", "Etc/UCT", "UCT", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Europe/Ulyanovsk", "Etc/Universal", "Universal", "Asia/Urumqi", "America/Argentina/Ushuaia", "Asia/Ust-Nera", "UTC", "Etc/UTC", "Europe/Uzhgorod", "Europe/Vaduz", "America/Vancouver", "Europe/Vatican", "America/Indiana/Vevay", "Australia/Victoria", "Europe/Vienna", "Asia/Vientiane", "Europe/Vilnius", "America/Indiana/Vincennes", "America/Virgin", "Asia/Vladivostok", "Europe/Volgograd", "Antarctica/Vostok", "W-SU", "Pacific/Wake", "Pacific/Wallis", "Europe/Warsaw", "Brazil/West", "Australia/West", "WET", "America/Whitehorse", "America/Indiana/Winamac", "Africa/Windhoek", "America/Winnipeg", "America/Yakutat", "Asia/Yakutsk", "Australia/Yancowinna", "Asia/Yangon", "Pacific/Yap", "Asia/Yekaterinburg", "America/Yellowknife", "Asia/Yerevan", "Canada/Yukon", "Europe/Zagreb", "Europe/Zaporozhye", "Etc/Zulu", "Zulu", "Europe/Zurich" ] }, "orderFulfillmentEnabled": { "type": "boolean" }, "orderFulfillmentUseSpecificRules": { "type": "boolean" }, "orderReturnsEnabled": { "type": "boolean" }, "orderReturnsUseSpecificRules": { "type": "boolean" }, "salesChannelAdmin": { "type": "boolean" }, "salesChannelOnline": { "type": "boolean" }, "salesChannelStore": { "type": "boolean" }, "fulfillmentRules": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "ruleType": { "type": "string", "enum": [ "fulfillment", "order_return" ] }, "purchaseType": { "type": "string", "enum": [ "booking", "sales", "subscription", "buyback" ] }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inStoreEnabled": { "type": "boolean" }, "shippingEnabled": { "type": "boolean" }, "localDeliveryEnabled": { "type": "boolean" } }, "required": [ "ruleType", "purchaseType" ], "additionalProperties": false } }, "tenantId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "archivedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "name", "isDefault", "isActive", "timezone", "tenantId", "createdAt" ], "additionalProperties": false } }, "required": [ "id", "catalogItemId", "serviceLocationId", "createdAt" ], "additionalProperties": false } }, "pricingTables": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isDefault": { "type": "boolean" }, "bookingsEnabled": { "type": "boolean" }, "salesEnabled": { "type": "boolean" }, "subscriptionsEnabled": { "type": "boolean" }, "bookingPricingRows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekdays": { "nullable": true, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } }, "timeOfDayRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "timeUnitAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "timeUnitPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeCalculation": { "type": "string", "enum": [ "standard", "cap_to_closing" ] }, "counterTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitCalculationType": { "type": "string", "enum": [ "add", "multiply" ] }, "isHidden": { "type": "boolean" }, "isDynamicPricing": { "type": "boolean" }, "tax": { "type": "number", "minimum": 0 }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "label", "weekdays", "timeOfDayRange", "timeUnit", "timeUnitAmount", "timeUnitPrice", "timeCalculation", "counterTimeUnitPrice", "additionalTimeUnitPrice", "additionalTimeUnitCalculationType", "isHidden", "isDynamicPricing", "tax", "isEnabled" ], "additionalProperties": false } }, "salesPricingRows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "compareAtPrice": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tax": { "type": "number", "minimum": 0 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "price", "compareAtPrice", "tax", "isEnabled" ], "additionalProperties": false } }, "subscriptionPricingRows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "commitmentPeriodUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "commitmentPeriodAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "paymentCycleUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "paymentCycleAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "autoRenewal": { "type": "string", "enum": [ "none", "monthly" ] }, "tax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "price", "commitmentPeriodUnit", "commitmentPeriodAmount", "paymentCycleUnit", "paymentCycleAmount", "autoRenewal", "tax", "isEnabled" ], "additionalProperties": false } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantName": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "type": "string" }, "orderIndex": { "type": "number" } }, "required": [ "id", "variantId", "value", "orderIndex" ], "additionalProperties": false } }, "booking": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rateMultiplier": { "type": "number" }, "basePricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "additionalRateMultiplier": { "type": "number" } }, "required": [ "id", "rateMultiplier", "basePricingRowId" ], "additionalProperties": false } }, "sales": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rateMultiplier": { "type": "number" }, "basePricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "rateMultiplier", "basePricingRowId" ], "additionalProperties": false } }, "subscription": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rateMultiplier": { "type": "number" }, "basePricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "rateMultiplier", "basePricingRowId" ], "additionalProperties": false } }, "rateMultiplier": { "type": "number" } }, "required": [ "id", "variantName", "values", "booking", "sales", "subscription", "rateMultiplier" ], "additionalProperties": false } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "catalogItemId", "label", "availabilityRange", "isDefault", "bookingsEnabled", "salesEnabled", "subscriptionsEnabled", "bookingPricingRows", "salesPricingRows", "subscriptionPricingRows", "createdAt" ], "additionalProperties": false } }, "taxonomyCategory": { "nullable": true, "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "level": { "type": "number" }, "parentId": { "nullable": true, "type": "string" }, "isLeaf": { "type": "boolean" } }, "required": [ "id", "name", "fullName", "level", "parentId", "isLeaf" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "inventoryTrackingEnabled": { "type": "boolean" }, "media": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "catalogItemId": { "type": "string" }, "media": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" } }, "required": [ "fileId", "catalogItemId", "orderIndex" ], "additionalProperties": false } }, "documents": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "catalogItemId": { "type": "string" }, "document": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" }, "comment": { "nullable": true, "type": "string" } }, "required": [ "fileId", "catalogItemId", "orderIndex", "comment" ], "additionalProperties": false } }, "tags": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "string" }, "resource": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "value", "resource", "createdAt", "updatedAt" ], "additionalProperties": false } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "orderIndex": { "type": "number" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "type": "string" }, "orderIndex": { "type": "number" } }, "required": [ "id", "variantId", "value", "orderIndex" ], "additionalProperties": false } } }, "required": [ "id", "catalogItemId", "name", "orderIndex" ], "additionalProperties": false } }, "checkoutRequirements": { "type": "object", "properties": { "assignToCustomer": { "type": "boolean" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "attributeFormat": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } }, "required": [ "assignToCustomer", "fields" ], "additionalProperties": false } }, "required": [ "id", "name", "description", "taxonomyCategoryId", "createdAt", "inventoryTrackingEnabled" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "put": { "summary": "Update catalog item", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.update", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "status": { "type": "string", "enum": [ "active", "draft" ] }, "inventoryTrackingEnabled": { "type": "boolean" }, "documents": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "catalogItemId": { "type": "string" }, "document": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" }, "comment": { "nullable": true, "type": "string" } }, "required": [ "fileId", "catalogItemId", "orderIndex", "comment" ], "additionalProperties": false } }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "filters": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "quantity": { "type": "number" } }, "required": [ "label", "filters", "quantity" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "isVisible": { "type": "boolean" }, "variantRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variantValueId": { "type": "string" }, "baseRuleId": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "filters": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "label", "filters", "quantity", "createdAt" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "variantValueId", "baseRuleId", "conditions", "quantity", "createdAt" ], "additionalProperties": false } } }, "required": [ "label", "conditions", "quantity", "isVisible" ], "additionalProperties": false } }, "serviceLocationId": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete catalog item", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.delete", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/many": { "post": { "summary": "Create catalog items", "tags": [ "inventory", "catalog" ], "parameters": [], "operationId": "internal.inventory.catalog.createMany", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/rules": { "put": { "summary": "Upsert catalog item rules", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.upsertRules", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/variant-rules": { "put": { "summary": "Upsert catalog item variant rules", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.upsertVariantRules", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/available": { "get": { "summary": "Get catalog item availablility", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dateRange", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false } }, { "name": "serviceLocationIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "selectedConditions", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "selectedAttributeOptions", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } } }, { "name": "rulesToTest", "in": "query", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "filters": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "label", "filters", "quantity", "createdAt" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "isVisible": { "type": "boolean" }, "variantRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variantValueId": { "type": "string" }, "baseRuleId": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "filters": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "label", "filters", "quantity", "createdAt" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "variantValueId", "baseRuleId", "conditions", "quantity", "createdAt" ], "additionalProperties": false } } }, "required": [ "id", "label", "conditions", "quantity", "createdAt", "isVisible" ], "additionalProperties": false } } }, { "name": "variantValueIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "available", "quantity" ] } } ], "operationId": "internal.inventory.catalog.getAvailability", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "byServiceLocation": { "nullable": true, "type": "object", "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "string", "nullable": true, "enum": [ null ] } ] } }, "total": { "anyOf": [ { "type": "number" }, { "type": "string", "nullable": true, "enum": [ null ] } ] } }, "required": [ "byServiceLocation", "total" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/available-by-variant-values": { "get": { "summary": "Get catalog item availablility by variant values", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dateRange", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false } }, { "name": "serviceLocationIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "selectedConditions", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "selectedAttributeOptions", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } } }, { "name": "rulesToTest", "in": "query", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "filters": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "label", "filters", "quantity", "createdAt" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "isVisible": { "type": "boolean" }, "variantRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variantValueId": { "type": "string" }, "baseRuleId": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "filters": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "label", "filters", "quantity", "createdAt" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "variantValueId", "baseRuleId", "conditions", "quantity", "createdAt" ], "additionalProperties": false } } }, "required": [ "id", "label", "conditions", "quantity", "createdAt", "isVisible" ], "additionalProperties": false } } }, { "name": "variantValueIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "available", "quantity" ] } } ], "operationId": "internal.inventory.catalog.getAvailabilityByVariantValues", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/available-by-variant-value-groups": { "get": { "summary": "Get catalog item availablility by variant value groups", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dateRange", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false } }, { "name": "serviceLocationIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "selectedConditions", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "selectedAttributeOptions", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } } }, { "name": "rulesToTest", "in": "query", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "filters": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "label", "filters", "quantity", "createdAt" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "isVisible": { "type": "boolean" }, "variantRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variantValueId": { "type": "string" }, "baseRuleId": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "filters": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "label", "filters", "quantity", "createdAt" ], "additionalProperties": false } }, "quantity": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "variantValueId", "baseRuleId", "conditions", "quantity", "createdAt" ], "additionalProperties": false } } }, "required": [ "id", "label", "conditions", "quantity", "createdAt", "isVisible" ], "additionalProperties": false } } }, { "name": "variantValueIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "available", "quantity" ] } }, { "name": "variantValueIdGroups", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } ], "operationId": "internal.inventory.catalog.getAvailabilityByVariantValueGroups", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/rules/{ruleId}": { "delete": { "summary": "Delete catalog item rule", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.deleteRule", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/conditions/{conditionId}": { "delete": { "summary": "Delete catalog item rule condition", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conditionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.deleteCondition", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/service-locations": { "post": { "summary": "Link catalog item to service location", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.linkServiceLocation", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "serviceLocationId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "serviceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "publicName": { "nullable": true, "type": "string" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" }, "description": { "nullable": true, "type": "string" }, "address": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "state": { "nullable": true, "type": "string" }, "city": { "nullable": true, "type": "string" }, "street": { "nullable": true, "type": "string" }, "zipCode": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "phone": { "nullable": true, "type": "string" }, "openingHours": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "validityDateRange": { "nullable": true, "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekday": { "nullable": true, "type": "number", "minimum": 1, "maximum": 7 }, "specificDate": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timeRanges": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } }, "isClosed": { "default": false, "type": "boolean" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "validityDateRange", "weekday", "specificDate", "timeRanges", "isClosed", "id", "serviceLocationId", "createdAt" ], "additionalProperties": false } }, "timezone": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Brazil/Acre", "Australia/ACT", "America/Adak", "Africa/Addis_Ababa", "Australia/Adelaide", "Asia/Aden", "US/Alaska", "US/Aleutian", "Africa/Algiers", "Asia/Almaty", "Asia/Amman", "Europe/Amsterdam", "Asia/Anadyr", "America/Anchorage", "Europe/Andorra", "America/Anguilla", "Indian/Antananarivo", "America/Antigua", "Pacific/Apia", "Asia/Aqtau", "Asia/Aqtobe", "America/Araguaina", "US/Arizona", "America/Aruba", "Asia/Ashgabat", "Asia/Ashkhabad", "Africa/Asmara", "Africa/Asmera", "Europe/Astrakhan", "America/Asuncion", "Europe/Athens", "America/Atikokan", "America/Atka", "Canada/Atlantic", "Asia/Atyrau", "Pacific/Auckland", "Atlantic/Azores", "Asia/Baghdad", "America/Bahia", "America/Bahia_Banderas", "Asia/Bahrain", "Mexico/BajaNorte", "Mexico/BajaSur", "Asia/Baku", "Africa/Bamako", "Asia/Bangkok", "Africa/Bangui", "Africa/Banjul", "America/Barbados", "Asia/Barnaul", "Asia/Beirut", "America/Belem", "Europe/Belfast", "Europe/Belgrade", "America/Belize", "Europe/Berlin", "Atlantic/Bermuda", "America/North_Dakota/Beulah", "Asia/Bishkek", "Africa/Bissau", "America/Blanc-Sablon", "Africa/Blantyre", "America/Boa_Vista", "America/Bogota", "America/Boise", "Pacific/Bougainville", "Europe/Bratislava", "Africa/Brazzaville", "Australia/Brisbane", "Australia/Broken_Hill", "Asia/Brunei", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "America/Buenos_Aires", "America/Argentina/Buenos_Aires", "Africa/Bujumbura", "Europe/Busingen", "Africa/Cairo", "Asia/Calcutta", "America/Cambridge_Bay", "America/Campo_Grande", "Atlantic/Canary", "Australia/Canberra", "America/Cancun", "Atlantic/Cape_Verde", "America/Caracas", "Africa/Casablanca", "Antarctica/Casey", "America/Catamarca", "America/Argentina/Catamarca", "America/Cayenne", "America/Cayman", "America/North_Dakota/Center", "US/Central", "Canada/Central", "CET", "Africa/Ceuta", "Indian/Chagos", "Pacific/Chatham", "America/Chicago", "America/Chihuahua", "Europe/Chisinau", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Indian/Christmas", "Asia/Chungking", "Pacific/Chuuk", "Indian/Cocos", "Asia/Colombo", "America/Argentina/ComodRivadavia", "Indian/Comoro", "Africa/Conakry", "Chile/Continental", "Europe/Copenhagen", "America/Coral_Harbour", "America/Cordoba", "America/Argentina/Cordoba", "America/Costa_Rica", "America/Creston", "CST6CDT", "Cuba", "America/Cuiaba", "America/Curacao", "Australia/Currie", "Asia/Dacca", "Africa/Dakar", "Asia/Damascus", "America/Danmarkshavn", "Africa/Dar_es_Salaam", "Australia/Darwin", "Antarctica/Davis", "America/Dawson", "America/Dawson_Creek", "Brazil/DeNoronha", "America/Denver", "America/Detroit", "Asia/Dhaka", "Asia/Dili", "Africa/Djibouti", "America/Dominica", "Africa/Douala", "Asia/Dubai", "Europe/Dublin", "Antarctica/DumontDUrville", "Asia/Dushanbe", "Brazil/East", "US/East-Indiana", "Pacific/Easter", "Chile/EasterIsland", "US/Eastern", "Canada/Eastern", "America/Edmonton", "EET", "Pacific/Efate", "Egypt", "Eire", "America/Eirunepe", "Africa/El_Aaiun", "America/El_Salvador", "Pacific/Enderbury", "America/Ensenada", "EST", "EST5EDT", "Australia/Eucla", "Atlantic/Faeroe", "Pacific/Fakaofo", "Asia/Famagusta", "Atlantic/Faroe", "Pacific/Fiji", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "Africa/Freetown", "Pacific/Funafuti", "Africa/Gaborone", "Pacific/Galapagos", "Pacific/Gambier", "Asia/Gaza", "GB", "GB-Eire", "Mexico/General", "Europe/Gibraltar", "America/Glace_Bay", "Etc/GMT", "GMT", "GMT-0", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT+0", "GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT0", "GMT0", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "Etc/Greenwich", "Greenwich", "America/Grenada", "Pacific/Guadalcanal", "America/Guadeloupe", "Pacific/Guam", "America/Guatemala", "America/Guayaquil", "Europe/Guernsey", "America/Guyana", "America/Halifax", "Africa/Harare", "Asia/Harbin", "America/Havana", "US/Hawaii", "Asia/Hebron", "Europe/Helsinki", "America/Hermosillo", "Asia/Ho_Chi_Minh", "Australia/Hobart", "Asia/Hong_Kong", "Hongkong", "Pacific/Honolulu", "Asia/Hovd", "HST", "Iceland", "US/Indiana-Starke", "America/Indiana/Indianapolis", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "Iran", "Asia/Irkutsk", "Europe/Isle_of_Man", "Israel", "Asia/Istanbul", "Europe/Istanbul", "Asia/Jakarta", "Jamaica", "America/Jamaica", "Atlantic/Jan_Mayen", "Japan", "Asia/Jayapura", "Europe/Jersey", "Asia/Jerusalem", "Africa/Johannesburg", "Pacific/Johnston", "Africa/Juba", "America/Jujuy", "America/Argentina/Jujuy", "America/Juneau", "Asia/Kabul", "Europe/Kaliningrad", "Asia/Kamchatka", "Africa/Kampala", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Indian/Kerguelen", "Asia/Khandyga", "Africa/Khartoum", "Europe/Kiev", "Africa/Kigali", "Africa/Kinshasa", "Pacific/Kiritimati", "Europe/Kirov", "America/Indiana/Knox", "America/Knox_IN", "Asia/Kolkata", "Pacific/Kosrae", "America/Kralendijk", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Kwajalein", "Pacific/Kwajalein", "America/La_Paz", "America/Argentina/La_Rioja", "Africa/Lagos", "Australia/LHI", "Africa/Libreville", "Libya", "America/Lima", "Australia/Lindeman", "Europe/Lisbon", "Europe/Ljubljana", "Africa/Lome", "Europe/London", "Arctic/Longyearbyen", "Australia/Lord_Howe", "America/Los_Angeles", "America/Louisville", "America/Kentucky/Louisville", "America/Lower_Princes", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Europe/Luxembourg", "Asia/Macao", "Asia/Macau", "America/Maceio", "Antarctica/Macquarie", "Atlantic/Madeira", "Europe/Madrid", "Asia/Magadan", "Indian/Mahe", "Pacific/Majuro", "Asia/Makassar", "Africa/Malabo", "Indian/Maldives", "Europe/Malta", "America/Managua", "America/Manaus", "Asia/Manila", "Africa/Maputo", "America/Indiana/Marengo", "Europe/Mariehamn", "America/Marigot", "Pacific/Marquesas", "America/Martinique", "Africa/Maseru", "America/Matamoros", "Indian/Mauritius", "Antarctica/Mawson", "Indian/Mayotte", "America/Mazatlan", "Africa/Mbabane", "Antarctica/McMurdo", "Australia/Melbourne", "America/Mendoza", "America/Argentina/Mendoza", "America/Menominee", "America/Merida", "MET", "America/Metlakatla", "America/Mexico_City", "US/Michigan", "Pacific/Midway", "Europe/Minsk", "America/Miquelon", "Africa/Mogadishu", "Europe/Monaco", "America/Moncton", "Africa/Monrovia", "America/Monterrey", "America/Montevideo", "America/Kentucky/Monticello", "America/Montreal", "America/Montserrat", "Europe/Moscow", "US/Mountain", "Canada/Mountain", "MST", "MST7MDT", "Asia/Muscat", "Africa/Nairobi", "America/Nassau", "Pacific/Nauru", "Navajo", "Africa/Ndjamena", "America/North_Dakota/New_Salem", "America/New_York", "Canada/Newfoundland", "Africa/Niamey", "Europe/Nicosia", "Asia/Nicosia", "America/Nipigon", "Pacific/Niue", "America/Nome", "Pacific/Norfolk", "America/Noronha", "Australia/North", "Africa/Nouakchott", "Pacific/Noumea", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Australia/NSW", "America/Nuuk", "NZ", "NZ-CHAT", "America/Ojinaga", "Asia/Omsk", "Asia/Oral", "Europe/Oslo", "Africa/Ouagadougou", "US/Pacific", "Canada/Pacific", "Pacific/Pago_Pago", "Pacific/Palau", "Antarctica/Palmer", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "Europe/Paris", "Australia/Perth", "America/Indiana/Petersburg", "Asia/Phnom_Penh", "America/Phoenix", "Pacific/Pitcairn", "Europe/Podgorica", "Pacific/Pohnpei", "Poland", "Pacific/Ponape", "Asia/Pontianak", "Pacific/Port_Moresby", "America/Port_of_Spain", "America/Port-au-Prince", "America/Porto_Acre", "America/Porto_Velho", "Africa/Porto-Novo", "Portugal", "Europe/Prague", "PRC", "PST8PDT", "America/Puerto_Rico", "America/Punta_Arenas", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Australia/Queensland", "Asia/Qyzylorda", "America/Rainy_River", "Asia/Rangoon", "America/Rankin_Inlet", "Pacific/Rarotonga", "America/Recife", "America/Regina", "America/Resolute", "Indian/Reunion", "Atlantic/Reykjavik", "Europe/Riga", "America/Rio_Branco", "America/Argentina/Rio_Gallegos", "Asia/Riyadh", "ROC", "ROK", "Europe/Rome", "America/Rosario", "Antarctica/Rothera", "Asia/Saigon", "Pacific/Saipan", "Asia/Sakhalin", "America/Argentina/Salta", "Europe/Samara", "Asia/Samarkand", "Pacific/Samoa", "US/Samoa", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "Europe/San_Marino", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "Africa/Sao_Tome", "Europe/Sarajevo", "Europe/Saratov", "Canada/Saskatchewan", "America/Scoresbysund", "Asia/Seoul", "Asia/Shanghai", "America/Shiprock", "Europe/Simferopol", "Asia/Singapore", "Singapore", "America/Sitka", "Europe/Skopje", "Europe/Sofia", "Australia/South", "Atlantic/South_Georgia", "Antarctica/South_Pole", "Asia/Srednekolymsk", "America/St_Barthelemy", "Atlantic/St_Helena", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "Atlantic/Stanley", "Europe/Stockholm", "America/Swift_Current", "Australia/Sydney", "Antarctica/Syowa", "Pacific/Tahiti", "Asia/Taipei", "Europe/Tallinn", "Pacific/Tarawa", "Asia/Tashkent", "Australia/Tasmania", "Asia/Tbilisi", "America/Tegucigalpa", "Asia/Tehran", "Asia/Tel_Aviv", "America/Indiana/Tell_City", "Asia/Thimbu", "Asia/Thimphu", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "Africa/Timbuktu", "Europe/Tirane", "Europe/Tiraspol", "Asia/Tokyo", "Asia/Tomsk", "Pacific/Tongatapu", "America/Toronto", "America/Tortola", "Africa/Tripoli", "Antarctica/Troll", "Pacific/Truk", "America/Argentina/Tucuman", "Africa/Tunis", "Turkey", "Etc/UCT", "UCT", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Europe/Ulyanovsk", "Etc/Universal", "Universal", "Asia/Urumqi", "America/Argentina/Ushuaia", "Asia/Ust-Nera", "UTC", "Etc/UTC", "Europe/Uzhgorod", "Europe/Vaduz", "America/Vancouver", "Europe/Vatican", "America/Indiana/Vevay", "Australia/Victoria", "Europe/Vienna", "Asia/Vientiane", "Europe/Vilnius", "America/Indiana/Vincennes", "America/Virgin", "Asia/Vladivostok", "Europe/Volgograd", "Antarctica/Vostok", "W-SU", "Pacific/Wake", "Pacific/Wallis", "Europe/Warsaw", "Brazil/West", "Australia/West", "WET", "America/Whitehorse", "America/Indiana/Winamac", "Africa/Windhoek", "America/Winnipeg", "America/Yakutat", "Asia/Yakutsk", "Australia/Yancowinna", "Asia/Yangon", "Pacific/Yap", "Asia/Yekaterinburg", "America/Yellowknife", "Asia/Yerevan", "Canada/Yukon", "Europe/Zagreb", "Europe/Zaporozhye", "Etc/Zulu", "Zulu", "Europe/Zurich" ] }, "orderFulfillmentEnabled": { "type": "boolean" }, "orderFulfillmentUseSpecificRules": { "type": "boolean" }, "orderReturnsEnabled": { "type": "boolean" }, "orderReturnsUseSpecificRules": { "type": "boolean" }, "salesChannelAdmin": { "type": "boolean" }, "salesChannelOnline": { "type": "boolean" }, "salesChannelStore": { "type": "boolean" }, "fulfillmentRules": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "ruleType": { "type": "string", "enum": [ "fulfillment", "order_return" ] }, "purchaseType": { "type": "string", "enum": [ "booking", "sales", "subscription", "buyback" ] }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inStoreEnabled": { "type": "boolean" }, "shippingEnabled": { "type": "boolean" }, "localDeliveryEnabled": { "type": "boolean" } }, "required": [ "ruleType", "purchaseType" ], "additionalProperties": false } }, "tenantId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "archivedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "name", "isDefault", "isActive", "timezone", "tenantId", "createdAt" ], "additionalProperties": false } }, "required": [ "id", "catalogItemId", "serviceLocationId", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/service-locations/{linkId}": { "delete": { "summary": "Unlink catalog item from service location", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "linkId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.unlinkServiceLocation", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/media": { "post": { "summary": "Link media to a catalog item", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.linkMedia", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "fileIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Unlink media from a catalog item", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fileIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "operationId": "internal.inventory.catalog.unlinkMedia", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/reorder-media": { "post": { "summary": "Reorder media of a catalog item", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.reorderMedia", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "fileIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/tags": { "post": { "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.addTags", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "tagIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tagIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "operationId": "internal.inventory.catalog.removeTags", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/pdp": { "get": { "summary": "Get PDP data for a catalog item", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "pricingRowId", "in": "query", "schema": { "type": "string" } }, { "name": "variantValueIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "operationId": "internal.inventory.catalog.getPDPData", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/catalog-items/{catalogItemId}/documents": { "post": { "summary": "Link documents to a catalog item", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalog.linkDocuments", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "fileIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Unlink documents from a catalog item", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "fileIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } ], "operationId": "internal.inventory.catalog.unlinkDocuments", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/catalog-items/{catalogItemId}/documents/reorder": { "put": { "summary": "Reorder catalog item documents", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalog.reorderDocuments", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "fileIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/catalog-items/{catalogItemId}/documents/comment": { "post": { "summary": "Add a comment to a catalog item document", "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalog.addDocumentComment", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "comment": { "type": "string" } }, "required": [ "fileId", "comment" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/checkout-requirements": { "get": { "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.getCheckoutRequirements", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "assignToCustomer": { "type": "boolean" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "attributeFormat": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } }, "required": [ "assignToCustomer", "fields" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "put": { "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.updateCheckoutRequirements", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "assignToCustomer": { "type": "boolean" } }, "required": [ "assignToCustomer" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "assignToCustomer": { "type": "boolean" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "attributeFormat": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } }, "required": [ "assignToCustomer", "fields" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/checkout-requirements/fields": { "post": { "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.addCheckoutRequirementField", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "attributeFormat": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } }, "required": [ "type" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "attributeFormat": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog/{id}/checkout-requirements/fields/{fieldId}": { "put": { "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.updateCheckoutRequirementField", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "attributeFormat": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } }, "required": [ "type" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "attributeFormat": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "tags": [ "inventory", "catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.catalog.deleteCheckoutRequirementField", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/taxonomy/categories": { "get": { "summary": "Get taxonomy categories by parent ID(s) or level", "tags": [ "inventory", "taxonomy" ], "parameters": [ { "name": "ids", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "parentId", "in": "query", "schema": { "nullable": true, "type": "string" } }, { "name": "parentIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "level", "in": "query", "schema": { "type": "number" } }, { "name": "isLeaf", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "internal.inventory.taxonomy.getCategories", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/taxonomy/categories/search": { "get": { "summary": "Search taxonomy categories by full name", "tags": [ "inventory", "taxonomy" ], "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "operationId": "internal.inventory.taxonomy.searchCategories", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/taxonomy/categories/find/{input}": { "get": { "summary": "Find similar categories using embeddings", "tags": [ "inventory", "taxonomy" ], "parameters": [ { "name": "input", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.taxonomy.semanticSearchCategories", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/taxonomy/categories/{categoryId}/attributes/evaluate": { "get": { "summary": "Evaluate best attribute matches for a category", "tags": [ "inventory", "taxonomy" ], "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "input", "in": "query", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.taxonomy.findMatchingAttributes", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "allAttributes": { "type": "array", "items": { "type": "object", "properties": { "categoryId": { "type": "string" }, "attributeId": { "type": "string" }, "handle": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "overrideName": { "nullable": true, "type": "string" }, "overrideDescription": { "nullable": true, "type": "string" }, "extended": { "type": "boolean" }, "extendedAttributes": { "nullable": true, "type": "array", "items": { "type": "string" } }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "attributeId": { "type": "string" }, "value": { "type": "string" }, "handle": { "type": "string" } }, "required": [ "id", "attributeId", "value", "handle" ], "additionalProperties": false } } }, "required": [ "categoryId", "attributeId", "handle", "name", "description", "overrideName", "overrideDescription", "extended", "extendedAttributes", "attributes" ], "additionalProperties": false } }, "matchingAttributes": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "allAttributes", "matchingAttributes" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/taxonomy/categories/{categoryId}/attributes": { "get": { "summary": "Get attributes for a specific category", "tags": [ "inventory", "taxonomy" ], "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.taxonomy.getCategoryAttributes", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/taxonomy/attributes/{attributeId}/values": { "get": { "summary": "Get values for a specific attribute", "tags": [ "inventory", "taxonomy" ], "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.taxonomy.getAttributeValues", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}": { "get": { "summary": "List catalog pricing configurations", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "availabilityRange", "in": "query", "style": "deepObject", "schema": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false } } ], "operationId": "internal.inventory.catalogPricing.listTables", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "post": { "summary": "Create a new catalog pricing configuration", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.createTable", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isDefault": { "type": "boolean" }, "bookingsEnabled": { "type": "boolean" }, "salesEnabled": { "type": "boolean" }, "subscriptionsEnabled": { "type": "boolean" } }, "required": [ "label", "availabilityRange", "isDefault" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isDefault": { "type": "boolean" }, "bookingsEnabled": { "type": "boolean" }, "salesEnabled": { "type": "boolean" }, "subscriptionsEnabled": { "type": "boolean" }, "bookingPricingRows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekdays": { "nullable": true, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } }, "timeOfDayRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "timeUnitAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "timeUnitPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeCalculation": { "type": "string", "enum": [ "standard", "cap_to_closing" ] }, "counterTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitCalculationType": { "type": "string", "enum": [ "add", "multiply" ] }, "isHidden": { "type": "boolean" }, "isDynamicPricing": { "type": "boolean" }, "tax": { "type": "number", "minimum": 0 }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "label", "weekdays", "timeOfDayRange", "timeUnit", "timeUnitAmount", "timeUnitPrice", "timeCalculation", "counterTimeUnitPrice", "additionalTimeUnitPrice", "additionalTimeUnitCalculationType", "isHidden", "isDynamicPricing", "tax", "isEnabled" ], "additionalProperties": false } }, "salesPricingRows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "compareAtPrice": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tax": { "type": "number", "minimum": 0 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "price", "compareAtPrice", "tax", "isEnabled" ], "additionalProperties": false } }, "subscriptionPricingRows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "commitmentPeriodUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "commitmentPeriodAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "paymentCycleUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "paymentCycleAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "autoRenewal": { "type": "string", "enum": [ "none", "monthly" ] }, "tax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "price", "commitmentPeriodUnit", "commitmentPeriodAmount", "paymentCycleUnit", "paymentCycleAmount", "autoRenewal", "tax", "isEnabled" ], "additionalProperties": false } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantName": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "type": "string" }, "orderIndex": { "type": "number" } }, "required": [ "id", "variantId", "value", "orderIndex" ], "additionalProperties": false } }, "booking": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rateMultiplier": { "type": "number" }, "basePricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "additionalRateMultiplier": { "type": "number" } }, "required": [ "id", "rateMultiplier", "basePricingRowId" ], "additionalProperties": false } }, "sales": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rateMultiplier": { "type": "number" }, "basePricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "rateMultiplier", "basePricingRowId" ], "additionalProperties": false } }, "subscription": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rateMultiplier": { "type": "number" }, "basePricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "rateMultiplier", "basePricingRowId" ], "additionalProperties": false } }, "rateMultiplier": { "type": "number" } }, "required": [ "id", "variantName", "values", "booking", "sales", "subscription", "rateMultiplier" ], "additionalProperties": false } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "catalogItemId", "label", "availabilityRange", "isDefault", "bookingsEnabled", "salesEnabled", "subscriptionsEnabled", "bookingPricingRows", "salesPricingRows", "subscriptionPricingRows", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/pricing-table/{pricingTableId}": { "get": { "summary": "Get a catalog pricing configuration", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.getTable", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isDefault": { "type": "boolean" }, "bookingsEnabled": { "type": "boolean" }, "salesEnabled": { "type": "boolean" }, "subscriptionsEnabled": { "type": "boolean" }, "bookingPricingRows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekdays": { "nullable": true, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } }, "timeOfDayRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "timeUnitAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "timeUnitPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeCalculation": { "type": "string", "enum": [ "standard", "cap_to_closing" ] }, "counterTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitCalculationType": { "type": "string", "enum": [ "add", "multiply" ] }, "isHidden": { "type": "boolean" }, "isDynamicPricing": { "type": "boolean" }, "tax": { "type": "number", "minimum": 0 }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "label", "weekdays", "timeOfDayRange", "timeUnit", "timeUnitAmount", "timeUnitPrice", "timeCalculation", "counterTimeUnitPrice", "additionalTimeUnitPrice", "additionalTimeUnitCalculationType", "isHidden", "isDynamicPricing", "tax", "isEnabled" ], "additionalProperties": false } }, "salesPricingRows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "compareAtPrice": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tax": { "type": "number", "minimum": 0 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "price", "compareAtPrice", "tax", "isEnabled" ], "additionalProperties": false } }, "subscriptionPricingRows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "commitmentPeriodUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "commitmentPeriodAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "paymentCycleUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "paymentCycleAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "autoRenewal": { "type": "string", "enum": [ "none", "monthly" ] }, "tax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "price", "commitmentPeriodUnit", "commitmentPeriodAmount", "paymentCycleUnit", "paymentCycleAmount", "autoRenewal", "tax", "isEnabled" ], "additionalProperties": false } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantName": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "type": "string" }, "orderIndex": { "type": "number" } }, "required": [ "id", "variantId", "value", "orderIndex" ], "additionalProperties": false } }, "booking": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rateMultiplier": { "type": "number" }, "basePricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "additionalRateMultiplier": { "type": "number" } }, "required": [ "id", "rateMultiplier", "basePricingRowId" ], "additionalProperties": false } }, "sales": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rateMultiplier": { "type": "number" }, "basePricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "rateMultiplier", "basePricingRowId" ], "additionalProperties": false } }, "subscription": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rateMultiplier": { "type": "number" }, "basePricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "rateMultiplier", "basePricingRowId" ], "additionalProperties": false } }, "rateMultiplier": { "type": "number" } }, "required": [ "id", "variantName", "values", "booking", "sales", "subscription", "rateMultiplier" ], "additionalProperties": false } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "catalogItemId", "label", "availabilityRange", "isDefault", "bookingsEnabled", "salesEnabled", "subscriptionsEnabled", "bookingPricingRows", "salesPricingRows", "subscriptionPricingRows", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/update-table/{pricingTableId}": { "put": { "summary": "Update a catalog pricing table", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.updateTable", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "bookingsEnabled": { "type": "boolean" }, "salesEnabled": { "type": "boolean" }, "subscriptionsEnabled": { "type": "boolean" }, "bookingPricingRows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekdays": { "nullable": true, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } }, "timeOfDayRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "timeUnitAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "timeUnitPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeCalculation": { "type": "string", "enum": [ "standard", "cap_to_closing" ] }, "counterTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitCalculationType": { "type": "string", "enum": [ "add", "multiply" ] }, "isHidden": { "type": "boolean" }, "isDynamicPricing": { "type": "boolean" }, "tax": { "type": "number", "minimum": 0 }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "label", "weekdays", "timeOfDayRange", "timeUnit", "timeUnitAmount", "timeUnitPrice", "timeCalculation", "counterTimeUnitPrice", "additionalTimeUnitPrice", "additionalTimeUnitCalculationType", "isHidden", "isDynamicPricing", "tax", "isEnabled" ], "additionalProperties": false } }, "salesPricingRows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "compareAtPrice": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tax": { "type": "number", "minimum": 0 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "price", "compareAtPrice", "tax", "isEnabled" ], "additionalProperties": false } }, "subscriptionPricingRows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "commitmentPeriodUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "commitmentPeriodAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "paymentCycleUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "paymentCycleAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "autoRenewal": { "type": "string", "enum": [ "none", "monthly" ] }, "tax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "price", "commitmentPeriodUnit", "commitmentPeriodAmount", "paymentCycleUnit", "paymentCycleAmount", "autoRenewal", "tax", "isEnabled" ], "additionalProperties": false } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantName": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "type": "string" }, "orderIndex": { "type": "number" } }, "required": [ "id", "variantId", "value", "orderIndex" ], "additionalProperties": false } }, "booking": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rateMultiplier": { "type": "number" }, "basePricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "additionalRateMultiplier": { "type": "number" } }, "required": [ "id", "rateMultiplier", "basePricingRowId" ], "additionalProperties": false } }, "sales": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rateMultiplier": { "type": "number" }, "basePricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "rateMultiplier", "basePricingRowId" ], "additionalProperties": false } }, "subscription": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rateMultiplier": { "type": "number" }, "basePricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "rateMultiplier", "basePricingRowId" ], "additionalProperties": false } }, "rateMultiplier": { "type": "number" } }, "required": [ "id", "variantName", "values", "booking", "sales", "subscription", "rateMultiplier" ], "additionalProperties": false } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/delete-table/{pricingTableId}": { "delete": { "summary": "Delete catalog pricing table", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.deleteTable", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/pricing-table-rows/{pricingTableId}": { "get": { "summary": "List catalog pricing configurations", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.listRows", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/pricing-table/{pricingTableId}/row": { "post": { "summary": "Create a new catalog pricing configuration", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.createRow", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekdays": { "nullable": true, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } }, "timeOfDayRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "timeUnitAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "timeUnitPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeCalculation": { "type": "string", "enum": [ "standard", "cap_to_closing" ] }, "counterTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitCalculationType": { "type": "string", "enum": [ "add", "multiply" ] }, "isHidden": { "type": "boolean" }, "isDynamicPricing": { "type": "boolean" }, "tax": { "type": "number", "minimum": 0 }, "isEnabled": { "type": "boolean" } }, "required": [ "label", "weekdays", "timeOfDayRange", "timeUnit", "timeUnitAmount", "timeUnitPrice", "timeCalculation", "counterTimeUnitPrice", "additionalTimeUnitPrice", "additionalTimeUnitCalculationType", "isHidden", "isDynamicPricing", "tax", "isEnabled" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekdays": { "nullable": true, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } }, "timeOfDayRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "timeUnitAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "timeUnitPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeCalculation": { "type": "string", "enum": [ "standard", "cap_to_closing" ] }, "counterTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitCalculationType": { "type": "string", "enum": [ "add", "multiply" ] }, "isHidden": { "type": "boolean" }, "isDynamicPricing": { "type": "boolean" }, "tax": { "type": "number", "minimum": 0 }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "label", "weekdays", "timeOfDayRange", "timeUnit", "timeUnitAmount", "timeUnitPrice", "timeCalculation", "counterTimeUnitPrice", "additionalTimeUnitPrice", "additionalTimeUnitCalculationType", "isHidden", "isDynamicPricing", "tax", "isEnabled" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/pricing-table/{pricingTableId}/row/{pricingRowId}": { "put": { "summary": "Update a catalog pricing row", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingRowId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.updateRow", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekdays": { "nullable": true, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } }, "timeOfDayRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "timeUnitAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "timeUnitPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeCalculation": { "type": "string", "enum": [ "standard", "cap_to_closing" ] }, "counterTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitCalculationType": { "type": "string", "enum": [ "add", "multiply" ] }, "isHidden": { "type": "boolean" }, "isDynamicPricing": { "type": "boolean" }, "tax": { "type": "number", "minimum": 0 }, "isEnabled": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekdays": { "nullable": true, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } }, "timeOfDayRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "timeUnitAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "timeUnitPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeCalculation": { "type": "string", "enum": [ "standard", "cap_to_closing" ] }, "counterTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitCalculationType": { "type": "string", "enum": [ "add", "multiply" ] }, "isHidden": { "type": "boolean" }, "isDynamicPricing": { "type": "boolean" }, "tax": { "type": "number", "minimum": 0 }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "label", "weekdays", "timeOfDayRange", "timeUnit", "timeUnitAmount", "timeUnitPrice", "timeCalculation", "counterTimeUnitPrice", "additionalTimeUnitPrice", "additionalTimeUnitCalculationType", "isHidden", "isDynamicPricing", "tax", "isEnabled" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete catalog pricing table row", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingRowId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.deleteRow", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/sales-table/{pricingTableId}": { "post": { "summary": "Create a new catalog sales pricing row", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.createSalesRow", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "price": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "compareAtPrice": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tax": { "type": "number", "minimum": 0 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "price", "compareAtPrice", "tax", "isEnabled" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "compareAtPrice": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tax": { "type": "number", "minimum": 0 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "price", "compareAtPrice", "tax", "isEnabled" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/sales-table/{pricingTableId}/row/{salesRowId}": { "put": { "summary": "Update a catalog sales pricing row", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "salesRowId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.updateSalesRow", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "compareAtPrice": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tax": { "type": "number", "minimum": 0 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "compareAtPrice": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tax": { "type": "number", "minimum": 0 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "price", "compareAtPrice", "tax", "isEnabled" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete a catalog sales pricing row", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "salesRowId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.deleteSalesRow", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/subscription-table/{pricingTableId}": { "post": { "summary": "Create a new catalog subscription pricing row", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.createSubscriptionRow", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "price": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "commitmentPeriodUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "commitmentPeriodAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "paymentCycleUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "paymentCycleAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "autoRenewal": { "type": "string", "enum": [ "none", "monthly" ] }, "tax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "price", "commitmentPeriodUnit", "commitmentPeriodAmount", "paymentCycleUnit", "paymentCycleAmount", "autoRenewal", "tax", "isEnabled" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "commitmentPeriodUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "commitmentPeriodAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "paymentCycleUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "paymentCycleAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "autoRenewal": { "type": "string", "enum": [ "none", "monthly" ] }, "tax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "price", "commitmentPeriodUnit", "commitmentPeriodAmount", "paymentCycleUnit", "paymentCycleAmount", "autoRenewal", "tax", "isEnabled" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/subscription-table/{pricingTableId}/row/{subscriptionRowId}": { "put": { "summary": "Update a catalog subscription pricing row", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "subscriptionRowId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.updateSubscriptionRow", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "commitmentPeriodUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "commitmentPeriodAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "paymentCycleUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "paymentCycleAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "autoRenewal": { "type": "string", "enum": [ "none", "monthly" ] }, "tax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "commitmentPeriodUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "commitmentPeriodAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "paymentCycleUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "paymentCycleAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "autoRenewal": { "type": "string", "enum": [ "none", "monthly" ] }, "tax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "price", "commitmentPeriodUnit", "commitmentPeriodAmount", "paymentCycleUnit", "paymentCycleAmount", "autoRenewal", "tax", "isEnabled" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete a catalog subscription pricing row", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "subscriptionRowId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.deleteSubscriptionRow", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/fixed-price": { "get": { "summary": "Calculate catalog item price for selected pricing row", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "selectedPricingRowId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "variantValueIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } ], "operationId": "internal.inventory.catalogPricing.calculateFixedPrice", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "pricingRow": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekdays": { "nullable": true, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } }, "timeOfDayRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "timeUnitAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "timeUnitPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeCalculation": { "type": "string", "enum": [ "standard", "cap_to_closing" ] }, "counterTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitCalculationType": { "type": "string", "enum": [ "add", "multiply" ] }, "isHidden": { "type": "boolean" }, "isDynamicPricing": { "type": "boolean" }, "tax": { "type": "number", "minimum": 0 }, "isEnabled": { "type": "boolean" }, "priceContribution": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "catalogItemId", "pricingTableId", "label", "weekdays", "timeOfDayRange", "timeUnit", "timeUnitAmount", "timeUnitPrice", "timeCalculation", "counterTimeUnitPrice", "additionalTimeUnitPrice", "additionalTimeUnitCalculationType", "isHidden", "isDynamicPricing", "tax", "isEnabled", "priceContribution" ], "additionalProperties": false }, "variantPricingRows": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantName": { "type": "string" }, "variantValue": { "type": "string" }, "variantValueId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priceContribution": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "variantId", "variantName", "variantValue", "variantValueId", "priceContribution" ], "additionalProperties": false } }, "totalPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "pricingRow", "variantPricingRows", "totalPrice" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/rate-based-price": { "get": { "summary": "Calculate catalog item price for selected date range", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } } ], "operationId": "internal.inventory.catalogPricing.calculateRateBasedPrice", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "priceBreakdown": { "type": "array", "items": { "type": "object", "properties": { "bookingPricingRow": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricingTableId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" }, "availabilityRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekdays": { "nullable": true, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } }, "timeOfDayRange": { "nullable": true, "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "timeUnitAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "timeUnitPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeCalculation": { "type": "string", "enum": [ "standard", "cap_to_closing" ] }, "counterTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitPrice": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalTimeUnitCalculationType": { "type": "string", "enum": [ "add", "multiply" ] }, "isHidden": { "type": "boolean" }, "isDynamicPricing": { "type": "boolean" }, "tax": { "type": "number", "minimum": 0 }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "catalogItemId", "pricingTableId", "label", "weekdays", "timeOfDayRange", "timeUnit", "timeUnitAmount", "timeUnitPrice", "timeCalculation", "counterTimeUnitPrice", "additionalTimeUnitPrice", "additionalTimeUnitCalculationType", "isHidden", "isDynamicPricing", "tax", "isEnabled" ], "additionalProperties": false }, "timeRange": { "type": "object", "properties": { "start": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "units": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "unitPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "priceContribution": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "isBasePrice": { "type": "boolean" }, "isCounterPrice": { "type": "boolean" }, "isAdditionalPrice": { "type": "boolean" }, "variantContributions": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantName": { "type": "string" }, "variantValue": { "type": "string" }, "variantValueId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priceContribution": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "variantId", "variantName", "variantValue", "variantValueId", "priceContribution" ], "additionalProperties": false } }, "totalPriceContribution": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "bookingPricingRow", "timeRange", "units", "unitPrice", "priceContribution", "isBasePrice", "isCounterPrice", "isAdditionalPrice" ], "additionalProperties": false } }, "totalPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "priceBreakdown", "totalPrice" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/pricing-table/{pricingTableId}/variant-pricing-table": { "post": { "summary": "Create a new variant pricing table", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.createVariantPricingTable", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantValueIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "rateMultiplier": { "type": "number" } }, "required": [ "variantId", "variantValueIds", "rateMultiplier" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/pricing-table/{pricingTableId}/variant-pricing-table/{variantPricingTableId}": { "put": { "summary": "Update a variant pricing table", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "variantPricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.updateVariantPricingTable", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "variantValueIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "rateMultiplier": { "type": "number" } }, "required": [ "variantValueIds", "rateMultiplier" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/pricing-table/{pricingTableId}/variant-pricing-table/{variantPricingTableId}/delete": { "delete": { "summary": "Delete a variant pricing table", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "variantPricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.deleteVariantPricingTable", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/catalog-pricing/{catalogItemId}/pricing-table/{pricingTableId}/row/{pricingRowId}/variant-pricing-table/{variantPricingTableId}/row": { "put": { "summary": "Update a variant pricing table row", "tags": [ "inventory", "catalogPricing" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "pricingRowId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "variantPricingTableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.catalogPricing.updateVariantPricingTableRow", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "booking", "sales", "subscription" ] }, "rateMultiplier": { "type": "number" }, "additionalRateMultiplier": { "type": "number" }, "variantPricingRowId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "rateMultiplier" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/service-locations/": { "get": { "summary": "List service locations", "tags": [ "inventory", "serviceLocations" ], "parameters": [], "operationId": "internal.inventory.serviceLocations.list", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "post": { "summary": "Create a pickup location", "tags": [ "inventory", "serviceLocations" ], "parameters": [], "operationId": "internal.inventory.serviceLocations.create", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "publicName": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "address": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "state": { "nullable": true, "type": "string" }, "city": { "nullable": true, "type": "string" }, "street": { "nullable": true, "type": "string" }, "zipCode": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "phone": { "nullable": true, "type": "string" }, "timezone": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Brazil/Acre", "Australia/ACT", "America/Adak", "Africa/Addis_Ababa", "Australia/Adelaide", "Asia/Aden", "US/Alaska", "US/Aleutian", "Africa/Algiers", "Asia/Almaty", "Asia/Amman", "Europe/Amsterdam", "Asia/Anadyr", "America/Anchorage", "Europe/Andorra", "America/Anguilla", "Indian/Antananarivo", "America/Antigua", "Pacific/Apia", "Asia/Aqtau", "Asia/Aqtobe", "America/Araguaina", "US/Arizona", "America/Aruba", "Asia/Ashgabat", "Asia/Ashkhabad", "Africa/Asmara", "Africa/Asmera", "Europe/Astrakhan", "America/Asuncion", "Europe/Athens", "America/Atikokan", "America/Atka", "Canada/Atlantic", "Asia/Atyrau", "Pacific/Auckland", "Atlantic/Azores", "Asia/Baghdad", "America/Bahia", "America/Bahia_Banderas", "Asia/Bahrain", "Mexico/BajaNorte", "Mexico/BajaSur", "Asia/Baku", "Africa/Bamako", "Asia/Bangkok", "Africa/Bangui", "Africa/Banjul", "America/Barbados", "Asia/Barnaul", "Asia/Beirut", "America/Belem", "Europe/Belfast", "Europe/Belgrade", "America/Belize", "Europe/Berlin", "Atlantic/Bermuda", "America/North_Dakota/Beulah", "Asia/Bishkek", "Africa/Bissau", "America/Blanc-Sablon", "Africa/Blantyre", "America/Boa_Vista", "America/Bogota", "America/Boise", "Pacific/Bougainville", "Europe/Bratislava", "Africa/Brazzaville", "Australia/Brisbane", "Australia/Broken_Hill", "Asia/Brunei", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "America/Buenos_Aires", "America/Argentina/Buenos_Aires", "Africa/Bujumbura", "Europe/Busingen", "Africa/Cairo", "Asia/Calcutta", "America/Cambridge_Bay", "America/Campo_Grande", "Atlantic/Canary", "Australia/Canberra", "America/Cancun", "Atlantic/Cape_Verde", "America/Caracas", "Africa/Casablanca", "Antarctica/Casey", "America/Catamarca", "America/Argentina/Catamarca", "America/Cayenne", "America/Cayman", "America/North_Dakota/Center", "US/Central", "Canada/Central", "CET", "Africa/Ceuta", "Indian/Chagos", "Pacific/Chatham", "America/Chicago", "America/Chihuahua", "Europe/Chisinau", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Indian/Christmas", "Asia/Chungking", "Pacific/Chuuk", "Indian/Cocos", "Asia/Colombo", "America/Argentina/ComodRivadavia", "Indian/Comoro", "Africa/Conakry", "Chile/Continental", "Europe/Copenhagen", "America/Coral_Harbour", "America/Cordoba", "America/Argentina/Cordoba", "America/Costa_Rica", "America/Creston", "CST6CDT", "Cuba", "America/Cuiaba", "America/Curacao", "Australia/Currie", "Asia/Dacca", "Africa/Dakar", "Asia/Damascus", "America/Danmarkshavn", "Africa/Dar_es_Salaam", "Australia/Darwin", "Antarctica/Davis", "America/Dawson", "America/Dawson_Creek", "Brazil/DeNoronha", "America/Denver", "America/Detroit", "Asia/Dhaka", "Asia/Dili", "Africa/Djibouti", "America/Dominica", "Africa/Douala", "Asia/Dubai", "Europe/Dublin", "Antarctica/DumontDUrville", "Asia/Dushanbe", "Brazil/East", "US/East-Indiana", "Pacific/Easter", "Chile/EasterIsland", "US/Eastern", "Canada/Eastern", "America/Edmonton", "EET", "Pacific/Efate", "Egypt", "Eire", "America/Eirunepe", "Africa/El_Aaiun", "America/El_Salvador", "Pacific/Enderbury", "America/Ensenada", "EST", "EST5EDT", "Australia/Eucla", "Atlantic/Faeroe", "Pacific/Fakaofo", "Asia/Famagusta", "Atlantic/Faroe", "Pacific/Fiji", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "Africa/Freetown", "Pacific/Funafuti", "Africa/Gaborone", "Pacific/Galapagos", "Pacific/Gambier", "Asia/Gaza", "GB", "GB-Eire", "Mexico/General", "Europe/Gibraltar", "America/Glace_Bay", "Etc/GMT", "GMT", "GMT-0", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT+0", "GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT0", "GMT0", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "Etc/Greenwich", "Greenwich", "America/Grenada", "Pacific/Guadalcanal", "America/Guadeloupe", "Pacific/Guam", "America/Guatemala", "America/Guayaquil", "Europe/Guernsey", "America/Guyana", "America/Halifax", "Africa/Harare", "Asia/Harbin", "America/Havana", "US/Hawaii", "Asia/Hebron", "Europe/Helsinki", "America/Hermosillo", "Asia/Ho_Chi_Minh", "Australia/Hobart", "Asia/Hong_Kong", "Hongkong", "Pacific/Honolulu", "Asia/Hovd", "HST", "Iceland", "US/Indiana-Starke", "America/Indiana/Indianapolis", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "Iran", "Asia/Irkutsk", "Europe/Isle_of_Man", "Israel", "Asia/Istanbul", "Europe/Istanbul", "Asia/Jakarta", "Jamaica", "America/Jamaica", "Atlantic/Jan_Mayen", "Japan", "Asia/Jayapura", "Europe/Jersey", "Asia/Jerusalem", "Africa/Johannesburg", "Pacific/Johnston", "Africa/Juba", "America/Jujuy", "America/Argentina/Jujuy", "America/Juneau", "Asia/Kabul", "Europe/Kaliningrad", "Asia/Kamchatka", "Africa/Kampala", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Indian/Kerguelen", "Asia/Khandyga", "Africa/Khartoum", "Europe/Kiev", "Africa/Kigali", "Africa/Kinshasa", "Pacific/Kiritimati", "Europe/Kirov", "America/Indiana/Knox", "America/Knox_IN", "Asia/Kolkata", "Pacific/Kosrae", "America/Kralendijk", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Kwajalein", "Pacific/Kwajalein", "America/La_Paz", "America/Argentina/La_Rioja", "Africa/Lagos", "Australia/LHI", "Africa/Libreville", "Libya", "America/Lima", "Australia/Lindeman", "Europe/Lisbon", "Europe/Ljubljana", "Africa/Lome", "Europe/London", "Arctic/Longyearbyen", "Australia/Lord_Howe", "America/Los_Angeles", "America/Louisville", "America/Kentucky/Louisville", "America/Lower_Princes", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Europe/Luxembourg", "Asia/Macao", "Asia/Macau", "America/Maceio", "Antarctica/Macquarie", "Atlantic/Madeira", "Europe/Madrid", "Asia/Magadan", "Indian/Mahe", "Pacific/Majuro", "Asia/Makassar", "Africa/Malabo", "Indian/Maldives", "Europe/Malta", "America/Managua", "America/Manaus", "Asia/Manila", "Africa/Maputo", "America/Indiana/Marengo", "Europe/Mariehamn", "America/Marigot", "Pacific/Marquesas", "America/Martinique", "Africa/Maseru", "America/Matamoros", "Indian/Mauritius", "Antarctica/Mawson", "Indian/Mayotte", "America/Mazatlan", "Africa/Mbabane", "Antarctica/McMurdo", "Australia/Melbourne", "America/Mendoza", "America/Argentina/Mendoza", "America/Menominee", "America/Merida", "MET", "America/Metlakatla", "America/Mexico_City", "US/Michigan", "Pacific/Midway", "Europe/Minsk", "America/Miquelon", "Africa/Mogadishu", "Europe/Monaco", "America/Moncton", "Africa/Monrovia", "America/Monterrey", "America/Montevideo", "America/Kentucky/Monticello", "America/Montreal", "America/Montserrat", "Europe/Moscow", "US/Mountain", "Canada/Mountain", "MST", "MST7MDT", "Asia/Muscat", "Africa/Nairobi", "America/Nassau", "Pacific/Nauru", "Navajo", "Africa/Ndjamena", "America/North_Dakota/New_Salem", "America/New_York", "Canada/Newfoundland", "Africa/Niamey", "Europe/Nicosia", "Asia/Nicosia", "America/Nipigon", "Pacific/Niue", "America/Nome", "Pacific/Norfolk", "America/Noronha", "Australia/North", "Africa/Nouakchott", "Pacific/Noumea", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Australia/NSW", "America/Nuuk", "NZ", "NZ-CHAT", "America/Ojinaga", "Asia/Omsk", "Asia/Oral", "Europe/Oslo", "Africa/Ouagadougou", "US/Pacific", "Canada/Pacific", "Pacific/Pago_Pago", "Pacific/Palau", "Antarctica/Palmer", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "Europe/Paris", "Australia/Perth", "America/Indiana/Petersburg", "Asia/Phnom_Penh", "America/Phoenix", "Pacific/Pitcairn", "Europe/Podgorica", "Pacific/Pohnpei", "Poland", "Pacific/Ponape", "Asia/Pontianak", "Pacific/Port_Moresby", "America/Port_of_Spain", "America/Port-au-Prince", "America/Porto_Acre", "America/Porto_Velho", "Africa/Porto-Novo", "Portugal", "Europe/Prague", "PRC", "PST8PDT", "America/Puerto_Rico", "America/Punta_Arenas", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Australia/Queensland", "Asia/Qyzylorda", "America/Rainy_River", "Asia/Rangoon", "America/Rankin_Inlet", "Pacific/Rarotonga", "America/Recife", "America/Regina", "America/Resolute", "Indian/Reunion", "Atlantic/Reykjavik", "Europe/Riga", "America/Rio_Branco", "America/Argentina/Rio_Gallegos", "Asia/Riyadh", "ROC", "ROK", "Europe/Rome", "America/Rosario", "Antarctica/Rothera", "Asia/Saigon", "Pacific/Saipan", "Asia/Sakhalin", "America/Argentina/Salta", "Europe/Samara", "Asia/Samarkand", "Pacific/Samoa", "US/Samoa", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "Europe/San_Marino", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "Africa/Sao_Tome", "Europe/Sarajevo", "Europe/Saratov", "Canada/Saskatchewan", "America/Scoresbysund", "Asia/Seoul", "Asia/Shanghai", "America/Shiprock", "Europe/Simferopol", "Asia/Singapore", "Singapore", "America/Sitka", "Europe/Skopje", "Europe/Sofia", "Australia/South", "Atlantic/South_Georgia", "Antarctica/South_Pole", "Asia/Srednekolymsk", "America/St_Barthelemy", "Atlantic/St_Helena", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "Atlantic/Stanley", "Europe/Stockholm", "America/Swift_Current", "Australia/Sydney", "Antarctica/Syowa", "Pacific/Tahiti", "Asia/Taipei", "Europe/Tallinn", "Pacific/Tarawa", "Asia/Tashkent", "Australia/Tasmania", "Asia/Tbilisi", "America/Tegucigalpa", "Asia/Tehran", "Asia/Tel_Aviv", "America/Indiana/Tell_City", "Asia/Thimbu", "Asia/Thimphu", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "Africa/Timbuktu", "Europe/Tirane", "Europe/Tiraspol", "Asia/Tokyo", "Asia/Tomsk", "Pacific/Tongatapu", "America/Toronto", "America/Tortola", "Africa/Tripoli", "Antarctica/Troll", "Pacific/Truk", "America/Argentina/Tucuman", "Africa/Tunis", "Turkey", "Etc/UCT", "UCT", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Europe/Ulyanovsk", "Etc/Universal", "Universal", "Asia/Urumqi", "America/Argentina/Ushuaia", "Asia/Ust-Nera", "UTC", "Etc/UTC", "Europe/Uzhgorod", "Europe/Vaduz", "America/Vancouver", "Europe/Vatican", "America/Indiana/Vevay", "Australia/Victoria", "Europe/Vienna", "Asia/Vientiane", "Europe/Vilnius", "America/Indiana/Vincennes", "America/Virgin", "Asia/Vladivostok", "Europe/Volgograd", "Antarctica/Vostok", "W-SU", "Pacific/Wake", "Pacific/Wallis", "Europe/Warsaw", "Brazil/West", "Australia/West", "WET", "America/Whitehorse", "America/Indiana/Winamac", "Africa/Windhoek", "America/Winnipeg", "America/Yakutat", "Asia/Yakutsk", "Australia/Yancowinna", "Asia/Yangon", "Pacific/Yap", "Asia/Yekaterinburg", "America/Yellowknife", "Asia/Yerevan", "Canada/Yukon", "Europe/Zagreb", "Europe/Zaporozhye", "Etc/Zulu", "Zulu", "Europe/Zurich" ] }, "orderFulfillmentEnabled": { "type": "boolean" }, "orderFulfillmentUseSpecificRules": { "type": "boolean" }, "orderReturnsEnabled": { "type": "boolean" }, "orderReturnsUseSpecificRules": { "type": "boolean" }, "salesChannelAdmin": { "type": "boolean" }, "salesChannelOnline": { "type": "boolean" }, "salesChannelStore": { "type": "boolean" }, "fulfillmentRules": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "ruleType": { "type": "string", "enum": [ "fulfillment", "order_return" ] }, "purchaseType": { "type": "string", "enum": [ "booking", "sales", "subscription", "buyback" ] }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inStoreEnabled": { "type": "boolean" }, "shippingEnabled": { "type": "boolean" }, "localDeliveryEnabled": { "type": "boolean" } }, "required": [ "ruleType", "purchaseType" ], "additionalProperties": false } }, "openingHours": { "type": "array", "items": { "type": "object", "properties": { "validityDateRange": { "nullable": true, "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekday": { "nullable": true, "type": "number", "minimum": 1, "maximum": 7 }, "specificDate": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timeRanges": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } }, "isClosed": { "default": false, "type": "boolean" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "validityDateRange", "weekday", "specificDate", "timeRanges", "isClosed" ], "additionalProperties": false } } }, "required": [ "name", "timezone", "openingHours" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "publicName": { "nullable": true, "type": "string" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" }, "description": { "nullable": true, "type": "string" }, "address": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "state": { "nullable": true, "type": "string" }, "city": { "nullable": true, "type": "string" }, "street": { "nullable": true, "type": "string" }, "zipCode": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "phone": { "nullable": true, "type": "string" }, "openingHours": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "validityDateRange": { "nullable": true, "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekday": { "nullable": true, "type": "number", "minimum": 1, "maximum": 7 }, "specificDate": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timeRanges": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } }, "isClosed": { "default": false, "type": "boolean" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "validityDateRange", "weekday", "specificDate", "timeRanges", "isClosed", "id", "serviceLocationId", "createdAt" ], "additionalProperties": false } }, "timezone": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Brazil/Acre", "Australia/ACT", "America/Adak", "Africa/Addis_Ababa", "Australia/Adelaide", "Asia/Aden", "US/Alaska", "US/Aleutian", "Africa/Algiers", "Asia/Almaty", "Asia/Amman", "Europe/Amsterdam", "Asia/Anadyr", "America/Anchorage", "Europe/Andorra", "America/Anguilla", "Indian/Antananarivo", "America/Antigua", "Pacific/Apia", "Asia/Aqtau", "Asia/Aqtobe", "America/Araguaina", "US/Arizona", "America/Aruba", "Asia/Ashgabat", "Asia/Ashkhabad", "Africa/Asmara", "Africa/Asmera", "Europe/Astrakhan", "America/Asuncion", "Europe/Athens", "America/Atikokan", "America/Atka", "Canada/Atlantic", "Asia/Atyrau", "Pacific/Auckland", "Atlantic/Azores", "Asia/Baghdad", "America/Bahia", "America/Bahia_Banderas", "Asia/Bahrain", "Mexico/BajaNorte", "Mexico/BajaSur", "Asia/Baku", "Africa/Bamako", "Asia/Bangkok", "Africa/Bangui", "Africa/Banjul", "America/Barbados", "Asia/Barnaul", "Asia/Beirut", "America/Belem", "Europe/Belfast", "Europe/Belgrade", "America/Belize", "Europe/Berlin", "Atlantic/Bermuda", "America/North_Dakota/Beulah", "Asia/Bishkek", "Africa/Bissau", "America/Blanc-Sablon", "Africa/Blantyre", "America/Boa_Vista", "America/Bogota", "America/Boise", "Pacific/Bougainville", "Europe/Bratislava", "Africa/Brazzaville", "Australia/Brisbane", "Australia/Broken_Hill", "Asia/Brunei", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "America/Buenos_Aires", "America/Argentina/Buenos_Aires", "Africa/Bujumbura", "Europe/Busingen", "Africa/Cairo", "Asia/Calcutta", "America/Cambridge_Bay", "America/Campo_Grande", "Atlantic/Canary", "Australia/Canberra", "America/Cancun", "Atlantic/Cape_Verde", "America/Caracas", "Africa/Casablanca", "Antarctica/Casey", "America/Catamarca", "America/Argentina/Catamarca", "America/Cayenne", "America/Cayman", "America/North_Dakota/Center", "US/Central", "Canada/Central", "CET", "Africa/Ceuta", "Indian/Chagos", "Pacific/Chatham", "America/Chicago", "America/Chihuahua", "Europe/Chisinau", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Indian/Christmas", "Asia/Chungking", "Pacific/Chuuk", "Indian/Cocos", "Asia/Colombo", "America/Argentina/ComodRivadavia", "Indian/Comoro", "Africa/Conakry", "Chile/Continental", "Europe/Copenhagen", "America/Coral_Harbour", "America/Cordoba", "America/Argentina/Cordoba", "America/Costa_Rica", "America/Creston", "CST6CDT", "Cuba", "America/Cuiaba", "America/Curacao", "Australia/Currie", "Asia/Dacca", "Africa/Dakar", "Asia/Damascus", "America/Danmarkshavn", "Africa/Dar_es_Salaam", "Australia/Darwin", "Antarctica/Davis", "America/Dawson", "America/Dawson_Creek", "Brazil/DeNoronha", "America/Denver", "America/Detroit", "Asia/Dhaka", "Asia/Dili", "Africa/Djibouti", "America/Dominica", "Africa/Douala", "Asia/Dubai", "Europe/Dublin", "Antarctica/DumontDUrville", "Asia/Dushanbe", "Brazil/East", "US/East-Indiana", "Pacific/Easter", "Chile/EasterIsland", "US/Eastern", "Canada/Eastern", "America/Edmonton", "EET", "Pacific/Efate", "Egypt", "Eire", "America/Eirunepe", "Africa/El_Aaiun", "America/El_Salvador", "Pacific/Enderbury", "America/Ensenada", "EST", "EST5EDT", "Australia/Eucla", "Atlantic/Faeroe", "Pacific/Fakaofo", "Asia/Famagusta", "Atlantic/Faroe", "Pacific/Fiji", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "Africa/Freetown", "Pacific/Funafuti", "Africa/Gaborone", "Pacific/Galapagos", "Pacific/Gambier", "Asia/Gaza", "GB", "GB-Eire", "Mexico/General", "Europe/Gibraltar", "America/Glace_Bay", "Etc/GMT", "GMT", "GMT-0", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT+0", "GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT0", "GMT0", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "Etc/Greenwich", "Greenwich", "America/Grenada", "Pacific/Guadalcanal", "America/Guadeloupe", "Pacific/Guam", "America/Guatemala", "America/Guayaquil", "Europe/Guernsey", "America/Guyana", "America/Halifax", "Africa/Harare", "Asia/Harbin", "America/Havana", "US/Hawaii", "Asia/Hebron", "Europe/Helsinki", "America/Hermosillo", "Asia/Ho_Chi_Minh", "Australia/Hobart", "Asia/Hong_Kong", "Hongkong", "Pacific/Honolulu", "Asia/Hovd", "HST", "Iceland", "US/Indiana-Starke", "America/Indiana/Indianapolis", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "Iran", "Asia/Irkutsk", "Europe/Isle_of_Man", "Israel", "Asia/Istanbul", "Europe/Istanbul", "Asia/Jakarta", "Jamaica", "America/Jamaica", "Atlantic/Jan_Mayen", "Japan", "Asia/Jayapura", "Europe/Jersey", "Asia/Jerusalem", "Africa/Johannesburg", "Pacific/Johnston", "Africa/Juba", "America/Jujuy", "America/Argentina/Jujuy", "America/Juneau", "Asia/Kabul", "Europe/Kaliningrad", "Asia/Kamchatka", "Africa/Kampala", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Indian/Kerguelen", "Asia/Khandyga", "Africa/Khartoum", "Europe/Kiev", "Africa/Kigali", "Africa/Kinshasa", "Pacific/Kiritimati", "Europe/Kirov", "America/Indiana/Knox", "America/Knox_IN", "Asia/Kolkata", "Pacific/Kosrae", "America/Kralendijk", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Kwajalein", "Pacific/Kwajalein", "America/La_Paz", "America/Argentina/La_Rioja", "Africa/Lagos", "Australia/LHI", "Africa/Libreville", "Libya", "America/Lima", "Australia/Lindeman", "Europe/Lisbon", "Europe/Ljubljana", "Africa/Lome", "Europe/London", "Arctic/Longyearbyen", "Australia/Lord_Howe", "America/Los_Angeles", "America/Louisville", "America/Kentucky/Louisville", "America/Lower_Princes", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Europe/Luxembourg", "Asia/Macao", "Asia/Macau", "America/Maceio", "Antarctica/Macquarie", "Atlantic/Madeira", "Europe/Madrid", "Asia/Magadan", "Indian/Mahe", "Pacific/Majuro", "Asia/Makassar", "Africa/Malabo", "Indian/Maldives", "Europe/Malta", "America/Managua", "America/Manaus", "Asia/Manila", "Africa/Maputo", "America/Indiana/Marengo", "Europe/Mariehamn", "America/Marigot", "Pacific/Marquesas", "America/Martinique", "Africa/Maseru", "America/Matamoros", "Indian/Mauritius", "Antarctica/Mawson", "Indian/Mayotte", "America/Mazatlan", "Africa/Mbabane", "Antarctica/McMurdo", "Australia/Melbourne", "America/Mendoza", "America/Argentina/Mendoza", "America/Menominee", "America/Merida", "MET", "America/Metlakatla", "America/Mexico_City", "US/Michigan", "Pacific/Midway", "Europe/Minsk", "America/Miquelon", "Africa/Mogadishu", "Europe/Monaco", "America/Moncton", "Africa/Monrovia", "America/Monterrey", "America/Montevideo", "America/Kentucky/Monticello", "America/Montreal", "America/Montserrat", "Europe/Moscow", "US/Mountain", "Canada/Mountain", "MST", "MST7MDT", "Asia/Muscat", "Africa/Nairobi", "America/Nassau", "Pacific/Nauru", "Navajo", "Africa/Ndjamena", "America/North_Dakota/New_Salem", "America/New_York", "Canada/Newfoundland", "Africa/Niamey", "Europe/Nicosia", "Asia/Nicosia", "America/Nipigon", "Pacific/Niue", "America/Nome", "Pacific/Norfolk", "America/Noronha", "Australia/North", "Africa/Nouakchott", "Pacific/Noumea", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Australia/NSW", "America/Nuuk", "NZ", "NZ-CHAT", "America/Ojinaga", "Asia/Omsk", "Asia/Oral", "Europe/Oslo", "Africa/Ouagadougou", "US/Pacific", "Canada/Pacific", "Pacific/Pago_Pago", "Pacific/Palau", "Antarctica/Palmer", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "Europe/Paris", "Australia/Perth", "America/Indiana/Petersburg", "Asia/Phnom_Penh", "America/Phoenix", "Pacific/Pitcairn", "Europe/Podgorica", "Pacific/Pohnpei", "Poland", "Pacific/Ponape", "Asia/Pontianak", "Pacific/Port_Moresby", "America/Port_of_Spain", "America/Port-au-Prince", "America/Porto_Acre", "America/Porto_Velho", "Africa/Porto-Novo", "Portugal", "Europe/Prague", "PRC", "PST8PDT", "America/Puerto_Rico", "America/Punta_Arenas", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Australia/Queensland", "Asia/Qyzylorda", "America/Rainy_River", "Asia/Rangoon", "America/Rankin_Inlet", "Pacific/Rarotonga", "America/Recife", "America/Regina", "America/Resolute", "Indian/Reunion", "Atlantic/Reykjavik", "Europe/Riga", "America/Rio_Branco", "America/Argentina/Rio_Gallegos", "Asia/Riyadh", "ROC", "ROK", "Europe/Rome", "America/Rosario", "Antarctica/Rothera", "Asia/Saigon", "Pacific/Saipan", "Asia/Sakhalin", "America/Argentina/Salta", "Europe/Samara", "Asia/Samarkand", "Pacific/Samoa", "US/Samoa", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "Europe/San_Marino", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "Africa/Sao_Tome", "Europe/Sarajevo", "Europe/Saratov", "Canada/Saskatchewan", "America/Scoresbysund", "Asia/Seoul", "Asia/Shanghai", "America/Shiprock", "Europe/Simferopol", "Asia/Singapore", "Singapore", "America/Sitka", "Europe/Skopje", "Europe/Sofia", "Australia/South", "Atlantic/South_Georgia", "Antarctica/South_Pole", "Asia/Srednekolymsk", "America/St_Barthelemy", "Atlantic/St_Helena", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "Atlantic/Stanley", "Europe/Stockholm", "America/Swift_Current", "Australia/Sydney", "Antarctica/Syowa", "Pacific/Tahiti", "Asia/Taipei", "Europe/Tallinn", "Pacific/Tarawa", "Asia/Tashkent", "Australia/Tasmania", "Asia/Tbilisi", "America/Tegucigalpa", "Asia/Tehran", "Asia/Tel_Aviv", "America/Indiana/Tell_City", "Asia/Thimbu", "Asia/Thimphu", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "Africa/Timbuktu", "Europe/Tirane", "Europe/Tiraspol", "Asia/Tokyo", "Asia/Tomsk", "Pacific/Tongatapu", "America/Toronto", "America/Tortola", "Africa/Tripoli", "Antarctica/Troll", "Pacific/Truk", "America/Argentina/Tucuman", "Africa/Tunis", "Turkey", "Etc/UCT", "UCT", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Europe/Ulyanovsk", "Etc/Universal", "Universal", "Asia/Urumqi", "America/Argentina/Ushuaia", "Asia/Ust-Nera", "UTC", "Etc/UTC", "Europe/Uzhgorod", "Europe/Vaduz", "America/Vancouver", "Europe/Vatican", "America/Indiana/Vevay", "Australia/Victoria", "Europe/Vienna", "Asia/Vientiane", "Europe/Vilnius", "America/Indiana/Vincennes", "America/Virgin", "Asia/Vladivostok", "Europe/Volgograd", "Antarctica/Vostok", "W-SU", "Pacific/Wake", "Pacific/Wallis", "Europe/Warsaw", "Brazil/West", "Australia/West", "WET", "America/Whitehorse", "America/Indiana/Winamac", "Africa/Windhoek", "America/Winnipeg", "America/Yakutat", "Asia/Yakutsk", "Australia/Yancowinna", "Asia/Yangon", "Pacific/Yap", "Asia/Yekaterinburg", "America/Yellowknife", "Asia/Yerevan", "Canada/Yukon", "Europe/Zagreb", "Europe/Zaporozhye", "Etc/Zulu", "Zulu", "Europe/Zurich" ] }, "orderFulfillmentEnabled": { "type": "boolean" }, "orderFulfillmentUseSpecificRules": { "type": "boolean" }, "orderReturnsEnabled": { "type": "boolean" }, "orderReturnsUseSpecificRules": { "type": "boolean" }, "salesChannelAdmin": { "type": "boolean" }, "salesChannelOnline": { "type": "boolean" }, "salesChannelStore": { "type": "boolean" }, "fulfillmentRules": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "ruleType": { "type": "string", "enum": [ "fulfillment", "order_return" ] }, "purchaseType": { "type": "string", "enum": [ "booking", "sales", "subscription", "buyback" ] }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inStoreEnabled": { "type": "boolean" }, "shippingEnabled": { "type": "boolean" }, "localDeliveryEnabled": { "type": "boolean" } }, "required": [ "ruleType", "purchaseType" ], "additionalProperties": false } }, "tenantId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "archivedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "name", "isDefault", "isActive", "timezone", "tenantId", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/service-locations/{id}": { "put": { "summary": "Update a service location", "tags": [ "inventory", "serviceLocations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.serviceLocations.update", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "publicName": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "address": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "state": { "nullable": true, "type": "string" }, "city": { "nullable": true, "type": "string" }, "street": { "nullable": true, "type": "string" }, "zipCode": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "phone": { "nullable": true, "type": "string" }, "timezone": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Brazil/Acre", "Australia/ACT", "America/Adak", "Africa/Addis_Ababa", "Australia/Adelaide", "Asia/Aden", "US/Alaska", "US/Aleutian", "Africa/Algiers", "Asia/Almaty", "Asia/Amman", "Europe/Amsterdam", "Asia/Anadyr", "America/Anchorage", "Europe/Andorra", "America/Anguilla", "Indian/Antananarivo", "America/Antigua", "Pacific/Apia", "Asia/Aqtau", "Asia/Aqtobe", "America/Araguaina", "US/Arizona", "America/Aruba", "Asia/Ashgabat", "Asia/Ashkhabad", "Africa/Asmara", "Africa/Asmera", "Europe/Astrakhan", "America/Asuncion", "Europe/Athens", "America/Atikokan", "America/Atka", "Canada/Atlantic", "Asia/Atyrau", "Pacific/Auckland", "Atlantic/Azores", "Asia/Baghdad", "America/Bahia", "America/Bahia_Banderas", "Asia/Bahrain", "Mexico/BajaNorte", "Mexico/BajaSur", "Asia/Baku", "Africa/Bamako", "Asia/Bangkok", "Africa/Bangui", "Africa/Banjul", "America/Barbados", "Asia/Barnaul", "Asia/Beirut", "America/Belem", "Europe/Belfast", "Europe/Belgrade", "America/Belize", "Europe/Berlin", "Atlantic/Bermuda", "America/North_Dakota/Beulah", "Asia/Bishkek", "Africa/Bissau", "America/Blanc-Sablon", "Africa/Blantyre", "America/Boa_Vista", "America/Bogota", "America/Boise", "Pacific/Bougainville", "Europe/Bratislava", "Africa/Brazzaville", "Australia/Brisbane", "Australia/Broken_Hill", "Asia/Brunei", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "America/Buenos_Aires", "America/Argentina/Buenos_Aires", "Africa/Bujumbura", "Europe/Busingen", "Africa/Cairo", "Asia/Calcutta", "America/Cambridge_Bay", "America/Campo_Grande", "Atlantic/Canary", "Australia/Canberra", "America/Cancun", "Atlantic/Cape_Verde", "America/Caracas", "Africa/Casablanca", "Antarctica/Casey", "America/Catamarca", "America/Argentina/Catamarca", "America/Cayenne", "America/Cayman", "America/North_Dakota/Center", "US/Central", "Canada/Central", "CET", "Africa/Ceuta", "Indian/Chagos", "Pacific/Chatham", "America/Chicago", "America/Chihuahua", "Europe/Chisinau", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Indian/Christmas", "Asia/Chungking", "Pacific/Chuuk", "Indian/Cocos", "Asia/Colombo", "America/Argentina/ComodRivadavia", "Indian/Comoro", "Africa/Conakry", "Chile/Continental", "Europe/Copenhagen", "America/Coral_Harbour", "America/Cordoba", "America/Argentina/Cordoba", "America/Costa_Rica", "America/Creston", "CST6CDT", "Cuba", "America/Cuiaba", "America/Curacao", "Australia/Currie", "Asia/Dacca", "Africa/Dakar", "Asia/Damascus", "America/Danmarkshavn", "Africa/Dar_es_Salaam", "Australia/Darwin", "Antarctica/Davis", "America/Dawson", "America/Dawson_Creek", "Brazil/DeNoronha", "America/Denver", "America/Detroit", "Asia/Dhaka", "Asia/Dili", "Africa/Djibouti", "America/Dominica", "Africa/Douala", "Asia/Dubai", "Europe/Dublin", "Antarctica/DumontDUrville", "Asia/Dushanbe", "Brazil/East", "US/East-Indiana", "Pacific/Easter", "Chile/EasterIsland", "US/Eastern", "Canada/Eastern", "America/Edmonton", "EET", "Pacific/Efate", "Egypt", "Eire", "America/Eirunepe", "Africa/El_Aaiun", "America/El_Salvador", "Pacific/Enderbury", "America/Ensenada", "EST", "EST5EDT", "Australia/Eucla", "Atlantic/Faeroe", "Pacific/Fakaofo", "Asia/Famagusta", "Atlantic/Faroe", "Pacific/Fiji", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "Africa/Freetown", "Pacific/Funafuti", "Africa/Gaborone", "Pacific/Galapagos", "Pacific/Gambier", "Asia/Gaza", "GB", "GB-Eire", "Mexico/General", "Europe/Gibraltar", "America/Glace_Bay", "Etc/GMT", "GMT", "GMT-0", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT+0", "GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT0", "GMT0", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "Etc/Greenwich", "Greenwich", "America/Grenada", "Pacific/Guadalcanal", "America/Guadeloupe", "Pacific/Guam", "America/Guatemala", "America/Guayaquil", "Europe/Guernsey", "America/Guyana", "America/Halifax", "Africa/Harare", "Asia/Harbin", "America/Havana", "US/Hawaii", "Asia/Hebron", "Europe/Helsinki", "America/Hermosillo", "Asia/Ho_Chi_Minh", "Australia/Hobart", "Asia/Hong_Kong", "Hongkong", "Pacific/Honolulu", "Asia/Hovd", "HST", "Iceland", "US/Indiana-Starke", "America/Indiana/Indianapolis", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "Iran", "Asia/Irkutsk", "Europe/Isle_of_Man", "Israel", "Asia/Istanbul", "Europe/Istanbul", "Asia/Jakarta", "Jamaica", "America/Jamaica", "Atlantic/Jan_Mayen", "Japan", "Asia/Jayapura", "Europe/Jersey", "Asia/Jerusalem", "Africa/Johannesburg", "Pacific/Johnston", "Africa/Juba", "America/Jujuy", "America/Argentina/Jujuy", "America/Juneau", "Asia/Kabul", "Europe/Kaliningrad", "Asia/Kamchatka", "Africa/Kampala", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Indian/Kerguelen", "Asia/Khandyga", "Africa/Khartoum", "Europe/Kiev", "Africa/Kigali", "Africa/Kinshasa", "Pacific/Kiritimati", "Europe/Kirov", "America/Indiana/Knox", "America/Knox_IN", "Asia/Kolkata", "Pacific/Kosrae", "America/Kralendijk", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Kwajalein", "Pacific/Kwajalein", "America/La_Paz", "America/Argentina/La_Rioja", "Africa/Lagos", "Australia/LHI", "Africa/Libreville", "Libya", "America/Lima", "Australia/Lindeman", "Europe/Lisbon", "Europe/Ljubljana", "Africa/Lome", "Europe/London", "Arctic/Longyearbyen", "Australia/Lord_Howe", "America/Los_Angeles", "America/Louisville", "America/Kentucky/Louisville", "America/Lower_Princes", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Europe/Luxembourg", "Asia/Macao", "Asia/Macau", "America/Maceio", "Antarctica/Macquarie", "Atlantic/Madeira", "Europe/Madrid", "Asia/Magadan", "Indian/Mahe", "Pacific/Majuro", "Asia/Makassar", "Africa/Malabo", "Indian/Maldives", "Europe/Malta", "America/Managua", "America/Manaus", "Asia/Manila", "Africa/Maputo", "America/Indiana/Marengo", "Europe/Mariehamn", "America/Marigot", "Pacific/Marquesas", "America/Martinique", "Africa/Maseru", "America/Matamoros", "Indian/Mauritius", "Antarctica/Mawson", "Indian/Mayotte", "America/Mazatlan", "Africa/Mbabane", "Antarctica/McMurdo", "Australia/Melbourne", "America/Mendoza", "America/Argentina/Mendoza", "America/Menominee", "America/Merida", "MET", "America/Metlakatla", "America/Mexico_City", "US/Michigan", "Pacific/Midway", "Europe/Minsk", "America/Miquelon", "Africa/Mogadishu", "Europe/Monaco", "America/Moncton", "Africa/Monrovia", "America/Monterrey", "America/Montevideo", "America/Kentucky/Monticello", "America/Montreal", "America/Montserrat", "Europe/Moscow", "US/Mountain", "Canada/Mountain", "MST", "MST7MDT", "Asia/Muscat", "Africa/Nairobi", "America/Nassau", "Pacific/Nauru", "Navajo", "Africa/Ndjamena", "America/North_Dakota/New_Salem", "America/New_York", "Canada/Newfoundland", "Africa/Niamey", "Europe/Nicosia", "Asia/Nicosia", "America/Nipigon", "Pacific/Niue", "America/Nome", "Pacific/Norfolk", "America/Noronha", "Australia/North", "Africa/Nouakchott", "Pacific/Noumea", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Australia/NSW", "America/Nuuk", "NZ", "NZ-CHAT", "America/Ojinaga", "Asia/Omsk", "Asia/Oral", "Europe/Oslo", "Africa/Ouagadougou", "US/Pacific", "Canada/Pacific", "Pacific/Pago_Pago", "Pacific/Palau", "Antarctica/Palmer", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "Europe/Paris", "Australia/Perth", "America/Indiana/Petersburg", "Asia/Phnom_Penh", "America/Phoenix", "Pacific/Pitcairn", "Europe/Podgorica", "Pacific/Pohnpei", "Poland", "Pacific/Ponape", "Asia/Pontianak", "Pacific/Port_Moresby", "America/Port_of_Spain", "America/Port-au-Prince", "America/Porto_Acre", "America/Porto_Velho", "Africa/Porto-Novo", "Portugal", "Europe/Prague", "PRC", "PST8PDT", "America/Puerto_Rico", "America/Punta_Arenas", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Australia/Queensland", "Asia/Qyzylorda", "America/Rainy_River", "Asia/Rangoon", "America/Rankin_Inlet", "Pacific/Rarotonga", "America/Recife", "America/Regina", "America/Resolute", "Indian/Reunion", "Atlantic/Reykjavik", "Europe/Riga", "America/Rio_Branco", "America/Argentina/Rio_Gallegos", "Asia/Riyadh", "ROC", "ROK", "Europe/Rome", "America/Rosario", "Antarctica/Rothera", "Asia/Saigon", "Pacific/Saipan", "Asia/Sakhalin", "America/Argentina/Salta", "Europe/Samara", "Asia/Samarkand", "Pacific/Samoa", "US/Samoa", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "Europe/San_Marino", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "Africa/Sao_Tome", "Europe/Sarajevo", "Europe/Saratov", "Canada/Saskatchewan", "America/Scoresbysund", "Asia/Seoul", "Asia/Shanghai", "America/Shiprock", "Europe/Simferopol", "Asia/Singapore", "Singapore", "America/Sitka", "Europe/Skopje", "Europe/Sofia", "Australia/South", "Atlantic/South_Georgia", "Antarctica/South_Pole", "Asia/Srednekolymsk", "America/St_Barthelemy", "Atlantic/St_Helena", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "Atlantic/Stanley", "Europe/Stockholm", "America/Swift_Current", "Australia/Sydney", "Antarctica/Syowa", "Pacific/Tahiti", "Asia/Taipei", "Europe/Tallinn", "Pacific/Tarawa", "Asia/Tashkent", "Australia/Tasmania", "Asia/Tbilisi", "America/Tegucigalpa", "Asia/Tehran", "Asia/Tel_Aviv", "America/Indiana/Tell_City", "Asia/Thimbu", "Asia/Thimphu", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "Africa/Timbuktu", "Europe/Tirane", "Europe/Tiraspol", "Asia/Tokyo", "Asia/Tomsk", "Pacific/Tongatapu", "America/Toronto", "America/Tortola", "Africa/Tripoli", "Antarctica/Troll", "Pacific/Truk", "America/Argentina/Tucuman", "Africa/Tunis", "Turkey", "Etc/UCT", "UCT", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Europe/Ulyanovsk", "Etc/Universal", "Universal", "Asia/Urumqi", "America/Argentina/Ushuaia", "Asia/Ust-Nera", "UTC", "Etc/UTC", "Europe/Uzhgorod", "Europe/Vaduz", "America/Vancouver", "Europe/Vatican", "America/Indiana/Vevay", "Australia/Victoria", "Europe/Vienna", "Asia/Vientiane", "Europe/Vilnius", "America/Indiana/Vincennes", "America/Virgin", "Asia/Vladivostok", "Europe/Volgograd", "Antarctica/Vostok", "W-SU", "Pacific/Wake", "Pacific/Wallis", "Europe/Warsaw", "Brazil/West", "Australia/West", "WET", "America/Whitehorse", "America/Indiana/Winamac", "Africa/Windhoek", "America/Winnipeg", "America/Yakutat", "Asia/Yakutsk", "Australia/Yancowinna", "Asia/Yangon", "Pacific/Yap", "Asia/Yekaterinburg", "America/Yellowknife", "Asia/Yerevan", "Canada/Yukon", "Europe/Zagreb", "Europe/Zaporozhye", "Etc/Zulu", "Zulu", "Europe/Zurich" ] }, "orderFulfillmentEnabled": { "type": "boolean" }, "orderFulfillmentUseSpecificRules": { "type": "boolean" }, "orderReturnsEnabled": { "type": "boolean" }, "orderReturnsUseSpecificRules": { "type": "boolean" }, "salesChannelAdmin": { "type": "boolean" }, "salesChannelOnline": { "type": "boolean" }, "salesChannelStore": { "type": "boolean" }, "fulfillmentRules": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "ruleType": { "type": "string", "enum": [ "fulfillment", "order_return" ] }, "purchaseType": { "type": "string", "enum": [ "booking", "sales", "subscription", "buyback" ] }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inStoreEnabled": { "type": "boolean" }, "shippingEnabled": { "type": "boolean" }, "localDeliveryEnabled": { "type": "boolean" } }, "required": [ "ruleType", "purchaseType" ], "additionalProperties": false } }, "openingHours": { "type": "array", "items": { "type": "object", "properties": { "validityDateRange": { "nullable": true, "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekday": { "nullable": true, "type": "number", "minimum": 1, "maximum": 7 }, "specificDate": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timeRanges": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } }, "isClosed": { "default": false, "type": "boolean" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "validityDateRange", "weekday", "specificDate", "timeRanges", "isClosed" ], "additionalProperties": false } } }, "required": [ "name", "timezone", "openingHours" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "publicName": { "nullable": true, "type": "string" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" }, "description": { "nullable": true, "type": "string" }, "address": { "nullable": true, "type": "string" }, "country": { "nullable": true, "type": "string" }, "state": { "nullable": true, "type": "string" }, "city": { "nullable": true, "type": "string" }, "street": { "nullable": true, "type": "string" }, "zipCode": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "phone": { "nullable": true, "type": "string" }, "openingHours": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "validityDateRange": { "nullable": true, "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekday": { "nullable": true, "type": "number", "minimum": 1, "maximum": 7 }, "specificDate": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timeRanges": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } }, "isClosed": { "default": false, "type": "boolean" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "validityDateRange", "weekday", "specificDate", "timeRanges", "isClosed", "id", "serviceLocationId", "createdAt" ], "additionalProperties": false } }, "timezone": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Brazil/Acre", "Australia/ACT", "America/Adak", "Africa/Addis_Ababa", "Australia/Adelaide", "Asia/Aden", "US/Alaska", "US/Aleutian", "Africa/Algiers", "Asia/Almaty", "Asia/Amman", "Europe/Amsterdam", "Asia/Anadyr", "America/Anchorage", "Europe/Andorra", "America/Anguilla", "Indian/Antananarivo", "America/Antigua", "Pacific/Apia", "Asia/Aqtau", "Asia/Aqtobe", "America/Araguaina", "US/Arizona", "America/Aruba", "Asia/Ashgabat", "Asia/Ashkhabad", "Africa/Asmara", "Africa/Asmera", "Europe/Astrakhan", "America/Asuncion", "Europe/Athens", "America/Atikokan", "America/Atka", "Canada/Atlantic", "Asia/Atyrau", "Pacific/Auckland", "Atlantic/Azores", "Asia/Baghdad", "America/Bahia", "America/Bahia_Banderas", "Asia/Bahrain", "Mexico/BajaNorte", "Mexico/BajaSur", "Asia/Baku", "Africa/Bamako", "Asia/Bangkok", "Africa/Bangui", "Africa/Banjul", "America/Barbados", "Asia/Barnaul", "Asia/Beirut", "America/Belem", "Europe/Belfast", "Europe/Belgrade", "America/Belize", "Europe/Berlin", "Atlantic/Bermuda", "America/North_Dakota/Beulah", "Asia/Bishkek", "Africa/Bissau", "America/Blanc-Sablon", "Africa/Blantyre", "America/Boa_Vista", "America/Bogota", "America/Boise", "Pacific/Bougainville", "Europe/Bratislava", "Africa/Brazzaville", "Australia/Brisbane", "Australia/Broken_Hill", "Asia/Brunei", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "America/Buenos_Aires", "America/Argentina/Buenos_Aires", "Africa/Bujumbura", "Europe/Busingen", "Africa/Cairo", "Asia/Calcutta", "America/Cambridge_Bay", "America/Campo_Grande", "Atlantic/Canary", "Australia/Canberra", "America/Cancun", "Atlantic/Cape_Verde", "America/Caracas", "Africa/Casablanca", "Antarctica/Casey", "America/Catamarca", "America/Argentina/Catamarca", "America/Cayenne", "America/Cayman", "America/North_Dakota/Center", "US/Central", "Canada/Central", "CET", "Africa/Ceuta", "Indian/Chagos", "Pacific/Chatham", "America/Chicago", "America/Chihuahua", "Europe/Chisinau", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Indian/Christmas", "Asia/Chungking", "Pacific/Chuuk", "Indian/Cocos", "Asia/Colombo", "America/Argentina/ComodRivadavia", "Indian/Comoro", "Africa/Conakry", "Chile/Continental", "Europe/Copenhagen", "America/Coral_Harbour", "America/Cordoba", "America/Argentina/Cordoba", "America/Costa_Rica", "America/Creston", "CST6CDT", "Cuba", "America/Cuiaba", "America/Curacao", "Australia/Currie", "Asia/Dacca", "Africa/Dakar", "Asia/Damascus", "America/Danmarkshavn", "Africa/Dar_es_Salaam", "Australia/Darwin", "Antarctica/Davis", "America/Dawson", "America/Dawson_Creek", "Brazil/DeNoronha", "America/Denver", "America/Detroit", "Asia/Dhaka", "Asia/Dili", "Africa/Djibouti", "America/Dominica", "Africa/Douala", "Asia/Dubai", "Europe/Dublin", "Antarctica/DumontDUrville", "Asia/Dushanbe", "Brazil/East", "US/East-Indiana", "Pacific/Easter", "Chile/EasterIsland", "US/Eastern", "Canada/Eastern", "America/Edmonton", "EET", "Pacific/Efate", "Egypt", "Eire", "America/Eirunepe", "Africa/El_Aaiun", "America/El_Salvador", "Pacific/Enderbury", "America/Ensenada", "EST", "EST5EDT", "Australia/Eucla", "Atlantic/Faeroe", "Pacific/Fakaofo", "Asia/Famagusta", "Atlantic/Faroe", "Pacific/Fiji", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "Africa/Freetown", "Pacific/Funafuti", "Africa/Gaborone", "Pacific/Galapagos", "Pacific/Gambier", "Asia/Gaza", "GB", "GB-Eire", "Mexico/General", "Europe/Gibraltar", "America/Glace_Bay", "Etc/GMT", "GMT", "GMT-0", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT+0", "GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT0", "GMT0", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "Etc/Greenwich", "Greenwich", "America/Grenada", "Pacific/Guadalcanal", "America/Guadeloupe", "Pacific/Guam", "America/Guatemala", "America/Guayaquil", "Europe/Guernsey", "America/Guyana", "America/Halifax", "Africa/Harare", "Asia/Harbin", "America/Havana", "US/Hawaii", "Asia/Hebron", "Europe/Helsinki", "America/Hermosillo", "Asia/Ho_Chi_Minh", "Australia/Hobart", "Asia/Hong_Kong", "Hongkong", "Pacific/Honolulu", "Asia/Hovd", "HST", "Iceland", "US/Indiana-Starke", "America/Indiana/Indianapolis", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "Iran", "Asia/Irkutsk", "Europe/Isle_of_Man", "Israel", "Asia/Istanbul", "Europe/Istanbul", "Asia/Jakarta", "Jamaica", "America/Jamaica", "Atlantic/Jan_Mayen", "Japan", "Asia/Jayapura", "Europe/Jersey", "Asia/Jerusalem", "Africa/Johannesburg", "Pacific/Johnston", "Africa/Juba", "America/Jujuy", "America/Argentina/Jujuy", "America/Juneau", "Asia/Kabul", "Europe/Kaliningrad", "Asia/Kamchatka", "Africa/Kampala", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Indian/Kerguelen", "Asia/Khandyga", "Africa/Khartoum", "Europe/Kiev", "Africa/Kigali", "Africa/Kinshasa", "Pacific/Kiritimati", "Europe/Kirov", "America/Indiana/Knox", "America/Knox_IN", "Asia/Kolkata", "Pacific/Kosrae", "America/Kralendijk", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Kwajalein", "Pacific/Kwajalein", "America/La_Paz", "America/Argentina/La_Rioja", "Africa/Lagos", "Australia/LHI", "Africa/Libreville", "Libya", "America/Lima", "Australia/Lindeman", "Europe/Lisbon", "Europe/Ljubljana", "Africa/Lome", "Europe/London", "Arctic/Longyearbyen", "Australia/Lord_Howe", "America/Los_Angeles", "America/Louisville", "America/Kentucky/Louisville", "America/Lower_Princes", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Europe/Luxembourg", "Asia/Macao", "Asia/Macau", "America/Maceio", "Antarctica/Macquarie", "Atlantic/Madeira", "Europe/Madrid", "Asia/Magadan", "Indian/Mahe", "Pacific/Majuro", "Asia/Makassar", "Africa/Malabo", "Indian/Maldives", "Europe/Malta", "America/Managua", "America/Manaus", "Asia/Manila", "Africa/Maputo", "America/Indiana/Marengo", "Europe/Mariehamn", "America/Marigot", "Pacific/Marquesas", "America/Martinique", "Africa/Maseru", "America/Matamoros", "Indian/Mauritius", "Antarctica/Mawson", "Indian/Mayotte", "America/Mazatlan", "Africa/Mbabane", "Antarctica/McMurdo", "Australia/Melbourne", "America/Mendoza", "America/Argentina/Mendoza", "America/Menominee", "America/Merida", "MET", "America/Metlakatla", "America/Mexico_City", "US/Michigan", "Pacific/Midway", "Europe/Minsk", "America/Miquelon", "Africa/Mogadishu", "Europe/Monaco", "America/Moncton", "Africa/Monrovia", "America/Monterrey", "America/Montevideo", "America/Kentucky/Monticello", "America/Montreal", "America/Montserrat", "Europe/Moscow", "US/Mountain", "Canada/Mountain", "MST", "MST7MDT", "Asia/Muscat", "Africa/Nairobi", "America/Nassau", "Pacific/Nauru", "Navajo", "Africa/Ndjamena", "America/North_Dakota/New_Salem", "America/New_York", "Canada/Newfoundland", "Africa/Niamey", "Europe/Nicosia", "Asia/Nicosia", "America/Nipigon", "Pacific/Niue", "America/Nome", "Pacific/Norfolk", "America/Noronha", "Australia/North", "Africa/Nouakchott", "Pacific/Noumea", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Australia/NSW", "America/Nuuk", "NZ", "NZ-CHAT", "America/Ojinaga", "Asia/Omsk", "Asia/Oral", "Europe/Oslo", "Africa/Ouagadougou", "US/Pacific", "Canada/Pacific", "Pacific/Pago_Pago", "Pacific/Palau", "Antarctica/Palmer", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "Europe/Paris", "Australia/Perth", "America/Indiana/Petersburg", "Asia/Phnom_Penh", "America/Phoenix", "Pacific/Pitcairn", "Europe/Podgorica", "Pacific/Pohnpei", "Poland", "Pacific/Ponape", "Asia/Pontianak", "Pacific/Port_Moresby", "America/Port_of_Spain", "America/Port-au-Prince", "America/Porto_Acre", "America/Porto_Velho", "Africa/Porto-Novo", "Portugal", "Europe/Prague", "PRC", "PST8PDT", "America/Puerto_Rico", "America/Punta_Arenas", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Australia/Queensland", "Asia/Qyzylorda", "America/Rainy_River", "Asia/Rangoon", "America/Rankin_Inlet", "Pacific/Rarotonga", "America/Recife", "America/Regina", "America/Resolute", "Indian/Reunion", "Atlantic/Reykjavik", "Europe/Riga", "America/Rio_Branco", "America/Argentina/Rio_Gallegos", "Asia/Riyadh", "ROC", "ROK", "Europe/Rome", "America/Rosario", "Antarctica/Rothera", "Asia/Saigon", "Pacific/Saipan", "Asia/Sakhalin", "America/Argentina/Salta", "Europe/Samara", "Asia/Samarkand", "Pacific/Samoa", "US/Samoa", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "Europe/San_Marino", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "Africa/Sao_Tome", "Europe/Sarajevo", "Europe/Saratov", "Canada/Saskatchewan", "America/Scoresbysund", "Asia/Seoul", "Asia/Shanghai", "America/Shiprock", "Europe/Simferopol", "Asia/Singapore", "Singapore", "America/Sitka", "Europe/Skopje", "Europe/Sofia", "Australia/South", "Atlantic/South_Georgia", "Antarctica/South_Pole", "Asia/Srednekolymsk", "America/St_Barthelemy", "Atlantic/St_Helena", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "Atlantic/Stanley", "Europe/Stockholm", "America/Swift_Current", "Australia/Sydney", "Antarctica/Syowa", "Pacific/Tahiti", "Asia/Taipei", "Europe/Tallinn", "Pacific/Tarawa", "Asia/Tashkent", "Australia/Tasmania", "Asia/Tbilisi", "America/Tegucigalpa", "Asia/Tehran", "Asia/Tel_Aviv", "America/Indiana/Tell_City", "Asia/Thimbu", "Asia/Thimphu", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "Africa/Timbuktu", "Europe/Tirane", "Europe/Tiraspol", "Asia/Tokyo", "Asia/Tomsk", "Pacific/Tongatapu", "America/Toronto", "America/Tortola", "Africa/Tripoli", "Antarctica/Troll", "Pacific/Truk", "America/Argentina/Tucuman", "Africa/Tunis", "Turkey", "Etc/UCT", "UCT", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Europe/Ulyanovsk", "Etc/Universal", "Universal", "Asia/Urumqi", "America/Argentina/Ushuaia", "Asia/Ust-Nera", "UTC", "Etc/UTC", "Europe/Uzhgorod", "Europe/Vaduz", "America/Vancouver", "Europe/Vatican", "America/Indiana/Vevay", "Australia/Victoria", "Europe/Vienna", "Asia/Vientiane", "Europe/Vilnius", "America/Indiana/Vincennes", "America/Virgin", "Asia/Vladivostok", "Europe/Volgograd", "Antarctica/Vostok", "W-SU", "Pacific/Wake", "Pacific/Wallis", "Europe/Warsaw", "Brazil/West", "Australia/West", "WET", "America/Whitehorse", "America/Indiana/Winamac", "Africa/Windhoek", "America/Winnipeg", "America/Yakutat", "Asia/Yakutsk", "Australia/Yancowinna", "Asia/Yangon", "Pacific/Yap", "Asia/Yekaterinburg", "America/Yellowknife", "Asia/Yerevan", "Canada/Yukon", "Europe/Zagreb", "Europe/Zaporozhye", "Etc/Zulu", "Zulu", "Europe/Zurich" ] }, "orderFulfillmentEnabled": { "type": "boolean" }, "orderFulfillmentUseSpecificRules": { "type": "boolean" }, "orderReturnsEnabled": { "type": "boolean" }, "orderReturnsUseSpecificRules": { "type": "boolean" }, "salesChannelAdmin": { "type": "boolean" }, "salesChannelOnline": { "type": "boolean" }, "salesChannelStore": { "type": "boolean" }, "fulfillmentRules": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "ruleType": { "type": "string", "enum": [ "fulfillment", "order_return" ] }, "purchaseType": { "type": "string", "enum": [ "booking", "sales", "subscription", "buyback" ] }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inStoreEnabled": { "type": "boolean" }, "shippingEnabled": { "type": "boolean" }, "localDeliveryEnabled": { "type": "boolean" } }, "required": [ "ruleType", "purchaseType" ], "additionalProperties": false } }, "tenantId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "archivedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "name", "isDefault", "isActive", "timezone", "tenantId", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/service-locations/{id}/default": { "put": { "summary": "Update the default service location", "tags": [ "inventory", "serviceLocations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.serviceLocations.setDefault", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/service-locations/{id}/set-is-active": { "put": { "summary": "Set the active status of a service location", "tags": [ "inventory", "serviceLocations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.serviceLocations.setIsActive", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "isActive": { "type": "boolean" } }, "required": [ "isActive" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/service-locations/set-is-active-many": { "post": { "summary": "Set the active status of many service locations", "tags": [ "inventory", "serviceLocations" ], "parameters": [], "operationId": "internal.inventory.serviceLocations.setIsActiveMany", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "isActive": { "type": "boolean" } }, "required": [ "ids", "isActive" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/service-locations/{id}/duplicate": { "post": { "summary": "Duplicate a service location", "tags": [ "inventory", "serviceLocations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.serviceLocations.duplicate", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" } }, "required": [ "count" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/service-locations/{id}/copy-settings": { "post": { "summary": "Copy settings to a service location", "tags": [ "inventory", "serviceLocations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.serviceLocations.copySettings", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "targetLocationIds": { "type": "array", "items": { "type": "string" } }, "settingsToCopy": { "type": "array", "items": { "type": "string", "enum": [ "name", "description", "address", "country", "state", "city", "street", "zipCode", "email", "phone", "timezone", "salesChannelAdmin", "salesChannelOnline", "salesChannelStore", "fulfillment", "order_return", "regular_opening_hours", "exception_opening_hours", "seasonal_opening_hours" ] } } }, "required": [ "targetLocationIds", "settingsToCopy" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/service-locations/{id}/archive": { "put": { "summary": "Archive a service location", "tags": [ "inventory", "serviceLocations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.serviceLocations.archive", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/service-locations/archive-many": { "post": { "summary": "Archive many service locations", "tags": [ "inventory", "serviceLocations" ], "parameters": [], "operationId": "internal.inventory.serviceLocations.archiveMany", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } }, "required": [ "ids" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/service-locations/{id}/opening-hours/{openingHoursId}": { "delete": { "summary": "Delete opening hours for a service location", "tags": [ "inventory", "serviceLocations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "openingHoursId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.serviceLocations.deleteOpeningHours", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/tags": { "get": { "summary": "Get all tags", "tags": [ "inventory", "tags" ], "parameters": [ { "name": "resource", "in": "query", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.tags.list", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "post": { "summary": "Create a new tag", "tags": [ "inventory", "tags" ], "parameters": [], "operationId": "internal.inventory.tags.create", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string" }, "resource": { "type": "string" }, "catalogItemId": { "type": "string" } }, "required": [ "value", "resource" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "string" }, "resource": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "value", "resource", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/tags/{id}": { "get": { "summary": "Get tag by id", "tags": [ "inventory", "tags" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.tags.get", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "put": { "summary": "Update a tag", "tags": [ "inventory", "tags" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.tags.update", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string" }, "resource": { "type": "string" }, "catalogItemId": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "string" }, "resource": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "value", "resource", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete a tag", "tags": [ "inventory", "tags" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.tags.delete", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/collections": { "get": { "summary": "List collections", "tags": [ "inventory", "collections" ], "parameters": [], "operationId": "internal.inventory.collections.list", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "type": { "type": "string", "enum": [ "manual", "smart" ] }, "tagMatchType": { "type": "string", "enum": [ "all", "any" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "catalogItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "collectionId": { "type": "string" }, "catalogItemId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "collectionId", "catalogItemId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "smartConditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "collectionId": { "type": "string" }, "tagId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "tag": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "string" }, "resource": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "value", "resource", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "id", "collectionId", "tagId", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "id", "title", "description", "type", "tagMatchType" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "post": { "summary": "Create collection", "tags": [ "inventory", "collections" ], "parameters": [], "operationId": "internal.inventory.collections.create", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "manual", "smart" ] }, "tagMatchType": { "type": "string", "enum": [ "all", "any" ] } }, "required": [ "title", "type" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "type": { "type": "string", "enum": [ "manual", "smart" ] }, "tagMatchType": { "type": "string", "enum": [ "all", "any" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "catalogItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "collectionId": { "type": "string" }, "catalogItemId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "collectionId", "catalogItemId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "smartConditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "collectionId": { "type": "string" }, "tagId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "tag": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "string" }, "resource": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "value", "resource", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "id", "collectionId", "tagId", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "id", "title", "description", "type", "tagMatchType" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/collections/{id}": { "get": { "summary": "Get collection by ID", "tags": [ "inventory", "collections" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.collections.get", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "type": { "type": "string", "enum": [ "manual", "smart" ] }, "tagMatchType": { "type": "string", "enum": [ "all", "any" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "catalogItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "collectionId": { "type": "string" }, "catalogItemId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "collectionId", "catalogItemId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "smartConditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "collectionId": { "type": "string" }, "tagId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "tag": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "string" }, "resource": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "value", "resource", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "id", "collectionId", "tagId", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "id", "title", "description", "type", "tagMatchType" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "patch": { "summary": "Update collection", "tags": [ "inventory", "collections" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.collections.update", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "manual", "smart" ] }, "tagMatchType": { "type": "string", "enum": [ "all", "any" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "type": { "type": "string", "enum": [ "manual", "smart" ] }, "tagMatchType": { "type": "string", "enum": [ "all", "any" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "catalogItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "collectionId": { "type": "string" }, "catalogItemId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "collectionId", "catalogItemId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "smartConditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "collectionId": { "type": "string" }, "tagId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "tag": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "string" }, "resource": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "value", "resource", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "id", "collectionId", "tagId", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "id", "title", "description", "type", "tagMatchType" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete collection", "tags": [ "inventory", "collections" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.collections.delete", "responses": { "204": { "description": "204" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/collections/{id}/items": { "post": { "summary": "Add catalog item to collection", "tags": [ "inventory", "collections" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.collections.addCatalogItem", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "catalogItemId": { "type": "string" } }, "required": [ "catalogItemId" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "collectionId": { "type": "string" }, "catalogItemId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "collectionId", "catalogItemId", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete catalog item from collection", "tags": [ "inventory", "collections" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "catalogItemId", "in": "query", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.collections.deleteCatalogItem", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/collections/{id}/conditions": { "post": { "summary": "Add smart condition to collection", "tags": [ "inventory", "collections" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.collections.addSmartCondition", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "tagId": { "type": "string" } }, "required": [ "tagId" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "collectionId": { "type": "string" }, "tagId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "tag": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "string" }, "resource": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "value", "resource", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "id", "collectionId", "tagId", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/collections/{id}/conditions/{tagId}": { "patch": { "summary": "Update smart condition in collection", "tags": [ "inventory", "collections" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.collections.updateSmartCondition", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "updatedTagId": { "type": "string" } }, "required": [ "updatedTagId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "collectionId": { "type": "string" }, "tagId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "tag": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "string" }, "resource": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "value", "resource", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "id", "collectionId", "tagId", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete smart condition from collection", "tags": [ "inventory", "collections" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.collections.deleteSmartCondition", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/collections/{id}/catalog-items": { "get": { "summary": "List catalog items for collection", "tags": [ "inventory", "collections" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.collections.listCatalogItems", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/variants/{catalogItemId}": { "get": { "summary": "Get all variants for a catalog item", "tags": [ "inventory", "variants" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.variants.list", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "post": { "summary": "Create a new variant for a catalog item", "tags": [ "inventory", "variants" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.variants.create", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "orderIndex": { "type": "number" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "type": "string" }, "orderIndex": { "type": "number" } }, "required": [ "id", "variantId", "value", "orderIndex" ], "additionalProperties": false } } }, "required": [ "id", "catalogItemId", "name", "orderIndex" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/variants/{catalogItemId}/{variantId}": { "delete": { "summary": "Delete a variant for a catalog item", "tags": [ "inventory", "variants" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "variantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.variants.delete", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "put": { "summary": "Update a variant for a catalog item", "tags": [ "inventory", "variants" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "variantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.variants.update", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "string" } }, "required": [ "value" ], "additionalProperties": false } } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/variants/{catalogItemId}/reorder": { "post": { "summary": "Reorder variants for a catalog item", "tags": [ "inventory", "variants" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.inventory.variants.reorder", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "variantIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "variantIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/inventory/variants/{catalogItemId}/values/{variantId}": { "post": { "summary": "Create new values for a variant", "tags": [ "inventory", "variants" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "variantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.variants.createValues", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "values" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "get": { "summary": "Get all values for a variant", "tags": [ "inventory", "variants" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "variantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.inventory.variants.getValues", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete a value for a variant", "tags": [ "inventory", "variants" ], "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "variantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "valueIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "operationId": "internal.inventory.variants.deleteValues", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/auth/email-verification-code": { "post": { "summary": "Send email verification code to user", "tags": [ "auth" ], "parameters": [], "operationId": "internal.auth.sendEmailVerificationCode", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "email" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/auth/email-verification-code/verify": { "post": { "summary": "Verify email verification code", "tags": [ "auth" ], "parameters": [], "operationId": "internal.auth.verifyEmailVerificationCode", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "code", "email" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" } }, "required": [ "token" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/auth/login-method/verify": { "post": { "summary": "Verify user login method", "tags": [ "auth" ], "parameters": [], "operationId": "internal.auth.verifyLoginMethod", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "uid": { "type": "string" }, "method": { "type": "string", "enum": [ "email_password", "google", "microsoft", "facebook" ] } }, "required": [ "uid", "method" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "validMethods": { "type": "array", "items": { "type": "string", "enum": [ "email_password", "google", "microsoft", "facebook" ] } } }, "required": [ "valid", "validMethods" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/auth/credential-auto-link": { "post": { "summary": "Attempt credential auto-linking", "tags": [ "auth" ], "parameters": [], "operationId": "internal.auth.credentialAutoLink", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "oauthIdToken": { "type": "string" }, "loginMethod": { "type": "string", "enum": [ "email_password", "google", "microsoft", "facebook" ] }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "oauthIdToken", "loginMethod", "email" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "token": { "nullable": true, "type": "string" } }, "required": [ "success", "token" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/users/invite": { "post": { "summary": "Invite users to merchant account", "tags": [ "users" ], "parameters": [], "operationId": "internal.users.invite", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "access": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "manager", "editor", "member" ] } }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "modify_payments", "allow_overbookings", "edit_booking", "cancel_booking", "home_chart", "edit_article_status", "sensitive_data" ] } }, "restrictions": { "type": "array", "items": { "type": "string", "enum": [ "modify_payments", "allow_overbookings", "edit_booking", "cancel_booking", "home_chart", "edit_article_status", "sensitive_data" ] } }, "storeIds": { "nullable": true, "type": "array", "items": { "type": "string" } } }, "required": [ "roles" ], "additionalProperties": false } }, "required": [ "emails", "access" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "failed": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/users/invite/verify": { "post": { "summary": "Verify user invitation, returns verification token", "tags": [ "users" ], "parameters": [], "operationId": "internal.users.verifyInvite", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "email": { "type": "string" }, "merchantName": { "type": "string" }, "loginMethods": { "type": "array", "items": { "type": "string", "enum": [ "email_password", "google", "microsoft", "facebook" ] } } }, "required": [ "token", "email", "merchantName" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/users/invite/mark-used": { "post": { "summary": "Marks invite as used", "tags": [ "users" ], "parameters": [], "operationId": "internal.users.markInviteUsed", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/users/invite/resend": { "post": { "summary": "Resends user invite", "tags": [ "users" ], "parameters": [], "operationId": "internal.users.resendInvite", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/reports/orders/revenue": { "get": { "summary": "Get order revenue data", "tags": [ "reports" ], "parameters": [ { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, { "name": "precision", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "enum": [ "day" ] }, { "type": "string", "enum": [ "month" ] } ] } }, { "name": "timezone", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": true, "schema": { "type": "string", "minLength": 3, "maxLength": 3 } }, { "name": "locationId", "in": "query", "schema": { "type": "string" } }, { "name": "channel", "in": "query", "schema": { "type": "string", "enum": [ "ADMIN", "STORE", "ONLINE", "PAYLINK", "CONSUMER", "API", "WIX" ] } } ], "operationId": "internal.reports.getOrderRevenue", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/paymentAccounts/adyen/": { "post": { "summary": "Create Adyen payment account", "tags": [ "paymentAccounts", "adyen" ], "parameters": [], "operationId": "internal.paymentAccounts.adyen.createPaymentAccount", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/paymentAccounts/adyen/accountHolder": { "get": { "tags": [ "paymentAccounts", "adyen" ], "parameters": [], "operationId": "internal.paymentAccounts.adyen.getAccountHolder", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/paymentAccounts/adyen/payoutCycle": { "get": { "tags": [ "paymentAccounts", "adyen" ], "parameters": [], "operationId": "internal.paymentAccounts.adyen.getPayoutCycle", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "put": { "tags": [ "paymentAccounts", "adyen" ], "parameters": [], "operationId": "internal.paymentAccounts.adyen.updatePayoutCycle", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "payoutCycle": { "type": "string", "enum": [ "daily", "weekly", "monthly", "hold" ] } }, "required": [ "payoutCycle" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/paymentAccounts/adyen/paymentMethods": { "get": { "tags": [ "paymentAccounts", "adyen" ], "parameters": [], "operationId": "internal.paymentAccounts.adyen.getPaymentMethods", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/paymentAccounts/adyen/paymentMethods/enable": { "post": { "tags": [ "paymentAccounts", "adyen" ], "parameters": [], "operationId": "internal.paymentAccounts.adyen.enablePaymentMethod", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "CARD_ONLINE", "TRUSTLY", "PAYTRAIL", "MOBILEPAY" ] } }, "required": [ "method" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/paymentAccounts/adyen/onboardingLink": { "post": { "tags": [ "paymentAccounts", "adyen" ], "parameters": [], "operationId": "internal.paymentAccounts.adyen.createOnboardingLink", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "navigatorLocale": { "type": "string" }, "redirectUrl": { "type": "string" } }, "required": [ "navigatorLocale", "redirectUrl" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/orders/{orderId}": { "get": { "summary": "Get an order by ID", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "firestoreId", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "internal.orders.getOrder", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "number": { "type": "number" }, "state": { "type": "string", "enum": [ "draft", "open", "active", "completed", "cancelled" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "updatedBy": { "type": "string" }, "channel": { "type": "string" }, "validFrom": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "validTo": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "assignedTo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "currentlyViewing": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "tags": { "type": "array", "items": { "type": "string" } }, "pickupLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "returnLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "mainContact": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "crmCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "firstName", "fullName", "email", "crmCustomerId" ], "additionalProperties": false }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "name", "type", "ids" ], "additionalProperties": false } }, "crmCustomerId": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "firstName", "fullName" ], "additionalProperties": false } }, "payment": {}, "deposit": {}, "pricing": {}, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "variants": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantValueId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantLabel": { "type": "string" }, "variantValueLabel": { "type": "string" } }, "required": [ "variantId", "variantValueId", "variantLabel", "variantValueLabel" ], "additionalProperties": false } }, "orderCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricing": {}, "duration": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "returnedDate": { "type": "string" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "imageUrl": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "name", "pricing" ], "additionalProperties": false } }, "stockItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "type": "string" }, "code": { "type": "string" }, "codeType": { "type": "string", "enum": [ "suggested", "confirmed" ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "lineItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inventoryArticleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pickupServiceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "pickupDate": { "type": "string" }, "returnServiceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "returnDate": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] } }, "required": [ "id", "createdAt", "updatedAt", "name", "lineItemId", "fulfillmentState" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "type": { "type": "string", "enum": [ "email", "document" ] }, "name": { "type": "string" }, "fileRef": { "type": "string" } }, "required": [ "id", "type" ], "additionalProperties": false } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "authorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "authorType": { "type": "string", "enum": [ "system", "user" ] }, "content": { "type": "string" }, "parentCommentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "author": { "nullable": true, "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "authorType", "content", "author" ], "additionalProperties": false } } }, "required": [ "id", "number", "state", "createdAt", "updatedAt", "channel", "currentlyViewing", "pickupLocation", "returnLocation", "customers", "payment", "deposit", "pricing", "lineItems", "stockItems", "documents", "comments" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "500": { "description": "500" } } }, "patch": { "summary": "Update order main details", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.orders.updateOrderDetails", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "draft", "open", "active", "completed", "cancelled" ] }, "assignedTo": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "tags": { "type": "array", "items": { "type": "string" } }, "mainContact": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "customerId" ], "additionalProperties": false }, { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "homeAddress": { "type": "object", "additionalProperties": {} }, "accommodation": { "type": "string" }, "language": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "description": "attribute_value", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "firstName", "email", "marketingConsent" ], "additionalProperties": false } ] }, "validFrom": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "validTo": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "number": { "type": "number" }, "state": { "type": "string", "enum": [ "draft", "open", "active", "completed", "cancelled" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "updatedBy": { "type": "string" }, "channel": { "type": "string" }, "validFrom": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "validTo": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "assignedTo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "currentlyViewing": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "tags": { "type": "array", "items": { "type": "string" } }, "pickupLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "returnLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "mainContact": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "crmCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "firstName", "fullName", "email", "crmCustomerId" ], "additionalProperties": false }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "name", "type", "ids" ], "additionalProperties": false } }, "crmCustomerId": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "firstName", "fullName" ], "additionalProperties": false } }, "payment": {}, "deposit": {}, "pricing": {}, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "variants": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantValueId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantLabel": { "type": "string" }, "variantValueLabel": { "type": "string" } }, "required": [ "variantId", "variantValueId", "variantLabel", "variantValueLabel" ], "additionalProperties": false } }, "orderCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricing": {}, "duration": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "returnedDate": { "type": "string" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "imageUrl": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "name", "pricing" ], "additionalProperties": false } }, "stockItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "type": "string" }, "code": { "type": "string" }, "codeType": { "type": "string", "enum": [ "suggested", "confirmed" ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "lineItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inventoryArticleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pickupServiceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "pickupDate": { "type": "string" }, "returnServiceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "returnDate": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] } }, "required": [ "id", "createdAt", "updatedAt", "name", "lineItemId", "fulfillmentState" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "type": { "type": "string", "enum": [ "email", "document" ] }, "name": { "type": "string" }, "fileRef": { "type": "string" } }, "required": [ "id", "type" ], "additionalProperties": false } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "authorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "authorType": { "type": "string", "enum": [ "system", "user" ] }, "content": { "type": "string" }, "parentCommentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "author": { "nullable": true, "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "authorType", "content", "author" ], "additionalProperties": false } } }, "required": [ "id", "number", "state", "createdAt", "updatedAt", "channel", "currentlyViewing", "pickupLocation", "returnLocation", "customers", "payment", "deposit", "pricing", "lineItems", "stockItems", "documents", "comments" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/orders/article/{articleId}": { "get": { "summary": "Get orders for an article", "tags": [ "orders" ], "parameters": [ { "name": "articleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.orders.getOrdersForArticle", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/orders": { "get": { "summary": "Get all orders", "tags": [ "orders" ], "parameters": [ { "name": "serviceLocationIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "operationId": "internal.orders.getOrders", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "number": { "type": "number" }, "state": { "type": "string", "enum": [ "draft", "open", "active", "completed", "cancelled" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "updatedBy": { "type": "string" }, "channel": { "type": "string" }, "validFrom": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "validTo": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "assignedTo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "currentlyViewing": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "tags": { "type": "array", "items": { "type": "string" } }, "pickupLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "returnLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "mainContact": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "crmCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "firstName", "fullName", "email", "crmCustomerId" ], "additionalProperties": false }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "name", "type", "ids" ], "additionalProperties": false } }, "crmCustomerId": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "firstName", "fullName" ], "additionalProperties": false } }, "payment": {}, "deposit": {}, "pricing": {}, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "variants": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantValueId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantLabel": { "type": "string" }, "variantValueLabel": { "type": "string" } }, "required": [ "variantId", "variantValueId", "variantLabel", "variantValueLabel" ], "additionalProperties": false } }, "orderCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricing": {}, "duration": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "returnedDate": { "type": "string" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "imageUrl": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "name", "pricing" ], "additionalProperties": false } }, "stockItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "type": "string" }, "code": { "type": "string" }, "codeType": { "type": "string", "enum": [ "suggested", "confirmed" ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "lineItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inventoryArticleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pickupServiceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "pickupDate": { "type": "string" }, "returnServiceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "returnDate": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] } }, "required": [ "id", "createdAt", "updatedAt", "name", "lineItemId", "fulfillmentState" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "type": { "type": "string", "enum": [ "email", "document" ] }, "name": { "type": "string" }, "fileRef": { "type": "string" } }, "required": [ "id", "type" ], "additionalProperties": false } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "authorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "authorType": { "type": "string", "enum": [ "system", "user" ] }, "content": { "type": "string" }, "parentCommentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "author": { "nullable": true, "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "authorType", "content", "author" ], "additionalProperties": false } } }, "required": [ "id", "number", "state", "createdAt", "updatedAt", "channel", "currentlyViewing", "pickupLocation", "returnLocation", "customers", "payment", "deposit", "pricing", "lineItems", "stockItems", "documents", "comments" ], "additionalProperties": false } }, "totalCount": { "type": "number" } }, "required": [ "data", "totalCount" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "500": { "description": "500" } } }, "post": { "summary": "Create a new order", "tags": [ "orders" ], "parameters": [], "operationId": "internal.orders.createOrder", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string", "enum": [ "admin", "api" ] }, "assignedTo": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "tags": { "type": "array", "items": { "type": "string" } }, "mainContact": { "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "customerId" ], "additionalProperties": false }, { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "homeAddress": { "type": "object", "additionalProperties": {} }, "accommodation": { "type": "string" }, "language": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "description": "attribute_value", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "firstName", "email", "marketingConsent" ], "additionalProperties": false } ] }, "lineItems": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "price": { "type": "number" }, "stockItems": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "inventoryArticleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "inventoryArticleId" ], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } ] } }, "startDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "quantity": { "type": "number" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] } }, "required": [ "name", "price", "quantity", "purchaseType" ], "additionalProperties": false }, { "type": "object", "properties": { "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "selectedVariants": { "nullable": true, "type": "object", "additionalProperties": { "type": "string" } }, "startDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "pricingRowId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "price": { "description": "Optional price override - calculates price from pricingRowId by default", "type": "number" }, "checkoutRequirementValues": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "quantity": { "type": "number" } }, "required": [ "catalogItemId", "pricingRowId", "purchaseType", "quantity" ], "additionalProperties": false } ] } }, "customers": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "lineItems": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "price": { "type": "number" }, "stockItems": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "inventoryArticleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "inventoryArticleId" ], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } ] } }, "startDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "quantity": { "type": "number" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] } }, "required": [ "name", "price", "quantity", "purchaseType" ], "additionalProperties": false }, { "type": "object", "properties": { "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "selectedVariants": { "nullable": true, "type": "object", "additionalProperties": { "type": "string" } }, "startDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "pricingRowId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "price": { "description": "Optional price override - calculates price from pricingRowId by default", "type": "number" }, "checkoutRequirementValues": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "quantity": { "type": "number" } }, "required": [ "catalogItemId", "pricingRowId", "purchaseType", "quantity" ], "additionalProperties": false } ] } } }, "required": [ "customerId" ], "additionalProperties": false }, { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "lineItems": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "price": { "type": "number" }, "stockItems": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "inventoryArticleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "inventoryArticleId" ], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } ] } }, "startDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "quantity": { "type": "number" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] } }, "required": [ "name", "price", "quantity", "purchaseType" ], "additionalProperties": false }, { "type": "object", "properties": { "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "selectedVariants": { "nullable": true, "type": "object", "additionalProperties": { "type": "string" } }, "startDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "pricingRowId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "price": { "description": "Optional price override - calculates price from pricingRowId by default", "type": "number" }, "checkoutRequirementValues": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "quantity": { "type": "number" } }, "required": [ "catalogItemId", "pricingRowId", "purchaseType", "quantity" ], "additionalProperties": false } ] } } }, "required": [ "firstName" ], "additionalProperties": false } ] } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "author": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "content": { "type": "string" }, "parentCommentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "content" ], "additionalProperties": false } }, "pickupLocation": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "returnLocation": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "state": { "type": "string", "enum": [ "draft", "open", "active", "completed", "cancelled" ] } }, "required": [ "channel", "pickupLocation", "state" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "number": { "type": "number" }, "state": { "type": "string", "enum": [ "draft", "open", "active", "completed", "cancelled" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "updatedBy": { "type": "string" }, "channel": { "type": "string" }, "validFrom": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "validTo": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "assignedTo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "currentlyViewing": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "tags": { "type": "array", "items": { "type": "string" } }, "pickupLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "returnLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "mainContact": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "crmCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "firstName", "fullName", "email", "crmCustomerId" ], "additionalProperties": false }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "name", "type", "ids" ], "additionalProperties": false } }, "crmCustomerId": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "firstName", "fullName" ], "additionalProperties": false } }, "payment": {}, "deposit": {}, "pricing": {}, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "variants": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantValueId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantLabel": { "type": "string" }, "variantValueLabel": { "type": "string" } }, "required": [ "variantId", "variantValueId", "variantLabel", "variantValueLabel" ], "additionalProperties": false } }, "orderCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricing": {}, "duration": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "returnedDate": { "type": "string" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "imageUrl": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "name", "pricing" ], "additionalProperties": false } }, "stockItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "type": "string" }, "code": { "type": "string" }, "codeType": { "type": "string", "enum": [ "suggested", "confirmed" ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "lineItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inventoryArticleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pickupServiceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "pickupDate": { "type": "string" }, "returnServiceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "returnDate": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] } }, "required": [ "id", "createdAt", "updatedAt", "name", "lineItemId", "fulfillmentState" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "type": { "type": "string", "enum": [ "email", "document" ] }, "name": { "type": "string" }, "fileRef": { "type": "string" } }, "required": [ "id", "type" ], "additionalProperties": false } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "authorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "authorType": { "type": "string", "enum": [ "system", "user" ] }, "content": { "type": "string" }, "parentCommentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "author": { "nullable": true, "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "authorType", "content", "author" ], "additionalProperties": false } } }, "required": [ "id", "number", "state", "createdAt", "updatedAt", "channel", "currentlyViewing", "pickupLocation", "returnLocation", "customers", "payment", "deposit", "pricing", "lineItems", "stockItems", "documents", "comments" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/orders/{orderId}/lineItems": { "post": { "summary": "Add item to order", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.orders.addLineItem", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "variants": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantValueId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantLabel": { "type": "string" }, "variantValueLabel": { "type": "string" } }, "required": [ "variantId", "variantValueId", "variantLabel", "variantValueLabel" ], "additionalProperties": false } }, "orderCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricing": {}, "duration": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "returnedDate": { "type": "string" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "imageUrl": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "name", "pricing" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/orders/{orderId}/lineItems/create-many": { "post": { "summary": "Add many items to order", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.orders.addManyLineItems", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/orders/{orderId}/lineItems/{lineItemId}": { "put": { "summary": "Update order item", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "lineItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.orders.updateLineItem", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "orderCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "number" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] }, "checkoutRequirementValues": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "variants": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantValueId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantLabel": { "type": "string" }, "variantValueLabel": { "type": "string" } }, "required": [ "variantId", "variantValueId", "variantLabel", "variantValueLabel" ], "additionalProperties": false } }, "orderCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricing": {}, "duration": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "returnedDate": { "type": "string" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "imageUrl": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "name", "pricing" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Remove item from order", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "lineItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.orders.removeLineItem", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/orders/{orderId}/stockItems/{stockItemId}": { "put": { "summary": "Update article in order item", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "stockItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.orders.updateStockItem", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "inventoryArticleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "codeType": { "type": "string", "enum": [ "suggested", "confirmed" ] }, "pickupDate": { "type": "string" }, "returnDate": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "type": "string" }, "code": { "type": "string" }, "codeType": { "type": "string", "enum": [ "suggested", "confirmed" ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "lineItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inventoryArticleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pickupServiceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "pickupDate": { "type": "string" }, "returnServiceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "returnDate": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] } }, "required": [ "id", "createdAt", "updatedAt", "name", "lineItemId", "fulfillmentState" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Remove article from order item", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "stockItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.orders.removeStockItem", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/orders/{orderId}/customers": { "post": { "summary": "Add customer to order", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.orders.addCustomer", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "name", "type", "ids" ], "additionalProperties": false } }, "crmCustomerId": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "firstName", "fullName" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/orders/{orderId}/customers/{customerId}": { "put": { "summary": "Update customer in order", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.orders.updateCustomer", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "name", "type", "ids" ], "additionalProperties": false } }, "crmCustomerId": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "firstName", "fullName" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Remove customer from order", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.orders.removeCustomer", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/orders/{orderId}/comments": { "post": { "summary": "Add comment to order", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.orders.addComment", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "author": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "content": { "type": "string" }, "parentCommentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "content" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "authorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "authorType": { "type": "string", "enum": [ "system", "user" ] }, "content": { "type": "string" }, "parentCommentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "author": { "nullable": true, "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "authorType", "content", "author" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/orders/{orderId}/comments/{commentId}": { "put": { "summary": "Update comment in order", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "commentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.orders.updateComment", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string" } }, "required": [ "content" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "authorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "authorType": { "type": "string", "enum": [ "system", "user" ] }, "content": { "type": "string" }, "parentCommentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "author": { "nullable": true, "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "authorType", "content", "author" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Remove comment from order", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "commentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.orders.removeComment", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/orders/{orderId}/batch": { "patch": { "summary": "Update multple order data resources in a single request", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.orders.updateOrderBulk", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "orderDetails": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "update" ] }, "data": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "draft", "open", "active", "completed", "cancelled" ] }, "assignedTo": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "tags": { "type": "array", "items": { "type": "string" } }, "mainContact": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "customerId" ], "additionalProperties": false }, { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "homeAddress": { "type": "object", "additionalProperties": {} }, "accommodation": { "type": "string" }, "language": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "description": "attribute_value", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "firstName", "email", "marketingConsent" ], "additionalProperties": false } ] }, "validFrom": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "validTo": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "additionalProperties": false } }, "required": [ "type", "data" ], "additionalProperties": false }, "lineItems": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "data": { "type": "object", "properties": { "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "orderCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "number" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] }, "checkoutRequirementValues": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false } }, "required": [ "type", "id", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "create" ] }, "data": { "anyOf": [ { "type": "object", "properties": { "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "orderCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "number" }, "stockItems": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "inventoryArticleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "inventoryArticleId" ], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } ] } }, "startDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "quantity": { "type": "number" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] } }, "required": [ "name", "price", "quantity", "purchaseType" ], "additionalProperties": false }, { "type": "object", "properties": { "orderCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "selectedVariants": { "nullable": true, "type": "object", "additionalProperties": { "type": "string" } }, "startDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "pricingRowId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "price": { "description": "Optional price override - calculates price from pricingRowId by default", "type": "number" }, "checkoutRequirementValues": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "quantity": { "type": "number" } }, "required": [ "catalogItemId", "pricingRowId", "purchaseType", "quantity" ], "additionalProperties": false } ] } }, "required": [ "type", "data" ], "additionalProperties": false } ] } }, "stockItems": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "data": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "inventoryArticleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "codeType": { "type": "string", "enum": [ "suggested", "confirmed" ] }, "pickupDate": { "type": "string" }, "returnDate": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] } }, "additionalProperties": false } }, "required": [ "type", "id", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "id" ], "additionalProperties": false } ] } }, "customers": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "data": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "additionalProperties": false } }, "required": [ "type", "id", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "create" ] }, "data": { "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "lineItems": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "price": { "type": "number" }, "stockItems": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "inventoryArticleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "inventoryArticleId" ], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } ] } }, "startDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "quantity": { "type": "number" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] } }, "required": [ "name", "price", "quantity", "purchaseType" ], "additionalProperties": false }, { "type": "object", "properties": { "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "selectedVariants": { "nullable": true, "type": "object", "additionalProperties": { "type": "string" } }, "startDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "pricingRowId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "price": { "description": "Optional price override - calculates price from pricingRowId by default", "type": "number" }, "checkoutRequirementValues": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "quantity": { "type": "number" } }, "required": [ "catalogItemId", "pricingRowId", "purchaseType", "quantity" ], "additionalProperties": false } ] } } }, "required": [ "customerId" ], "additionalProperties": false }, { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "lineItems": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "price": { "type": "number" }, "stockItems": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "inventoryArticleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "inventoryArticleId" ], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } ] } }, "startDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "quantity": { "type": "number" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] } }, "required": [ "name", "price", "quantity", "purchaseType" ], "additionalProperties": false }, { "type": "object", "properties": { "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "selectedVariants": { "nullable": true, "type": "object", "additionalProperties": { "type": "string" } }, "startDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "pricingRowId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "price": { "description": "Optional price override - calculates price from pricingRowId by default", "type": "number" }, "checkoutRequirementValues": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "quantity": { "type": "number" } }, "required": [ "catalogItemId", "pricingRowId", "purchaseType", "quantity" ], "additionalProperties": false } ] } } }, "required": [ "firstName" ], "additionalProperties": false } ] } }, "required": [ "type", "data" ], "additionalProperties": false } ] } }, "comments": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "data": { "type": "object", "properties": { "content": { "type": "string" } }, "required": [ "content" ], "additionalProperties": false } }, "required": [ "type", "id", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "create" ] }, "data": { "type": "object", "properties": { "author": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "content": { "type": "string" }, "parentCommentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "content" ], "additionalProperties": false } }, "required": [ "type", "data" ], "additionalProperties": false } ] } } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "number": { "type": "number" }, "state": { "type": "string", "enum": [ "draft", "open", "active", "completed", "cancelled" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "updatedBy": { "type": "string" }, "channel": { "type": "string" }, "validFrom": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "validTo": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "assignedTo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "currentlyViewing": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "tags": { "type": "array", "items": { "type": "string" } }, "pickupLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "returnLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "mainContact": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "crmCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "firstName", "fullName", "email", "crmCustomerId" ], "additionalProperties": false }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "name", "type", "ids" ], "additionalProperties": false } }, "crmCustomerId": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "firstName", "fullName" ], "additionalProperties": false } }, "payment": {}, "deposit": {}, "pricing": {}, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "variants": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantValueId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantLabel": { "type": "string" }, "variantValueLabel": { "type": "string" } }, "required": [ "variantId", "variantValueId", "variantLabel", "variantValueLabel" ], "additionalProperties": false } }, "orderCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricing": {}, "duration": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "returnedDate": { "type": "string" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "imageUrl": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "name", "pricing" ], "additionalProperties": false } }, "stockItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "type": "string" }, "code": { "type": "string" }, "codeType": { "type": "string", "enum": [ "suggested", "confirmed" ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "lineItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inventoryArticleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pickupServiceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "pickupDate": { "type": "string" }, "returnServiceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "returnDate": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] } }, "required": [ "id", "createdAt", "updatedAt", "name", "lineItemId", "fulfillmentState" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "type": { "type": "string", "enum": [ "email", "document" ] }, "name": { "type": "string" }, "fileRef": { "type": "string" } }, "required": [ "id", "type" ], "additionalProperties": false } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "authorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "authorType": { "type": "string", "enum": [ "system", "user" ] }, "content": { "type": "string" }, "parentCommentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "author": { "nullable": true, "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "authorType", "content", "author" ], "additionalProperties": false } } }, "required": [ "id", "number", "state", "createdAt", "updatedAt", "channel", "currentlyViewing", "pickupLocation", "returnLocation", "customers", "payment", "deposit", "pricing", "lineItems", "stockItems", "documents", "comments" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/customers/{customerId}": { "get": { "summary": "Get a customer by ID", "tags": [ "customers" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.customers.getCustomer", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": { "type": "object", "additionalProperties": {} }, "language": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "groupId": { "nullable": true, "type": "string" }, "systemGroup": { "nullable": true, "type": "string", "enum": [ "sustainability", "system" ] }, "origin": { "type": "string", "enum": [ "article", "sku", "customer" ] } }, "required": [ "id", "name", "key", "value", "format", "groupId", "systemGroup", "origin" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "customerId": { "type": "string" }, "document": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" }, "comment": { "nullable": true, "type": "string" } }, "required": [ "fileId", "customerId", "orderIndex", "comment" ], "additionalProperties": false } }, "aggregateData": { "type": "object", "properties": { "totalCount": { "type": "number" }, "lastCreated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "lastUpdated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "totalCount", "lastCreated", "lastUpdated" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "firstName", "fullName", "email", "marketingConsent", "aggregateData" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "500": { "description": "500" } } }, "patch": { "summary": "Update customer details", "tags": [ "customers" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.customers.updateCustomer", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "homeAddress": { "type": "object", "additionalProperties": {} }, "accommodation": { "type": "string" }, "language": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "description": "attribute_value", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "string", "nullable": true, "enum": [ null ] } ] } } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": { "type": "object", "additionalProperties": {} }, "language": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "groupId": { "nullable": true, "type": "string" }, "systemGroup": { "nullable": true, "type": "string", "enum": [ "sustainability", "system" ] }, "origin": { "type": "string", "enum": [ "article", "sku", "customer" ] } }, "required": [ "id", "name", "key", "value", "format", "groupId", "systemGroup", "origin" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "customerId": { "type": "string" }, "document": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" }, "comment": { "nullable": true, "type": "string" } }, "required": [ "fileId", "customerId", "orderIndex", "comment" ], "additionalProperties": false } }, "aggregateData": { "type": "object", "properties": { "totalCount": { "type": "number" }, "lastCreated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "lastUpdated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "totalCount", "lastCreated", "lastUpdated" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "firstName", "fullName", "email", "marketingConsent", "aggregateData" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete a customer", "tags": [ "customers" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.customers.deleteCustomer", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/customers/{customerId}/orders": { "get": { "summary": "Get customer orders", "tags": [ "customers" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.customers.getCustomerOrders", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "500": { "description": "500" } } } }, "/internal/customers/{customerId}/listings": { "get": { "summary": "Get customer top listings", "tags": [ "customers" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.customers.getCustomerTopListings", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "itemCount": { "type": "number" }, "name": { "type": "string" } }, "required": [ "id", "itemCount", "name" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/customers/{customerId}/stock-items": { "get": { "summary": "Get customer top stock items", "tags": [ "customers" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.customers.getCustomerTopStockItems", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "itemCount": { "type": "number" }, "name": { "type": "string" } }, "required": [ "id", "itemCount", "name" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/customers": { "get": { "summary": "Get all customers", "tags": [ "customers" ], "parameters": [ { "name": "filters", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "customerIds": { "type": "array", "items": { "type": "string" } }, "search": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "createdAt": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "firstName": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "lastName": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "fullName": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "phone": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "email": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "marketingConsent": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "boolean" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "language": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "anyOf": [ { "type": "array", "items": { "type": "boolean" } }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "number" } } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime" ] } }, "required": [ "id", "operator", "value" ], "additionalProperties": false } }, "ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, { "name": "orderBy", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "attributeId": { "type": "string" }, "field": { "type": "string", "enum": [ "createdAt", "firstName", "lastName", "email", "phone", "marketingConsent", "language" ] }, "direction": { "type": "string", "enum": [ "asc", "desc" ] } }, "additionalProperties": false } }, { "name": "pagination", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "size": { "type": "number" }, "page": { "type": "number" } }, "required": [ "size", "page" ], "additionalProperties": false } } ], "operationId": "internal.customers.getCustomers", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": { "type": "object", "additionalProperties": {} }, "language": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "groupId": { "nullable": true, "type": "string" }, "systemGroup": { "nullable": true, "type": "string", "enum": [ "sustainability", "system" ] }, "origin": { "type": "string", "enum": [ "article", "sku", "customer" ] } }, "required": [ "id", "name", "key", "value", "format", "groupId", "systemGroup", "origin" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "customerId": { "type": "string" }, "document": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" }, "comment": { "nullable": true, "type": "string" } }, "required": [ "fileId", "customerId", "orderIndex", "comment" ], "additionalProperties": false } }, "aggregateData": { "type": "object", "properties": { "totalCount": { "type": "number" }, "lastCreated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "lastUpdated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "totalCount", "lastCreated", "lastUpdated" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "firstName", "fullName", "email", "marketingConsent", "aggregateData" ], "additionalProperties": false } }, "totalCount": { "type": "number" } }, "required": [ "data", "totalCount" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "500": { "description": "500" } } }, "post": { "summary": "Create a new customer", "tags": [ "customers" ], "parameters": [], "operationId": "internal.customers.createCustomer", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "homeAddress": { "type": "object", "additionalProperties": {} }, "accommodation": { "type": "string" }, "language": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "description": "attribute_value", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "firstName", "email", "marketingConsent" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": { "type": "object", "additionalProperties": {} }, "language": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "groupId": { "nullable": true, "type": "string" }, "systemGroup": { "nullable": true, "type": "string", "enum": [ "sustainability", "system" ] }, "origin": { "type": "string", "enum": [ "article", "sku", "customer" ] } }, "required": [ "id", "name", "key", "value", "format", "groupId", "systemGroup", "origin" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "fileId": { "type": "string" }, "customerId": { "type": "string" }, "document": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "fileUrl": { "type": "string" }, "mimeType": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" }, "size": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "nullable": true, "type": "string" }, "updatedById": { "nullable": true, "type": "string" }, "createdById": { "nullable": true, "type": "string" } }, "required": [ "id", "tenantId", "fileUrl", "mimeType", "originalName", "folderPath", "size", "createdAt", "updatedAt", "deletedAt", "updatedById", "createdById" ], "additionalProperties": false }, "orderIndex": { "type": "number" }, "comment": { "nullable": true, "type": "string" } }, "required": [ "fileId", "customerId", "orderIndex", "comment" ], "additionalProperties": false } }, "aggregateData": { "type": "object", "properties": { "totalCount": { "type": "number" }, "lastCreated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "lastUpdated": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "totalCount", "lastCreated", "lastUpdated" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "firstName", "fullName", "email", "marketingConsent", "aggregateData" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/customers/many": { "post": { "summary": "Create new customers", "tags": [ "customers" ], "parameters": [], "operationId": "internal.customers.createManyCustomers", "responses": { "201": { "description": "201", "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } }, "required": [ "ids" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/customers/delete": { "post": { "summary": "Delete many customers", "tags": [ "customers" ], "parameters": [], "operationId": "internal.customers.deleteManyCustomers", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/customers/validate-emails": { "post": { "summary": "Validate emails to ensure they are unique and valid", "tags": [ "customers" ], "parameters": [], "operationId": "internal.customers.validateEmails", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } } }, "required": [ "emails" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "invalid": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "reason": { "type": "string", "enum": [ "existing" ] } }, "required": [ "email", "reason" ], "additionalProperties": false } } }, "required": [ "invalid" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/customers/{customerId}/documents": { "post": { "summary": "Link documents to a customer", "tags": [ "customers" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.customers.linkDocuments", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "fileIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Unlink documents from a customer", "tags": [ "customers" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "fileIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } ], "operationId": "internal.customers.unlinkDocuments", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/customers/{customerId}/documents/reorder": { "put": { "summary": "Reorder customer documents", "tags": [ "customers" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.customers.reorderDocuments", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "fileIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/customers/{customerId}/documents/comment": { "post": { "summary": "Add a comment to a customer document", "tags": [ "customers" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.customers.addDocumentComment", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "comment": { "type": "string" } }, "required": [ "fileId", "comment" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/grouped": { "get": { "summary": "List customers grouped by field", "tags": [ "customers" ], "parameters": [ { "name": "filters", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "customerIds": { "type": "array", "items": { "type": "string" } }, "search": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "createdAt": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "firstName": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "lastName": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "fullName": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "phone": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "email": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "marketingConsent": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "boolean" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "language": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "value" ], "additionalProperties": false }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "value": { "anyOf": [ { "type": "array", "items": { "type": "boolean" } }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "number" } } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime" ] } }, "required": [ "id", "operator", "value" ], "additionalProperties": false } }, "ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, { "name": "orderBy", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "attributeId": { "type": "string" }, "field": { "type": "string", "enum": [ "createdAt", "firstName", "lastName", "email", "phone", "marketingConsent", "language" ] }, "direction": { "type": "string", "enum": [ "asc", "desc" ] } }, "additionalProperties": false } }, { "name": "pagination", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "size": { "type": "number" }, "page": { "type": "number" } }, "required": [ "size", "page" ], "additionalProperties": false } }, { "name": "groupFields", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "groupKeys", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "operationId": "internal.customers.listGrouped", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/api-keys/{apiKeyId}": { "get": { "summary": "Get an API key by ID", "tags": [ "apiKeys" ], "parameters": [ { "name": "apiKeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.apiKeys.getApiKey", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "label": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "label" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "500": { "description": "500" } } }, "patch": { "summary": "Update API key details", "tags": [ "apiKeys" ], "parameters": [ { "name": "apiKeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.apiKeys.updateApiKey", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string" }, "scopes": { "nullable": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "label": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "label" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete an API key", "tags": [ "apiKeys" ], "parameters": [ { "name": "apiKeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.apiKeys.deleteApiKey", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/api-keys": { "get": { "summary": "Get all API keys", "tags": [ "apiKeys" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "ids", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "operationId": "internal.apiKeys.getApiKeys", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "label": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "label" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "500": { "description": "500" } } }, "post": { "summary": "Create a new API key", "tags": [ "apiKeys" ], "parameters": [], "operationId": "internal.apiKeys.createApiKey", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string" } }, "label": { "type": "string" } }, "required": [ "label" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiKey": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "label": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "label" ], "additionalProperties": false }, "rawKey": { "type": "string" } }, "required": [ "apiKey", "rawKey" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/api-keys/delete": { "post": { "summary": "Delete many API keys", "tags": [ "apiKeys" ], "parameters": [], "operationId": "internal.apiKeys.deleteManyApiKeys", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/pg-users/me": { "get": { "summary": "Get user by id", "tags": [ "pgUsers" ], "parameters": [], "operationId": "internal.pgUsers.getOwnUser", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedBy": { "type": "string" }, "createdBy": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "avatarUrl": { "type": "string", "format": "uri" }, "phone": { "type": "string" }, "activeTenantId": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "activeTenantId" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "500": { "description": "500" } } } }, "/internal/files/create": { "post": { "summary": "Upload an file", "tags": [ "files" ], "parameters": [], "operationId": "internal.files.create", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/files/list": { "get": { "summary": "List all files", "tags": [ "files" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } } ], "operationId": "internal.files.list", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/files/delete-many": { "post": { "summary": "Delete many files", "tags": [ "files" ], "parameters": [], "operationId": "internal.files.deleteMany", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } }, "required": [ "ids" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/files/update-many": { "put": { "summary": "Update many files", "tags": [ "files" ], "parameters": [], "operationId": "internal.files.updateMany", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "updates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "originalName": { "type": "string" }, "folderPath": { "nullable": true, "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "updates" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/merchant": { "get": { "summary": "Get your own merchant data", "tags": [ "tenants" ], "parameters": [], "operationId": "internal.tenants.getTenant", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "name": { "type": "string" }, "email": { "type": "string" }, "businessId": { "type": "string" }, "languages": { "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 2 } }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2 }, "currencyCode": { "type": "string", "minLength": 3, "maxLength": 3 }, "currencySymbol": { "type": "string" }, "currencyPosition": { "type": "string", "enum": [ "prefix", "prefix-no-space", "suffix", "suffix-no-space" ] }, "taxExcluded": { "type": "boolean" }, "timezone": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Brazil/Acre", "Australia/ACT", "America/Adak", "Africa/Addis_Ababa", "Australia/Adelaide", "Asia/Aden", "US/Alaska", "US/Aleutian", "Africa/Algiers", "Asia/Almaty", "Asia/Amman", "Europe/Amsterdam", "Asia/Anadyr", "America/Anchorage", "Europe/Andorra", "America/Anguilla", "Indian/Antananarivo", "America/Antigua", "Pacific/Apia", "Asia/Aqtau", "Asia/Aqtobe", "America/Araguaina", "US/Arizona", "America/Aruba", "Asia/Ashgabat", "Asia/Ashkhabad", "Africa/Asmara", "Africa/Asmera", "Europe/Astrakhan", "America/Asuncion", "Europe/Athens", "America/Atikokan", "America/Atka", "Canada/Atlantic", "Asia/Atyrau", "Pacific/Auckland", "Atlantic/Azores", "Asia/Baghdad", "America/Bahia", "America/Bahia_Banderas", "Asia/Bahrain", "Mexico/BajaNorte", "Mexico/BajaSur", "Asia/Baku", "Africa/Bamako", "Asia/Bangkok", "Africa/Bangui", "Africa/Banjul", "America/Barbados", "Asia/Barnaul", "Asia/Beirut", "America/Belem", "Europe/Belfast", "Europe/Belgrade", "America/Belize", "Europe/Berlin", "Atlantic/Bermuda", "America/North_Dakota/Beulah", "Asia/Bishkek", "Africa/Bissau", "America/Blanc-Sablon", "Africa/Blantyre", "America/Boa_Vista", "America/Bogota", "America/Boise", "Pacific/Bougainville", "Europe/Bratislava", "Africa/Brazzaville", "Australia/Brisbane", "Australia/Broken_Hill", "Asia/Brunei", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "America/Buenos_Aires", "America/Argentina/Buenos_Aires", "Africa/Bujumbura", "Europe/Busingen", "Africa/Cairo", "Asia/Calcutta", "America/Cambridge_Bay", "America/Campo_Grande", "Atlantic/Canary", "Australia/Canberra", "America/Cancun", "Atlantic/Cape_Verde", "America/Caracas", "Africa/Casablanca", "Antarctica/Casey", "America/Catamarca", "America/Argentina/Catamarca", "America/Cayenne", "America/Cayman", "America/North_Dakota/Center", "US/Central", "Canada/Central", "CET", "Africa/Ceuta", "Indian/Chagos", "Pacific/Chatham", "America/Chicago", "America/Chihuahua", "Europe/Chisinau", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Indian/Christmas", "Asia/Chungking", "Pacific/Chuuk", "Indian/Cocos", "Asia/Colombo", "America/Argentina/ComodRivadavia", "Indian/Comoro", "Africa/Conakry", "Chile/Continental", "Europe/Copenhagen", "America/Coral_Harbour", "America/Cordoba", "America/Argentina/Cordoba", "America/Costa_Rica", "America/Creston", "CST6CDT", "Cuba", "America/Cuiaba", "America/Curacao", "Australia/Currie", "Asia/Dacca", "Africa/Dakar", "Asia/Damascus", "America/Danmarkshavn", "Africa/Dar_es_Salaam", "Australia/Darwin", "Antarctica/Davis", "America/Dawson", "America/Dawson_Creek", "Brazil/DeNoronha", "America/Denver", "America/Detroit", "Asia/Dhaka", "Asia/Dili", "Africa/Djibouti", "America/Dominica", "Africa/Douala", "Asia/Dubai", "Europe/Dublin", "Antarctica/DumontDUrville", "Asia/Dushanbe", "Brazil/East", "US/East-Indiana", "Pacific/Easter", "Chile/EasterIsland", "US/Eastern", "Canada/Eastern", "America/Edmonton", "EET", "Pacific/Efate", "Egypt", "Eire", "America/Eirunepe", "Africa/El_Aaiun", "America/El_Salvador", "Pacific/Enderbury", "America/Ensenada", "EST", "EST5EDT", "Australia/Eucla", "Atlantic/Faeroe", "Pacific/Fakaofo", "Asia/Famagusta", "Atlantic/Faroe", "Pacific/Fiji", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "Africa/Freetown", "Pacific/Funafuti", "Africa/Gaborone", "Pacific/Galapagos", "Pacific/Gambier", "Asia/Gaza", "GB", "GB-Eire", "Mexico/General", "Europe/Gibraltar", "America/Glace_Bay", "Etc/GMT", "GMT", "GMT-0", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT+0", "GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT0", "GMT0", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "Etc/Greenwich", "Greenwich", "America/Grenada", "Pacific/Guadalcanal", "America/Guadeloupe", "Pacific/Guam", "America/Guatemala", "America/Guayaquil", "Europe/Guernsey", "America/Guyana", "America/Halifax", "Africa/Harare", "Asia/Harbin", "America/Havana", "US/Hawaii", "Asia/Hebron", "Europe/Helsinki", "America/Hermosillo", "Asia/Ho_Chi_Minh", "Australia/Hobart", "Asia/Hong_Kong", "Hongkong", "Pacific/Honolulu", "Asia/Hovd", "HST", "Iceland", "US/Indiana-Starke", "America/Indiana/Indianapolis", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "Iran", "Asia/Irkutsk", "Europe/Isle_of_Man", "Israel", "Asia/Istanbul", "Europe/Istanbul", "Asia/Jakarta", "Jamaica", "America/Jamaica", "Atlantic/Jan_Mayen", "Japan", "Asia/Jayapura", "Europe/Jersey", "Asia/Jerusalem", "Africa/Johannesburg", "Pacific/Johnston", "Africa/Juba", "America/Jujuy", "America/Argentina/Jujuy", "America/Juneau", "Asia/Kabul", "Europe/Kaliningrad", "Asia/Kamchatka", "Africa/Kampala", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Indian/Kerguelen", "Asia/Khandyga", "Africa/Khartoum", "Europe/Kiev", "Africa/Kigali", "Africa/Kinshasa", "Pacific/Kiritimati", "Europe/Kirov", "America/Indiana/Knox", "America/Knox_IN", "Asia/Kolkata", "Pacific/Kosrae", "America/Kralendijk", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Kwajalein", "Pacific/Kwajalein", "America/La_Paz", "America/Argentina/La_Rioja", "Africa/Lagos", "Australia/LHI", "Africa/Libreville", "Libya", "America/Lima", "Australia/Lindeman", "Europe/Lisbon", "Europe/Ljubljana", "Africa/Lome", "Europe/London", "Arctic/Longyearbyen", "Australia/Lord_Howe", "America/Los_Angeles", "America/Louisville", "America/Kentucky/Louisville", "America/Lower_Princes", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Europe/Luxembourg", "Asia/Macao", "Asia/Macau", "America/Maceio", "Antarctica/Macquarie", "Atlantic/Madeira", "Europe/Madrid", "Asia/Magadan", "Indian/Mahe", "Pacific/Majuro", "Asia/Makassar", "Africa/Malabo", "Indian/Maldives", "Europe/Malta", "America/Managua", "America/Manaus", "Asia/Manila", "Africa/Maputo", "America/Indiana/Marengo", "Europe/Mariehamn", "America/Marigot", "Pacific/Marquesas", "America/Martinique", "Africa/Maseru", "America/Matamoros", "Indian/Mauritius", "Antarctica/Mawson", "Indian/Mayotte", "America/Mazatlan", "Africa/Mbabane", "Antarctica/McMurdo", "Australia/Melbourne", "America/Mendoza", "America/Argentina/Mendoza", "America/Menominee", "America/Merida", "MET", "America/Metlakatla", "America/Mexico_City", "US/Michigan", "Pacific/Midway", "Europe/Minsk", "America/Miquelon", "Africa/Mogadishu", "Europe/Monaco", "America/Moncton", "Africa/Monrovia", "America/Monterrey", "America/Montevideo", "America/Kentucky/Monticello", "America/Montreal", "America/Montserrat", "Europe/Moscow", "US/Mountain", "Canada/Mountain", "MST", "MST7MDT", "Asia/Muscat", "Africa/Nairobi", "America/Nassau", "Pacific/Nauru", "Navajo", "Africa/Ndjamena", "America/North_Dakota/New_Salem", "America/New_York", "Canada/Newfoundland", "Africa/Niamey", "Europe/Nicosia", "Asia/Nicosia", "America/Nipigon", "Pacific/Niue", "America/Nome", "Pacific/Norfolk", "America/Noronha", "Australia/North", "Africa/Nouakchott", "Pacific/Noumea", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Australia/NSW", "America/Nuuk", "NZ", "NZ-CHAT", "America/Ojinaga", "Asia/Omsk", "Asia/Oral", "Europe/Oslo", "Africa/Ouagadougou", "US/Pacific", "Canada/Pacific", "Pacific/Pago_Pago", "Pacific/Palau", "Antarctica/Palmer", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "Europe/Paris", "Australia/Perth", "America/Indiana/Petersburg", "Asia/Phnom_Penh", "America/Phoenix", "Pacific/Pitcairn", "Europe/Podgorica", "Pacific/Pohnpei", "Poland", "Pacific/Ponape", "Asia/Pontianak", "Pacific/Port_Moresby", "America/Port_of_Spain", "America/Port-au-Prince", "America/Porto_Acre", "America/Porto_Velho", "Africa/Porto-Novo", "Portugal", "Europe/Prague", "PRC", "PST8PDT", "America/Puerto_Rico", "America/Punta_Arenas", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Australia/Queensland", "Asia/Qyzylorda", "America/Rainy_River", "Asia/Rangoon", "America/Rankin_Inlet", "Pacific/Rarotonga", "America/Recife", "America/Regina", "America/Resolute", "Indian/Reunion", "Atlantic/Reykjavik", "Europe/Riga", "America/Rio_Branco", "America/Argentina/Rio_Gallegos", "Asia/Riyadh", "ROC", "ROK", "Europe/Rome", "America/Rosario", "Antarctica/Rothera", "Asia/Saigon", "Pacific/Saipan", "Asia/Sakhalin", "America/Argentina/Salta", "Europe/Samara", "Asia/Samarkand", "Pacific/Samoa", "US/Samoa", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "Europe/San_Marino", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "Africa/Sao_Tome", "Europe/Sarajevo", "Europe/Saratov", "Canada/Saskatchewan", "America/Scoresbysund", "Asia/Seoul", "Asia/Shanghai", "America/Shiprock", "Europe/Simferopol", "Asia/Singapore", "Singapore", "America/Sitka", "Europe/Skopje", "Europe/Sofia", "Australia/South", "Atlantic/South_Georgia", "Antarctica/South_Pole", "Asia/Srednekolymsk", "America/St_Barthelemy", "Atlantic/St_Helena", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "Atlantic/Stanley", "Europe/Stockholm", "America/Swift_Current", "Australia/Sydney", "Antarctica/Syowa", "Pacific/Tahiti", "Asia/Taipei", "Europe/Tallinn", "Pacific/Tarawa", "Asia/Tashkent", "Australia/Tasmania", "Asia/Tbilisi", "America/Tegucigalpa", "Asia/Tehran", "Asia/Tel_Aviv", "America/Indiana/Tell_City", "Asia/Thimbu", "Asia/Thimphu", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "Africa/Timbuktu", "Europe/Tirane", "Europe/Tiraspol", "Asia/Tokyo", "Asia/Tomsk", "Pacific/Tongatapu", "America/Toronto", "America/Tortola", "Africa/Tripoli", "Antarctica/Troll", "Pacific/Truk", "America/Argentina/Tucuman", "Africa/Tunis", "Turkey", "Etc/UCT", "UCT", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Europe/Ulyanovsk", "Etc/Universal", "Universal", "Asia/Urumqi", "America/Argentina/Ushuaia", "Asia/Ust-Nera", "UTC", "Etc/UTC", "Europe/Uzhgorod", "Europe/Vaduz", "America/Vancouver", "Europe/Vatican", "America/Indiana/Vevay", "Australia/Victoria", "Europe/Vienna", "Asia/Vientiane", "Europe/Vilnius", "America/Indiana/Vincennes", "America/Virgin", "Asia/Vladivostok", "Europe/Volgograd", "Antarctica/Vostok", "W-SU", "Pacific/Wake", "Pacific/Wallis", "Europe/Warsaw", "Brazil/West", "Australia/West", "WET", "America/Whitehorse", "America/Indiana/Winamac", "Africa/Windhoek", "America/Winnipeg", "America/Yakutat", "Asia/Yakutsk", "Australia/Yancowinna", "Asia/Yangon", "Pacific/Yap", "Asia/Yekaterinburg", "America/Yellowknife", "Asia/Yerevan", "Canada/Yukon", "Europe/Zagreb", "Europe/Zaporozhye", "Etc/Zulu", "Zulu", "Europe/Zurich" ] }, "dateFormat": { "type": "string", "enum": [ "DD.MM.YYYY", "MM/DD/YYYY", "YYYY-MM-DD" ] }, "timeFormat": { "type": "string", "enum": [ "HH:mm", "hh:mm A" ] }, "startOfDay": { "type": "string", "enum": [ "monday", "saturday", "sunday" ] }, "unitSystem": { "type": "string", "enum": [ "METRIC", "US", "UK", "AU" ] }, "termsOfServiceUrl": { "type": "string" }, "termsOfServiceName": { "type": "string" }, "privacyPolicyUrl": { "type": "string" }, "privacyPolicyName": { "type": "string" }, "cookieNotice": { "type": "string", "enum": [ "show_notice", "disable", "enable" ] }, "cookieNoticeEmbed": { "type": "string", "enum": [ "show_notice", "disable", "enable" ] }, "disableTwiceBranding": { "type": "boolean" }, "plugins": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "enum": [ "cloud_pos" ] }, "config": { "type": "object", "properties": { "triggerTypes": { "type": "array", "items": { "type": "string", "enum": [ "onOrderReceiptPrint", "onShopperReceiptPrint", "externalButton" ] } } }, "required": [ "triggerTypes" ], "additionalProperties": false } }, "required": [ "name", "config" ], "additionalProperties": false }, { "type": "object", "properties": { "config": { "type": "object", "properties": { "triggerTypes": { "type": "array", "items": { "type": "string", "enum": [ "onOrderReceiptPrint", "onShopperReceiptPrint", "externalButton" ] } } }, "required": [ "triggerTypes" ], "additionalProperties": false }, "name": { "type": "string", "enum": [ "tekso_pos" ] } }, "required": [ "config", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "custom_accounting_groups" ] }, "config": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "groups" ], "additionalProperties": false } }, "required": [ "name", "config" ], "additionalProperties": false } ] } }, "loginMethods": { "type": "array", "items": { "type": "string", "enum": [ "email_password", "google", "microsoft", "facebook" ] } }, "verifiedLoginDomains": { "type": "array", "items": { "type": "string" } }, "tenantNumber": { "type": "number" }, "slug": { "type": "string" }, "customDomains": { "type": "array", "items": { "type": "string" } }, "primaryCustomDomain": { "type": "string" }, "plan": { "type": "string", "enum": [ "LITE", "FREE", "DEMO", "INACTIVE", "DISABLED", "NONPROFIT", "INTERNAL", "EXTERNAL_IMPORT", "WIX_TRIAL", "GENIE_FREE", "DISCOVER_TRIAL", "DISCOVER", "BUILD", "ADVANCE", "ENTERPRISE", "BASIC", "GROW", "ADVANCED", "LEGACY_DISCOVER", "LEGACY_BUILD", "LEGACY_ADVANCE", "WIX_START", "WIX_EXPAND" ] }, "enabledFeatures": { "type": "array", "items": { "type": "string" } }, "hiddenFeatures": { "type": "array", "items": { "type": "string" } }, "uploadUrlPathId": { "type": "string" } }, "required": [ "id", "createdAt", "languages", "countryCode", "currencyCode", "currencySymbol", "currencyPosition", "taxExcluded", "timezone", "dateFormat", "timeFormat", "startOfDay", "unitSystem", "cookieNotice", "cookieNoticeEmbed", "disableTwiceBranding", "verifiedLoginDomains", "tenantNumber", "slug", "customDomains", "plan", "enabledFeatures", "hiddenFeatures", "uploadUrlPathId" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "post": { "summary": "Create a new merchant", "tags": [ "tenants" ], "parameters": [], "operationId": "internal.tenants.createTenant", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "countryCode": { "type": "string", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KP", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "timezone": { "type": "string" }, "language": { "type": "string", "enum": [ "en", "fi", "de", "cs", "es", "et", "sk", "no", "da", "hr", "nl", "fr", "hu", "it", "lt", "br", "pl", "pt", "sl", "sv", "lv", "tr", "uk", "ru" ] }, "termsAccepted": { "type": "boolean" } }, "required": [ "email", "countryCode", "timezone", "language", "termsAccepted" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "name": { "type": "string" }, "email": { "type": "string" }, "businessId": { "type": "string" }, "languages": { "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 2 } }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2 }, "currencyCode": { "type": "string", "minLength": 3, "maxLength": 3 }, "currencySymbol": { "type": "string" }, "currencyPosition": { "type": "string", "enum": [ "prefix", "prefix-no-space", "suffix", "suffix-no-space" ] }, "taxExcluded": { "type": "boolean" }, "timezone": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Brazil/Acre", "Australia/ACT", "America/Adak", "Africa/Addis_Ababa", "Australia/Adelaide", "Asia/Aden", "US/Alaska", "US/Aleutian", "Africa/Algiers", "Asia/Almaty", "Asia/Amman", "Europe/Amsterdam", "Asia/Anadyr", "America/Anchorage", "Europe/Andorra", "America/Anguilla", "Indian/Antananarivo", "America/Antigua", "Pacific/Apia", "Asia/Aqtau", "Asia/Aqtobe", "America/Araguaina", "US/Arizona", "America/Aruba", "Asia/Ashgabat", "Asia/Ashkhabad", "Africa/Asmara", "Africa/Asmera", "Europe/Astrakhan", "America/Asuncion", "Europe/Athens", "America/Atikokan", "America/Atka", "Canada/Atlantic", "Asia/Atyrau", "Pacific/Auckland", "Atlantic/Azores", "Asia/Baghdad", "America/Bahia", "America/Bahia_Banderas", "Asia/Bahrain", "Mexico/BajaNorte", "Mexico/BajaSur", "Asia/Baku", "Africa/Bamako", "Asia/Bangkok", "Africa/Bangui", "Africa/Banjul", "America/Barbados", "Asia/Barnaul", "Asia/Beirut", "America/Belem", "Europe/Belfast", "Europe/Belgrade", "America/Belize", "Europe/Berlin", "Atlantic/Bermuda", "America/North_Dakota/Beulah", "Asia/Bishkek", "Africa/Bissau", "America/Blanc-Sablon", "Africa/Blantyre", "America/Boa_Vista", "America/Bogota", "America/Boise", "Pacific/Bougainville", "Europe/Bratislava", "Africa/Brazzaville", "Australia/Brisbane", "Australia/Broken_Hill", "Asia/Brunei", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "America/Buenos_Aires", "America/Argentina/Buenos_Aires", "Africa/Bujumbura", "Europe/Busingen", "Africa/Cairo", "Asia/Calcutta", "America/Cambridge_Bay", "America/Campo_Grande", "Atlantic/Canary", "Australia/Canberra", "America/Cancun", "Atlantic/Cape_Verde", "America/Caracas", "Africa/Casablanca", "Antarctica/Casey", "America/Catamarca", "America/Argentina/Catamarca", "America/Cayenne", "America/Cayman", "America/North_Dakota/Center", "US/Central", "Canada/Central", "CET", "Africa/Ceuta", "Indian/Chagos", "Pacific/Chatham", "America/Chicago", "America/Chihuahua", "Europe/Chisinau", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Indian/Christmas", "Asia/Chungking", "Pacific/Chuuk", "Indian/Cocos", "Asia/Colombo", "America/Argentina/ComodRivadavia", "Indian/Comoro", "Africa/Conakry", "Chile/Continental", "Europe/Copenhagen", "America/Coral_Harbour", "America/Cordoba", "America/Argentina/Cordoba", "America/Costa_Rica", "America/Creston", "CST6CDT", "Cuba", "America/Cuiaba", "America/Curacao", "Australia/Currie", "Asia/Dacca", "Africa/Dakar", "Asia/Damascus", "America/Danmarkshavn", "Africa/Dar_es_Salaam", "Australia/Darwin", "Antarctica/Davis", "America/Dawson", "America/Dawson_Creek", "Brazil/DeNoronha", "America/Denver", "America/Detroit", "Asia/Dhaka", "Asia/Dili", "Africa/Djibouti", "America/Dominica", "Africa/Douala", "Asia/Dubai", "Europe/Dublin", "Antarctica/DumontDUrville", "Asia/Dushanbe", "Brazil/East", "US/East-Indiana", "Pacific/Easter", "Chile/EasterIsland", "US/Eastern", "Canada/Eastern", "America/Edmonton", "EET", "Pacific/Efate", "Egypt", "Eire", "America/Eirunepe", "Africa/El_Aaiun", "America/El_Salvador", "Pacific/Enderbury", "America/Ensenada", "EST", "EST5EDT", "Australia/Eucla", "Atlantic/Faeroe", "Pacific/Fakaofo", "Asia/Famagusta", "Atlantic/Faroe", "Pacific/Fiji", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "Africa/Freetown", "Pacific/Funafuti", "Africa/Gaborone", "Pacific/Galapagos", "Pacific/Gambier", "Asia/Gaza", "GB", "GB-Eire", "Mexico/General", "Europe/Gibraltar", "America/Glace_Bay", "Etc/GMT", "GMT", "GMT-0", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT+0", "GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT0", "GMT0", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "Etc/Greenwich", "Greenwich", "America/Grenada", "Pacific/Guadalcanal", "America/Guadeloupe", "Pacific/Guam", "America/Guatemala", "America/Guayaquil", "Europe/Guernsey", "America/Guyana", "America/Halifax", "Africa/Harare", "Asia/Harbin", "America/Havana", "US/Hawaii", "Asia/Hebron", "Europe/Helsinki", "America/Hermosillo", "Asia/Ho_Chi_Minh", "Australia/Hobart", "Asia/Hong_Kong", "Hongkong", "Pacific/Honolulu", "Asia/Hovd", "HST", "Iceland", "US/Indiana-Starke", "America/Indiana/Indianapolis", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "Iran", "Asia/Irkutsk", "Europe/Isle_of_Man", "Israel", "Asia/Istanbul", "Europe/Istanbul", "Asia/Jakarta", "Jamaica", "America/Jamaica", "Atlantic/Jan_Mayen", "Japan", "Asia/Jayapura", "Europe/Jersey", "Asia/Jerusalem", "Africa/Johannesburg", "Pacific/Johnston", "Africa/Juba", "America/Jujuy", "America/Argentina/Jujuy", "America/Juneau", "Asia/Kabul", "Europe/Kaliningrad", "Asia/Kamchatka", "Africa/Kampala", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Indian/Kerguelen", "Asia/Khandyga", "Africa/Khartoum", "Europe/Kiev", "Africa/Kigali", "Africa/Kinshasa", "Pacific/Kiritimati", "Europe/Kirov", "America/Indiana/Knox", "America/Knox_IN", "Asia/Kolkata", "Pacific/Kosrae", "America/Kralendijk", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Kwajalein", "Pacific/Kwajalein", "America/La_Paz", "America/Argentina/La_Rioja", "Africa/Lagos", "Australia/LHI", "Africa/Libreville", "Libya", "America/Lima", "Australia/Lindeman", "Europe/Lisbon", "Europe/Ljubljana", "Africa/Lome", "Europe/London", "Arctic/Longyearbyen", "Australia/Lord_Howe", "America/Los_Angeles", "America/Louisville", "America/Kentucky/Louisville", "America/Lower_Princes", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Europe/Luxembourg", "Asia/Macao", "Asia/Macau", "America/Maceio", "Antarctica/Macquarie", "Atlantic/Madeira", "Europe/Madrid", "Asia/Magadan", "Indian/Mahe", "Pacific/Majuro", "Asia/Makassar", "Africa/Malabo", "Indian/Maldives", "Europe/Malta", "America/Managua", "America/Manaus", "Asia/Manila", "Africa/Maputo", "America/Indiana/Marengo", "Europe/Mariehamn", "America/Marigot", "Pacific/Marquesas", "America/Martinique", "Africa/Maseru", "America/Matamoros", "Indian/Mauritius", "Antarctica/Mawson", "Indian/Mayotte", "America/Mazatlan", "Africa/Mbabane", "Antarctica/McMurdo", "Australia/Melbourne", "America/Mendoza", "America/Argentina/Mendoza", "America/Menominee", "America/Merida", "MET", "America/Metlakatla", "America/Mexico_City", "US/Michigan", "Pacific/Midway", "Europe/Minsk", "America/Miquelon", "Africa/Mogadishu", "Europe/Monaco", "America/Moncton", "Africa/Monrovia", "America/Monterrey", "America/Montevideo", "America/Kentucky/Monticello", "America/Montreal", "America/Montserrat", "Europe/Moscow", "US/Mountain", "Canada/Mountain", "MST", "MST7MDT", "Asia/Muscat", "Africa/Nairobi", "America/Nassau", "Pacific/Nauru", "Navajo", "Africa/Ndjamena", "America/North_Dakota/New_Salem", "America/New_York", "Canada/Newfoundland", "Africa/Niamey", "Europe/Nicosia", "Asia/Nicosia", "America/Nipigon", "Pacific/Niue", "America/Nome", "Pacific/Norfolk", "America/Noronha", "Australia/North", "Africa/Nouakchott", "Pacific/Noumea", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Australia/NSW", "America/Nuuk", "NZ", "NZ-CHAT", "America/Ojinaga", "Asia/Omsk", "Asia/Oral", "Europe/Oslo", "Africa/Ouagadougou", "US/Pacific", "Canada/Pacific", "Pacific/Pago_Pago", "Pacific/Palau", "Antarctica/Palmer", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "Europe/Paris", "Australia/Perth", "America/Indiana/Petersburg", "Asia/Phnom_Penh", "America/Phoenix", "Pacific/Pitcairn", "Europe/Podgorica", "Pacific/Pohnpei", "Poland", "Pacific/Ponape", "Asia/Pontianak", "Pacific/Port_Moresby", "America/Port_of_Spain", "America/Port-au-Prince", "America/Porto_Acre", "America/Porto_Velho", "Africa/Porto-Novo", "Portugal", "Europe/Prague", "PRC", "PST8PDT", "America/Puerto_Rico", "America/Punta_Arenas", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Australia/Queensland", "Asia/Qyzylorda", "America/Rainy_River", "Asia/Rangoon", "America/Rankin_Inlet", "Pacific/Rarotonga", "America/Recife", "America/Regina", "America/Resolute", "Indian/Reunion", "Atlantic/Reykjavik", "Europe/Riga", "America/Rio_Branco", "America/Argentina/Rio_Gallegos", "Asia/Riyadh", "ROC", "ROK", "Europe/Rome", "America/Rosario", "Antarctica/Rothera", "Asia/Saigon", "Pacific/Saipan", "Asia/Sakhalin", "America/Argentina/Salta", "Europe/Samara", "Asia/Samarkand", "Pacific/Samoa", "US/Samoa", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "Europe/San_Marino", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "Africa/Sao_Tome", "Europe/Sarajevo", "Europe/Saratov", "Canada/Saskatchewan", "America/Scoresbysund", "Asia/Seoul", "Asia/Shanghai", "America/Shiprock", "Europe/Simferopol", "Asia/Singapore", "Singapore", "America/Sitka", "Europe/Skopje", "Europe/Sofia", "Australia/South", "Atlantic/South_Georgia", "Antarctica/South_Pole", "Asia/Srednekolymsk", "America/St_Barthelemy", "Atlantic/St_Helena", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "Atlantic/Stanley", "Europe/Stockholm", "America/Swift_Current", "Australia/Sydney", "Antarctica/Syowa", "Pacific/Tahiti", "Asia/Taipei", "Europe/Tallinn", "Pacific/Tarawa", "Asia/Tashkent", "Australia/Tasmania", "Asia/Tbilisi", "America/Tegucigalpa", "Asia/Tehran", "Asia/Tel_Aviv", "America/Indiana/Tell_City", "Asia/Thimbu", "Asia/Thimphu", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "Africa/Timbuktu", "Europe/Tirane", "Europe/Tiraspol", "Asia/Tokyo", "Asia/Tomsk", "Pacific/Tongatapu", "America/Toronto", "America/Tortola", "Africa/Tripoli", "Antarctica/Troll", "Pacific/Truk", "America/Argentina/Tucuman", "Africa/Tunis", "Turkey", "Etc/UCT", "UCT", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Europe/Ulyanovsk", "Etc/Universal", "Universal", "Asia/Urumqi", "America/Argentina/Ushuaia", "Asia/Ust-Nera", "UTC", "Etc/UTC", "Europe/Uzhgorod", "Europe/Vaduz", "America/Vancouver", "Europe/Vatican", "America/Indiana/Vevay", "Australia/Victoria", "Europe/Vienna", "Asia/Vientiane", "Europe/Vilnius", "America/Indiana/Vincennes", "America/Virgin", "Asia/Vladivostok", "Europe/Volgograd", "Antarctica/Vostok", "W-SU", "Pacific/Wake", "Pacific/Wallis", "Europe/Warsaw", "Brazil/West", "Australia/West", "WET", "America/Whitehorse", "America/Indiana/Winamac", "Africa/Windhoek", "America/Winnipeg", "America/Yakutat", "Asia/Yakutsk", "Australia/Yancowinna", "Asia/Yangon", "Pacific/Yap", "Asia/Yekaterinburg", "America/Yellowknife", "Asia/Yerevan", "Canada/Yukon", "Europe/Zagreb", "Europe/Zaporozhye", "Etc/Zulu", "Zulu", "Europe/Zurich" ] }, "dateFormat": { "type": "string", "enum": [ "DD.MM.YYYY", "MM/DD/YYYY", "YYYY-MM-DD" ] }, "timeFormat": { "type": "string", "enum": [ "HH:mm", "hh:mm A" ] }, "startOfDay": { "type": "string", "enum": [ "monday", "saturday", "sunday" ] }, "unitSystem": { "type": "string", "enum": [ "METRIC", "US", "UK", "AU" ] }, "termsOfServiceUrl": { "type": "string" }, "termsOfServiceName": { "type": "string" }, "privacyPolicyUrl": { "type": "string" }, "privacyPolicyName": { "type": "string" }, "cookieNotice": { "type": "string", "enum": [ "show_notice", "disable", "enable" ] }, "cookieNoticeEmbed": { "type": "string", "enum": [ "show_notice", "disable", "enable" ] }, "disableTwiceBranding": { "type": "boolean" }, "plugins": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "enum": [ "cloud_pos" ] }, "config": { "type": "object", "properties": { "triggerTypes": { "type": "array", "items": { "type": "string", "enum": [ "onOrderReceiptPrint", "onShopperReceiptPrint", "externalButton" ] } } }, "required": [ "triggerTypes" ], "additionalProperties": false } }, "required": [ "name", "config" ], "additionalProperties": false }, { "type": "object", "properties": { "config": { "type": "object", "properties": { "triggerTypes": { "type": "array", "items": { "type": "string", "enum": [ "onOrderReceiptPrint", "onShopperReceiptPrint", "externalButton" ] } } }, "required": [ "triggerTypes" ], "additionalProperties": false }, "name": { "type": "string", "enum": [ "tekso_pos" ] } }, "required": [ "config", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "custom_accounting_groups" ] }, "config": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "groups" ], "additionalProperties": false } }, "required": [ "name", "config" ], "additionalProperties": false } ] } }, "loginMethods": { "type": "array", "items": { "type": "string", "enum": [ "email_password", "google", "microsoft", "facebook" ] } }, "verifiedLoginDomains": { "type": "array", "items": { "type": "string" } }, "tenantNumber": { "type": "number" }, "slug": { "type": "string" }, "customDomains": { "type": "array", "items": { "type": "string" } }, "primaryCustomDomain": { "type": "string" }, "plan": { "type": "string", "enum": [ "LITE", "FREE", "DEMO", "INACTIVE", "DISABLED", "NONPROFIT", "INTERNAL", "EXTERNAL_IMPORT", "WIX_TRIAL", "GENIE_FREE", "DISCOVER_TRIAL", "DISCOVER", "BUILD", "ADVANCE", "ENTERPRISE", "BASIC", "GROW", "ADVANCED", "LEGACY_DISCOVER", "LEGACY_BUILD", "LEGACY_ADVANCE", "WIX_START", "WIX_EXPAND" ] }, "enabledFeatures": { "type": "array", "items": { "type": "string" } }, "hiddenFeatures": { "type": "array", "items": { "type": "string" } }, "uploadUrlPathId": { "type": "string" } }, "required": [ "id", "createdAt", "languages", "countryCode", "currencyCode", "currencySymbol", "currencyPosition", "taxExcluded", "timezone", "dateFormat", "timeFormat", "startOfDay", "unitSystem", "cookieNotice", "cookieNoticeEmbed", "disableTwiceBranding", "verifiedLoginDomains", "tenantNumber", "slug", "customDomains", "plan", "enabledFeatures", "hiddenFeatures", "uploadUrlPathId" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "patch": { "summary": "Update current merchant data", "tags": [ "tenants" ], "parameters": [], "operationId": "internal.tenants.updateTenant", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "businessId": { "type": "string" }, "languages": { "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 2 } }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2 }, "currencyCode": { "type": "string", "minLength": 3, "maxLength": 3 }, "currencySymbol": { "type": "string" }, "currencyPosition": { "type": "string", "enum": [ "prefix", "prefix-no-space", "suffix", "suffix-no-space" ] }, "taxExcluded": { "type": "boolean" }, "timezone": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Brazil/Acre", "Australia/ACT", "America/Adak", "Africa/Addis_Ababa", "Australia/Adelaide", "Asia/Aden", "US/Alaska", "US/Aleutian", "Africa/Algiers", "Asia/Almaty", "Asia/Amman", "Europe/Amsterdam", "Asia/Anadyr", "America/Anchorage", "Europe/Andorra", "America/Anguilla", "Indian/Antananarivo", "America/Antigua", "Pacific/Apia", "Asia/Aqtau", "Asia/Aqtobe", "America/Araguaina", "US/Arizona", "America/Aruba", "Asia/Ashgabat", "Asia/Ashkhabad", "Africa/Asmara", "Africa/Asmera", "Europe/Astrakhan", "America/Asuncion", "Europe/Athens", "America/Atikokan", "America/Atka", "Canada/Atlantic", "Asia/Atyrau", "Pacific/Auckland", "Atlantic/Azores", "Asia/Baghdad", "America/Bahia", "America/Bahia_Banderas", "Asia/Bahrain", "Mexico/BajaNorte", "Mexico/BajaSur", "Asia/Baku", "Africa/Bamako", "Asia/Bangkok", "Africa/Bangui", "Africa/Banjul", "America/Barbados", "Asia/Barnaul", "Asia/Beirut", "America/Belem", "Europe/Belfast", "Europe/Belgrade", "America/Belize", "Europe/Berlin", "Atlantic/Bermuda", "America/North_Dakota/Beulah", "Asia/Bishkek", "Africa/Bissau", "America/Blanc-Sablon", "Africa/Blantyre", "America/Boa_Vista", "America/Bogota", "America/Boise", "Pacific/Bougainville", "Europe/Bratislava", "Africa/Brazzaville", "Australia/Brisbane", "Australia/Broken_Hill", "Asia/Brunei", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "America/Buenos_Aires", "America/Argentina/Buenos_Aires", "Africa/Bujumbura", "Europe/Busingen", "Africa/Cairo", "Asia/Calcutta", "America/Cambridge_Bay", "America/Campo_Grande", "Atlantic/Canary", "Australia/Canberra", "America/Cancun", "Atlantic/Cape_Verde", "America/Caracas", "Africa/Casablanca", "Antarctica/Casey", "America/Catamarca", "America/Argentina/Catamarca", "America/Cayenne", "America/Cayman", "America/North_Dakota/Center", "US/Central", "Canada/Central", "CET", "Africa/Ceuta", "Indian/Chagos", "Pacific/Chatham", "America/Chicago", "America/Chihuahua", "Europe/Chisinau", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Indian/Christmas", "Asia/Chungking", "Pacific/Chuuk", "Indian/Cocos", "Asia/Colombo", "America/Argentina/ComodRivadavia", "Indian/Comoro", "Africa/Conakry", "Chile/Continental", "Europe/Copenhagen", "America/Coral_Harbour", "America/Cordoba", "America/Argentina/Cordoba", "America/Costa_Rica", "America/Creston", "CST6CDT", "Cuba", "America/Cuiaba", "America/Curacao", "Australia/Currie", "Asia/Dacca", "Africa/Dakar", "Asia/Damascus", "America/Danmarkshavn", "Africa/Dar_es_Salaam", "Australia/Darwin", "Antarctica/Davis", "America/Dawson", "America/Dawson_Creek", "Brazil/DeNoronha", "America/Denver", "America/Detroit", "Asia/Dhaka", "Asia/Dili", "Africa/Djibouti", "America/Dominica", "Africa/Douala", "Asia/Dubai", "Europe/Dublin", "Antarctica/DumontDUrville", "Asia/Dushanbe", "Brazil/East", "US/East-Indiana", "Pacific/Easter", "Chile/EasterIsland", "US/Eastern", "Canada/Eastern", "America/Edmonton", "EET", "Pacific/Efate", "Egypt", "Eire", "America/Eirunepe", "Africa/El_Aaiun", "America/El_Salvador", "Pacific/Enderbury", "America/Ensenada", "EST", "EST5EDT", "Australia/Eucla", "Atlantic/Faeroe", "Pacific/Fakaofo", "Asia/Famagusta", "Atlantic/Faroe", "Pacific/Fiji", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "Africa/Freetown", "Pacific/Funafuti", "Africa/Gaborone", "Pacific/Galapagos", "Pacific/Gambier", "Asia/Gaza", "GB", "GB-Eire", "Mexico/General", "Europe/Gibraltar", "America/Glace_Bay", "Etc/GMT", "GMT", "GMT-0", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT+0", "GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT0", "GMT0", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "Etc/Greenwich", "Greenwich", "America/Grenada", "Pacific/Guadalcanal", "America/Guadeloupe", "Pacific/Guam", "America/Guatemala", "America/Guayaquil", "Europe/Guernsey", "America/Guyana", "America/Halifax", "Africa/Harare", "Asia/Harbin", "America/Havana", "US/Hawaii", "Asia/Hebron", "Europe/Helsinki", "America/Hermosillo", "Asia/Ho_Chi_Minh", "Australia/Hobart", "Asia/Hong_Kong", "Hongkong", "Pacific/Honolulu", "Asia/Hovd", "HST", "Iceland", "US/Indiana-Starke", "America/Indiana/Indianapolis", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "Iran", "Asia/Irkutsk", "Europe/Isle_of_Man", "Israel", "Asia/Istanbul", "Europe/Istanbul", "Asia/Jakarta", "Jamaica", "America/Jamaica", "Atlantic/Jan_Mayen", "Japan", "Asia/Jayapura", "Europe/Jersey", "Asia/Jerusalem", "Africa/Johannesburg", "Pacific/Johnston", "Africa/Juba", "America/Jujuy", "America/Argentina/Jujuy", "America/Juneau", "Asia/Kabul", "Europe/Kaliningrad", "Asia/Kamchatka", "Africa/Kampala", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Indian/Kerguelen", "Asia/Khandyga", "Africa/Khartoum", "Europe/Kiev", "Africa/Kigali", "Africa/Kinshasa", "Pacific/Kiritimati", "Europe/Kirov", "America/Indiana/Knox", "America/Knox_IN", "Asia/Kolkata", "Pacific/Kosrae", "America/Kralendijk", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Kwajalein", "Pacific/Kwajalein", "America/La_Paz", "America/Argentina/La_Rioja", "Africa/Lagos", "Australia/LHI", "Africa/Libreville", "Libya", "America/Lima", "Australia/Lindeman", "Europe/Lisbon", "Europe/Ljubljana", "Africa/Lome", "Europe/London", "Arctic/Longyearbyen", "Australia/Lord_Howe", "America/Los_Angeles", "America/Louisville", "America/Kentucky/Louisville", "America/Lower_Princes", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Europe/Luxembourg", "Asia/Macao", "Asia/Macau", "America/Maceio", "Antarctica/Macquarie", "Atlantic/Madeira", "Europe/Madrid", "Asia/Magadan", "Indian/Mahe", "Pacific/Majuro", "Asia/Makassar", "Africa/Malabo", "Indian/Maldives", "Europe/Malta", "America/Managua", "America/Manaus", "Asia/Manila", "Africa/Maputo", "America/Indiana/Marengo", "Europe/Mariehamn", "America/Marigot", "Pacific/Marquesas", "America/Martinique", "Africa/Maseru", "America/Matamoros", "Indian/Mauritius", "Antarctica/Mawson", "Indian/Mayotte", "America/Mazatlan", "Africa/Mbabane", "Antarctica/McMurdo", "Australia/Melbourne", "America/Mendoza", "America/Argentina/Mendoza", "America/Menominee", "America/Merida", "MET", "America/Metlakatla", "America/Mexico_City", "US/Michigan", "Pacific/Midway", "Europe/Minsk", "America/Miquelon", "Africa/Mogadishu", "Europe/Monaco", "America/Moncton", "Africa/Monrovia", "America/Monterrey", "America/Montevideo", "America/Kentucky/Monticello", "America/Montreal", "America/Montserrat", "Europe/Moscow", "US/Mountain", "Canada/Mountain", "MST", "MST7MDT", "Asia/Muscat", "Africa/Nairobi", "America/Nassau", "Pacific/Nauru", "Navajo", "Africa/Ndjamena", "America/North_Dakota/New_Salem", "America/New_York", "Canada/Newfoundland", "Africa/Niamey", "Europe/Nicosia", "Asia/Nicosia", "America/Nipigon", "Pacific/Niue", "America/Nome", "Pacific/Norfolk", "America/Noronha", "Australia/North", "Africa/Nouakchott", "Pacific/Noumea", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Australia/NSW", "America/Nuuk", "NZ", "NZ-CHAT", "America/Ojinaga", "Asia/Omsk", "Asia/Oral", "Europe/Oslo", "Africa/Ouagadougou", "US/Pacific", "Canada/Pacific", "Pacific/Pago_Pago", "Pacific/Palau", "Antarctica/Palmer", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "Europe/Paris", "Australia/Perth", "America/Indiana/Petersburg", "Asia/Phnom_Penh", "America/Phoenix", "Pacific/Pitcairn", "Europe/Podgorica", "Pacific/Pohnpei", "Poland", "Pacific/Ponape", "Asia/Pontianak", "Pacific/Port_Moresby", "America/Port_of_Spain", "America/Port-au-Prince", "America/Porto_Acre", "America/Porto_Velho", "Africa/Porto-Novo", "Portugal", "Europe/Prague", "PRC", "PST8PDT", "America/Puerto_Rico", "America/Punta_Arenas", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Australia/Queensland", "Asia/Qyzylorda", "America/Rainy_River", "Asia/Rangoon", "America/Rankin_Inlet", "Pacific/Rarotonga", "America/Recife", "America/Regina", "America/Resolute", "Indian/Reunion", "Atlantic/Reykjavik", "Europe/Riga", "America/Rio_Branco", "America/Argentina/Rio_Gallegos", "Asia/Riyadh", "ROC", "ROK", "Europe/Rome", "America/Rosario", "Antarctica/Rothera", "Asia/Saigon", "Pacific/Saipan", "Asia/Sakhalin", "America/Argentina/Salta", "Europe/Samara", "Asia/Samarkand", "Pacific/Samoa", "US/Samoa", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "Europe/San_Marino", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "Africa/Sao_Tome", "Europe/Sarajevo", "Europe/Saratov", "Canada/Saskatchewan", "America/Scoresbysund", "Asia/Seoul", "Asia/Shanghai", "America/Shiprock", "Europe/Simferopol", "Asia/Singapore", "Singapore", "America/Sitka", "Europe/Skopje", "Europe/Sofia", "Australia/South", "Atlantic/South_Georgia", "Antarctica/South_Pole", "Asia/Srednekolymsk", "America/St_Barthelemy", "Atlantic/St_Helena", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "Atlantic/Stanley", "Europe/Stockholm", "America/Swift_Current", "Australia/Sydney", "Antarctica/Syowa", "Pacific/Tahiti", "Asia/Taipei", "Europe/Tallinn", "Pacific/Tarawa", "Asia/Tashkent", "Australia/Tasmania", "Asia/Tbilisi", "America/Tegucigalpa", "Asia/Tehran", "Asia/Tel_Aviv", "America/Indiana/Tell_City", "Asia/Thimbu", "Asia/Thimphu", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "Africa/Timbuktu", "Europe/Tirane", "Europe/Tiraspol", "Asia/Tokyo", "Asia/Tomsk", "Pacific/Tongatapu", "America/Toronto", "America/Tortola", "Africa/Tripoli", "Antarctica/Troll", "Pacific/Truk", "America/Argentina/Tucuman", "Africa/Tunis", "Turkey", "Etc/UCT", "UCT", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Europe/Ulyanovsk", "Etc/Universal", "Universal", "Asia/Urumqi", "America/Argentina/Ushuaia", "Asia/Ust-Nera", "UTC", "Etc/UTC", "Europe/Uzhgorod", "Europe/Vaduz", "America/Vancouver", "Europe/Vatican", "America/Indiana/Vevay", "Australia/Victoria", "Europe/Vienna", "Asia/Vientiane", "Europe/Vilnius", "America/Indiana/Vincennes", "America/Virgin", "Asia/Vladivostok", "Europe/Volgograd", "Antarctica/Vostok", "W-SU", "Pacific/Wake", "Pacific/Wallis", "Europe/Warsaw", "Brazil/West", "Australia/West", "WET", "America/Whitehorse", "America/Indiana/Winamac", "Africa/Windhoek", "America/Winnipeg", "America/Yakutat", "Asia/Yakutsk", "Australia/Yancowinna", "Asia/Yangon", "Pacific/Yap", "Asia/Yekaterinburg", "America/Yellowknife", "Asia/Yerevan", "Canada/Yukon", "Europe/Zagreb", "Europe/Zaporozhye", "Etc/Zulu", "Zulu", "Europe/Zurich" ] }, "dateFormat": { "type": "string", "enum": [ "DD.MM.YYYY", "MM/DD/YYYY", "YYYY-MM-DD" ] }, "timeFormat": { "type": "string", "enum": [ "HH:mm", "hh:mm A" ] }, "startOfDay": { "type": "string", "enum": [ "monday", "saturday", "sunday" ] }, "unitSystem": { "type": "string", "enum": [ "METRIC", "US", "UK", "AU" ] }, "termsOfServiceUrl": { "type": "string" }, "termsOfServiceName": { "type": "string" }, "privacyPolicyUrl": { "type": "string" }, "privacyPolicyName": { "type": "string" }, "cookieNotice": { "type": "string", "enum": [ "show_notice", "disable", "enable" ] }, "cookieNoticeEmbed": { "type": "string", "enum": [ "show_notice", "disable", "enable" ] }, "disableTwiceBranding": { "type": "boolean" }, "loginMethods": { "type": "array", "items": { "type": "string", "enum": [ "email_password", "google", "microsoft", "facebook" ] } }, "verifiedLoginDomains": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string" }, "customDomains": { "type": "array", "items": { "type": "string" } }, "primaryCustomDomain": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "name": { "type": "string" }, "email": { "type": "string" }, "businessId": { "type": "string" }, "languages": { "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 2 } }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2 }, "currencyCode": { "type": "string", "minLength": 3, "maxLength": 3 }, "currencySymbol": { "type": "string" }, "currencyPosition": { "type": "string", "enum": [ "prefix", "prefix-no-space", "suffix", "suffix-no-space" ] }, "taxExcluded": { "type": "boolean" }, "timezone": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Brazil/Acre", "Australia/ACT", "America/Adak", "Africa/Addis_Ababa", "Australia/Adelaide", "Asia/Aden", "US/Alaska", "US/Aleutian", "Africa/Algiers", "Asia/Almaty", "Asia/Amman", "Europe/Amsterdam", "Asia/Anadyr", "America/Anchorage", "Europe/Andorra", "America/Anguilla", "Indian/Antananarivo", "America/Antigua", "Pacific/Apia", "Asia/Aqtau", "Asia/Aqtobe", "America/Araguaina", "US/Arizona", "America/Aruba", "Asia/Ashgabat", "Asia/Ashkhabad", "Africa/Asmara", "Africa/Asmera", "Europe/Astrakhan", "America/Asuncion", "Europe/Athens", "America/Atikokan", "America/Atka", "Canada/Atlantic", "Asia/Atyrau", "Pacific/Auckland", "Atlantic/Azores", "Asia/Baghdad", "America/Bahia", "America/Bahia_Banderas", "Asia/Bahrain", "Mexico/BajaNorte", "Mexico/BajaSur", "Asia/Baku", "Africa/Bamako", "Asia/Bangkok", "Africa/Bangui", "Africa/Banjul", "America/Barbados", "Asia/Barnaul", "Asia/Beirut", "America/Belem", "Europe/Belfast", "Europe/Belgrade", "America/Belize", "Europe/Berlin", "Atlantic/Bermuda", "America/North_Dakota/Beulah", "Asia/Bishkek", "Africa/Bissau", "America/Blanc-Sablon", "Africa/Blantyre", "America/Boa_Vista", "America/Bogota", "America/Boise", "Pacific/Bougainville", "Europe/Bratislava", "Africa/Brazzaville", "Australia/Brisbane", "Australia/Broken_Hill", "Asia/Brunei", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "America/Buenos_Aires", "America/Argentina/Buenos_Aires", "Africa/Bujumbura", "Europe/Busingen", "Africa/Cairo", "Asia/Calcutta", "America/Cambridge_Bay", "America/Campo_Grande", "Atlantic/Canary", "Australia/Canberra", "America/Cancun", "Atlantic/Cape_Verde", "America/Caracas", "Africa/Casablanca", "Antarctica/Casey", "America/Catamarca", "America/Argentina/Catamarca", "America/Cayenne", "America/Cayman", "America/North_Dakota/Center", "US/Central", "Canada/Central", "CET", "Africa/Ceuta", "Indian/Chagos", "Pacific/Chatham", "America/Chicago", "America/Chihuahua", "Europe/Chisinau", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Indian/Christmas", "Asia/Chungking", "Pacific/Chuuk", "Indian/Cocos", "Asia/Colombo", "America/Argentina/ComodRivadavia", "Indian/Comoro", "Africa/Conakry", "Chile/Continental", "Europe/Copenhagen", "America/Coral_Harbour", "America/Cordoba", "America/Argentina/Cordoba", "America/Costa_Rica", "America/Creston", "CST6CDT", "Cuba", "America/Cuiaba", "America/Curacao", "Australia/Currie", "Asia/Dacca", "Africa/Dakar", "Asia/Damascus", "America/Danmarkshavn", "Africa/Dar_es_Salaam", "Australia/Darwin", "Antarctica/Davis", "America/Dawson", "America/Dawson_Creek", "Brazil/DeNoronha", "America/Denver", "America/Detroit", "Asia/Dhaka", "Asia/Dili", "Africa/Djibouti", "America/Dominica", "Africa/Douala", "Asia/Dubai", "Europe/Dublin", "Antarctica/DumontDUrville", "Asia/Dushanbe", "Brazil/East", "US/East-Indiana", "Pacific/Easter", "Chile/EasterIsland", "US/Eastern", "Canada/Eastern", "America/Edmonton", "EET", "Pacific/Efate", "Egypt", "Eire", "America/Eirunepe", "Africa/El_Aaiun", "America/El_Salvador", "Pacific/Enderbury", "America/Ensenada", "EST", "EST5EDT", "Australia/Eucla", "Atlantic/Faeroe", "Pacific/Fakaofo", "Asia/Famagusta", "Atlantic/Faroe", "Pacific/Fiji", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "Africa/Freetown", "Pacific/Funafuti", "Africa/Gaborone", "Pacific/Galapagos", "Pacific/Gambier", "Asia/Gaza", "GB", "GB-Eire", "Mexico/General", "Europe/Gibraltar", "America/Glace_Bay", "Etc/GMT", "GMT", "GMT-0", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT+0", "GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT0", "GMT0", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "Etc/Greenwich", "Greenwich", "America/Grenada", "Pacific/Guadalcanal", "America/Guadeloupe", "Pacific/Guam", "America/Guatemala", "America/Guayaquil", "Europe/Guernsey", "America/Guyana", "America/Halifax", "Africa/Harare", "Asia/Harbin", "America/Havana", "US/Hawaii", "Asia/Hebron", "Europe/Helsinki", "America/Hermosillo", "Asia/Ho_Chi_Minh", "Australia/Hobart", "Asia/Hong_Kong", "Hongkong", "Pacific/Honolulu", "Asia/Hovd", "HST", "Iceland", "US/Indiana-Starke", "America/Indiana/Indianapolis", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "Iran", "Asia/Irkutsk", "Europe/Isle_of_Man", "Israel", "Asia/Istanbul", "Europe/Istanbul", "Asia/Jakarta", "Jamaica", "America/Jamaica", "Atlantic/Jan_Mayen", "Japan", "Asia/Jayapura", "Europe/Jersey", "Asia/Jerusalem", "Africa/Johannesburg", "Pacific/Johnston", "Africa/Juba", "America/Jujuy", "America/Argentina/Jujuy", "America/Juneau", "Asia/Kabul", "Europe/Kaliningrad", "Asia/Kamchatka", "Africa/Kampala", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Indian/Kerguelen", "Asia/Khandyga", "Africa/Khartoum", "Europe/Kiev", "Africa/Kigali", "Africa/Kinshasa", "Pacific/Kiritimati", "Europe/Kirov", "America/Indiana/Knox", "America/Knox_IN", "Asia/Kolkata", "Pacific/Kosrae", "America/Kralendijk", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Kwajalein", "Pacific/Kwajalein", "America/La_Paz", "America/Argentina/La_Rioja", "Africa/Lagos", "Australia/LHI", "Africa/Libreville", "Libya", "America/Lima", "Australia/Lindeman", "Europe/Lisbon", "Europe/Ljubljana", "Africa/Lome", "Europe/London", "Arctic/Longyearbyen", "Australia/Lord_Howe", "America/Los_Angeles", "America/Louisville", "America/Kentucky/Louisville", "America/Lower_Princes", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Europe/Luxembourg", "Asia/Macao", "Asia/Macau", "America/Maceio", "Antarctica/Macquarie", "Atlantic/Madeira", "Europe/Madrid", "Asia/Magadan", "Indian/Mahe", "Pacific/Majuro", "Asia/Makassar", "Africa/Malabo", "Indian/Maldives", "Europe/Malta", "America/Managua", "America/Manaus", "Asia/Manila", "Africa/Maputo", "America/Indiana/Marengo", "Europe/Mariehamn", "America/Marigot", "Pacific/Marquesas", "America/Martinique", "Africa/Maseru", "America/Matamoros", "Indian/Mauritius", "Antarctica/Mawson", "Indian/Mayotte", "America/Mazatlan", "Africa/Mbabane", "Antarctica/McMurdo", "Australia/Melbourne", "America/Mendoza", "America/Argentina/Mendoza", "America/Menominee", "America/Merida", "MET", "America/Metlakatla", "America/Mexico_City", "US/Michigan", "Pacific/Midway", "Europe/Minsk", "America/Miquelon", "Africa/Mogadishu", "Europe/Monaco", "America/Moncton", "Africa/Monrovia", "America/Monterrey", "America/Montevideo", "America/Kentucky/Monticello", "America/Montreal", "America/Montserrat", "Europe/Moscow", "US/Mountain", "Canada/Mountain", "MST", "MST7MDT", "Asia/Muscat", "Africa/Nairobi", "America/Nassau", "Pacific/Nauru", "Navajo", "Africa/Ndjamena", "America/North_Dakota/New_Salem", "America/New_York", "Canada/Newfoundland", "Africa/Niamey", "Europe/Nicosia", "Asia/Nicosia", "America/Nipigon", "Pacific/Niue", "America/Nome", "Pacific/Norfolk", "America/Noronha", "Australia/North", "Africa/Nouakchott", "Pacific/Noumea", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Australia/NSW", "America/Nuuk", "NZ", "NZ-CHAT", "America/Ojinaga", "Asia/Omsk", "Asia/Oral", "Europe/Oslo", "Africa/Ouagadougou", "US/Pacific", "Canada/Pacific", "Pacific/Pago_Pago", "Pacific/Palau", "Antarctica/Palmer", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "Europe/Paris", "Australia/Perth", "America/Indiana/Petersburg", "Asia/Phnom_Penh", "America/Phoenix", "Pacific/Pitcairn", "Europe/Podgorica", "Pacific/Pohnpei", "Poland", "Pacific/Ponape", "Asia/Pontianak", "Pacific/Port_Moresby", "America/Port_of_Spain", "America/Port-au-Prince", "America/Porto_Acre", "America/Porto_Velho", "Africa/Porto-Novo", "Portugal", "Europe/Prague", "PRC", "PST8PDT", "America/Puerto_Rico", "America/Punta_Arenas", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Australia/Queensland", "Asia/Qyzylorda", "America/Rainy_River", "Asia/Rangoon", "America/Rankin_Inlet", "Pacific/Rarotonga", "America/Recife", "America/Regina", "America/Resolute", "Indian/Reunion", "Atlantic/Reykjavik", "Europe/Riga", "America/Rio_Branco", "America/Argentina/Rio_Gallegos", "Asia/Riyadh", "ROC", "ROK", "Europe/Rome", "America/Rosario", "Antarctica/Rothera", "Asia/Saigon", "Pacific/Saipan", "Asia/Sakhalin", "America/Argentina/Salta", "Europe/Samara", "Asia/Samarkand", "Pacific/Samoa", "US/Samoa", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "Europe/San_Marino", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "Africa/Sao_Tome", "Europe/Sarajevo", "Europe/Saratov", "Canada/Saskatchewan", "America/Scoresbysund", "Asia/Seoul", "Asia/Shanghai", "America/Shiprock", "Europe/Simferopol", "Asia/Singapore", "Singapore", "America/Sitka", "Europe/Skopje", "Europe/Sofia", "Australia/South", "Atlantic/South_Georgia", "Antarctica/South_Pole", "Asia/Srednekolymsk", "America/St_Barthelemy", "Atlantic/St_Helena", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "Atlantic/Stanley", "Europe/Stockholm", "America/Swift_Current", "Australia/Sydney", "Antarctica/Syowa", "Pacific/Tahiti", "Asia/Taipei", "Europe/Tallinn", "Pacific/Tarawa", "Asia/Tashkent", "Australia/Tasmania", "Asia/Tbilisi", "America/Tegucigalpa", "Asia/Tehran", "Asia/Tel_Aviv", "America/Indiana/Tell_City", "Asia/Thimbu", "Asia/Thimphu", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "Africa/Timbuktu", "Europe/Tirane", "Europe/Tiraspol", "Asia/Tokyo", "Asia/Tomsk", "Pacific/Tongatapu", "America/Toronto", "America/Tortola", "Africa/Tripoli", "Antarctica/Troll", "Pacific/Truk", "America/Argentina/Tucuman", "Africa/Tunis", "Turkey", "Etc/UCT", "UCT", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Europe/Ulyanovsk", "Etc/Universal", "Universal", "Asia/Urumqi", "America/Argentina/Ushuaia", "Asia/Ust-Nera", "UTC", "Etc/UTC", "Europe/Uzhgorod", "Europe/Vaduz", "America/Vancouver", "Europe/Vatican", "America/Indiana/Vevay", "Australia/Victoria", "Europe/Vienna", "Asia/Vientiane", "Europe/Vilnius", "America/Indiana/Vincennes", "America/Virgin", "Asia/Vladivostok", "Europe/Volgograd", "Antarctica/Vostok", "W-SU", "Pacific/Wake", "Pacific/Wallis", "Europe/Warsaw", "Brazil/West", "Australia/West", "WET", "America/Whitehorse", "America/Indiana/Winamac", "Africa/Windhoek", "America/Winnipeg", "America/Yakutat", "Asia/Yakutsk", "Australia/Yancowinna", "Asia/Yangon", "Pacific/Yap", "Asia/Yekaterinburg", "America/Yellowknife", "Asia/Yerevan", "Canada/Yukon", "Europe/Zagreb", "Europe/Zaporozhye", "Etc/Zulu", "Zulu", "Europe/Zurich" ] }, "dateFormat": { "type": "string", "enum": [ "DD.MM.YYYY", "MM/DD/YYYY", "YYYY-MM-DD" ] }, "timeFormat": { "type": "string", "enum": [ "HH:mm", "hh:mm A" ] }, "startOfDay": { "type": "string", "enum": [ "monday", "saturday", "sunday" ] }, "unitSystem": { "type": "string", "enum": [ "METRIC", "US", "UK", "AU" ] }, "termsOfServiceUrl": { "type": "string" }, "termsOfServiceName": { "type": "string" }, "privacyPolicyUrl": { "type": "string" }, "privacyPolicyName": { "type": "string" }, "cookieNotice": { "type": "string", "enum": [ "show_notice", "disable", "enable" ] }, "cookieNoticeEmbed": { "type": "string", "enum": [ "show_notice", "disable", "enable" ] }, "disableTwiceBranding": { "type": "boolean" }, "plugins": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "enum": [ "cloud_pos" ] }, "config": { "type": "object", "properties": { "triggerTypes": { "type": "array", "items": { "type": "string", "enum": [ "onOrderReceiptPrint", "onShopperReceiptPrint", "externalButton" ] } } }, "required": [ "triggerTypes" ], "additionalProperties": false } }, "required": [ "name", "config" ], "additionalProperties": false }, { "type": "object", "properties": { "config": { "type": "object", "properties": { "triggerTypes": { "type": "array", "items": { "type": "string", "enum": [ "onOrderReceiptPrint", "onShopperReceiptPrint", "externalButton" ] } } }, "required": [ "triggerTypes" ], "additionalProperties": false }, "name": { "type": "string", "enum": [ "tekso_pos" ] } }, "required": [ "config", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "custom_accounting_groups" ] }, "config": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "groups" ], "additionalProperties": false } }, "required": [ "name", "config" ], "additionalProperties": false } ] } }, "loginMethods": { "type": "array", "items": { "type": "string", "enum": [ "email_password", "google", "microsoft", "facebook" ] } }, "verifiedLoginDomains": { "type": "array", "items": { "type": "string" } }, "tenantNumber": { "type": "number" }, "slug": { "type": "string" }, "customDomains": { "type": "array", "items": { "type": "string" } }, "primaryCustomDomain": { "type": "string" }, "plan": { "type": "string", "enum": [ "LITE", "FREE", "DEMO", "INACTIVE", "DISABLED", "NONPROFIT", "INTERNAL", "EXTERNAL_IMPORT", "WIX_TRIAL", "GENIE_FREE", "DISCOVER_TRIAL", "DISCOVER", "BUILD", "ADVANCE", "ENTERPRISE", "BASIC", "GROW", "ADVANCED", "LEGACY_DISCOVER", "LEGACY_BUILD", "LEGACY_ADVANCE", "WIX_START", "WIX_EXPAND" ] }, "enabledFeatures": { "type": "array", "items": { "type": "string" } }, "hiddenFeatures": { "type": "array", "items": { "type": "string" } }, "uploadUrlPathId": { "type": "string" } }, "required": [ "id", "createdAt", "languages", "countryCode", "currencyCode", "currencySymbol", "currencyPosition", "taxExcluded", "timezone", "dateFormat", "timeFormat", "startOfDay", "unitSystem", "cookieNotice", "cookieNoticeEmbed", "disableTwiceBranding", "verifiedLoginDomains", "tenantNumber", "slug", "customDomains", "plan", "enabledFeatures", "hiddenFeatures", "uploadUrlPathId" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/merchant/billing": { "get": { "summary": "Get your own merchant billing data", "tags": [ "tenants" ], "parameters": [], "operationId": "internal.tenants.getTenantBilling", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "billingAddress": { "type": "object", "properties": { "address": { "type": "string" }, "zipCode": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "details": { "type": "string" } }, "required": [ "address" ], "additionalProperties": false }, "vatId": { "type": "string" }, "vatIdValidated": { "type": "boolean" }, "vatIdExempt": { "type": "boolean" }, "billingMethod": { "type": "string", "enum": [ "credit-card", "bank-transfer", "custom" ] }, "customPaymentCommissions": { "type": "object", "additionalProperties": { "type": "object", "properties": { "currency": { "type": "string" }, "fixedInCents": { "type": "number" }, "percentageInDecimals": { "type": "number" } }, "required": [ "fixedInCents", "percentageInDecimals" ], "additionalProperties": false } } }, "required": [ "vatIdValidated", "vatIdExempt", "billingMethod" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "patch": { "tags": [ "tenants" ], "parameters": [], "operationId": "internal.tenants.updateTenantBilling", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "billingAddress": { "type": "object", "properties": { "address": { "type": "string" }, "zipCode": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "details": { "type": "string" } }, "required": [ "address" ], "additionalProperties": false }, "vatId": { "type": "string" }, "vatIdExempt": { "type": "boolean" } }, "required": [ "vatIdExempt" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "billingAddress": { "type": "object", "properties": { "address": { "type": "string" }, "zipCode": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "details": { "type": "string" } }, "required": [ "address" ], "additionalProperties": false }, "vatId": { "type": "string" }, "vatIdValidated": { "type": "boolean" }, "vatIdExempt": { "type": "boolean" }, "billingMethod": { "type": "string", "enum": [ "credit-card", "bank-transfer", "custom" ] }, "customPaymentCommissions": { "type": "object", "additionalProperties": { "type": "object", "properties": { "currency": { "type": "string" }, "fixedInCents": { "type": "number" }, "percentageInDecimals": { "type": "number" } }, "required": [ "fixedInCents", "percentageInDecimals" ], "additionalProperties": false } } }, "required": [ "vatIdValidated", "vatIdExempt", "billingMethod" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/merchant/register": { "post": { "summary": "Register as a new merchant", "tags": [ "tenants" ], "parameters": [], "operationId": "internal.tenants.registerNewAccount", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "countryCode": { "type": "string", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KP", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "timezone": { "type": "string" }, "language": { "type": "string", "enum": [ "en", "fi", "de", "cs", "es", "et", "sk", "no", "da", "hr", "nl", "fr", "hu", "it", "lt", "br", "pl", "pt", "sl", "sv", "lv", "tr", "uk", "ru" ] }, "termsAccepted": { "type": "boolean" } }, "required": [ "email", "countryCode", "timezone", "language", "termsAccepted" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "name": { "type": "string" }, "email": { "type": "string" }, "businessId": { "type": "string" }, "languages": { "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 2 } }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2 }, "currencyCode": { "type": "string", "minLength": 3, "maxLength": 3 }, "currencySymbol": { "type": "string" }, "currencyPosition": { "type": "string", "enum": [ "prefix", "prefix-no-space", "suffix", "suffix-no-space" ] }, "taxExcluded": { "type": "boolean" }, "timezone": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Brazil/Acre", "Australia/ACT", "America/Adak", "Africa/Addis_Ababa", "Australia/Adelaide", "Asia/Aden", "US/Alaska", "US/Aleutian", "Africa/Algiers", "Asia/Almaty", "Asia/Amman", "Europe/Amsterdam", "Asia/Anadyr", "America/Anchorage", "Europe/Andorra", "America/Anguilla", "Indian/Antananarivo", "America/Antigua", "Pacific/Apia", "Asia/Aqtau", "Asia/Aqtobe", "America/Araguaina", "US/Arizona", "America/Aruba", "Asia/Ashgabat", "Asia/Ashkhabad", "Africa/Asmara", "Africa/Asmera", "Europe/Astrakhan", "America/Asuncion", "Europe/Athens", "America/Atikokan", "America/Atka", "Canada/Atlantic", "Asia/Atyrau", "Pacific/Auckland", "Atlantic/Azores", "Asia/Baghdad", "America/Bahia", "America/Bahia_Banderas", "Asia/Bahrain", "Mexico/BajaNorte", "Mexico/BajaSur", "Asia/Baku", "Africa/Bamako", "Asia/Bangkok", "Africa/Bangui", "Africa/Banjul", "America/Barbados", "Asia/Barnaul", "Asia/Beirut", "America/Belem", "Europe/Belfast", "Europe/Belgrade", "America/Belize", "Europe/Berlin", "Atlantic/Bermuda", "America/North_Dakota/Beulah", "Asia/Bishkek", "Africa/Bissau", "America/Blanc-Sablon", "Africa/Blantyre", "America/Boa_Vista", "America/Bogota", "America/Boise", "Pacific/Bougainville", "Europe/Bratislava", "Africa/Brazzaville", "Australia/Brisbane", "Australia/Broken_Hill", "Asia/Brunei", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "America/Buenos_Aires", "America/Argentina/Buenos_Aires", "Africa/Bujumbura", "Europe/Busingen", "Africa/Cairo", "Asia/Calcutta", "America/Cambridge_Bay", "America/Campo_Grande", "Atlantic/Canary", "Australia/Canberra", "America/Cancun", "Atlantic/Cape_Verde", "America/Caracas", "Africa/Casablanca", "Antarctica/Casey", "America/Catamarca", "America/Argentina/Catamarca", "America/Cayenne", "America/Cayman", "America/North_Dakota/Center", "US/Central", "Canada/Central", "CET", "Africa/Ceuta", "Indian/Chagos", "Pacific/Chatham", "America/Chicago", "America/Chihuahua", "Europe/Chisinau", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Indian/Christmas", "Asia/Chungking", "Pacific/Chuuk", "Indian/Cocos", "Asia/Colombo", "America/Argentina/ComodRivadavia", "Indian/Comoro", "Africa/Conakry", "Chile/Continental", "Europe/Copenhagen", "America/Coral_Harbour", "America/Cordoba", "America/Argentina/Cordoba", "America/Costa_Rica", "America/Creston", "CST6CDT", "Cuba", "America/Cuiaba", "America/Curacao", "Australia/Currie", "Asia/Dacca", "Africa/Dakar", "Asia/Damascus", "America/Danmarkshavn", "Africa/Dar_es_Salaam", "Australia/Darwin", "Antarctica/Davis", "America/Dawson", "America/Dawson_Creek", "Brazil/DeNoronha", "America/Denver", "America/Detroit", "Asia/Dhaka", "Asia/Dili", "Africa/Djibouti", "America/Dominica", "Africa/Douala", "Asia/Dubai", "Europe/Dublin", "Antarctica/DumontDUrville", "Asia/Dushanbe", "Brazil/East", "US/East-Indiana", "Pacific/Easter", "Chile/EasterIsland", "US/Eastern", "Canada/Eastern", "America/Edmonton", "EET", "Pacific/Efate", "Egypt", "Eire", "America/Eirunepe", "Africa/El_Aaiun", "America/El_Salvador", "Pacific/Enderbury", "America/Ensenada", "EST", "EST5EDT", "Australia/Eucla", "Atlantic/Faeroe", "Pacific/Fakaofo", "Asia/Famagusta", "Atlantic/Faroe", "Pacific/Fiji", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "Africa/Freetown", "Pacific/Funafuti", "Africa/Gaborone", "Pacific/Galapagos", "Pacific/Gambier", "Asia/Gaza", "GB", "GB-Eire", "Mexico/General", "Europe/Gibraltar", "America/Glace_Bay", "Etc/GMT", "GMT", "GMT-0", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT+0", "GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT0", "GMT0", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "Etc/Greenwich", "Greenwich", "America/Grenada", "Pacific/Guadalcanal", "America/Guadeloupe", "Pacific/Guam", "America/Guatemala", "America/Guayaquil", "Europe/Guernsey", "America/Guyana", "America/Halifax", "Africa/Harare", "Asia/Harbin", "America/Havana", "US/Hawaii", "Asia/Hebron", "Europe/Helsinki", "America/Hermosillo", "Asia/Ho_Chi_Minh", "Australia/Hobart", "Asia/Hong_Kong", "Hongkong", "Pacific/Honolulu", "Asia/Hovd", "HST", "Iceland", "US/Indiana-Starke", "America/Indiana/Indianapolis", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "Iran", "Asia/Irkutsk", "Europe/Isle_of_Man", "Israel", "Asia/Istanbul", "Europe/Istanbul", "Asia/Jakarta", "Jamaica", "America/Jamaica", "Atlantic/Jan_Mayen", "Japan", "Asia/Jayapura", "Europe/Jersey", "Asia/Jerusalem", "Africa/Johannesburg", "Pacific/Johnston", "Africa/Juba", "America/Jujuy", "America/Argentina/Jujuy", "America/Juneau", "Asia/Kabul", "Europe/Kaliningrad", "Asia/Kamchatka", "Africa/Kampala", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Indian/Kerguelen", "Asia/Khandyga", "Africa/Khartoum", "Europe/Kiev", "Africa/Kigali", "Africa/Kinshasa", "Pacific/Kiritimati", "Europe/Kirov", "America/Indiana/Knox", "America/Knox_IN", "Asia/Kolkata", "Pacific/Kosrae", "America/Kralendijk", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Kwajalein", "Pacific/Kwajalein", "America/La_Paz", "America/Argentina/La_Rioja", "Africa/Lagos", "Australia/LHI", "Africa/Libreville", "Libya", "America/Lima", "Australia/Lindeman", "Europe/Lisbon", "Europe/Ljubljana", "Africa/Lome", "Europe/London", "Arctic/Longyearbyen", "Australia/Lord_Howe", "America/Los_Angeles", "America/Louisville", "America/Kentucky/Louisville", "America/Lower_Princes", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Europe/Luxembourg", "Asia/Macao", "Asia/Macau", "America/Maceio", "Antarctica/Macquarie", "Atlantic/Madeira", "Europe/Madrid", "Asia/Magadan", "Indian/Mahe", "Pacific/Majuro", "Asia/Makassar", "Africa/Malabo", "Indian/Maldives", "Europe/Malta", "America/Managua", "America/Manaus", "Asia/Manila", "Africa/Maputo", "America/Indiana/Marengo", "Europe/Mariehamn", "America/Marigot", "Pacific/Marquesas", "America/Martinique", "Africa/Maseru", "America/Matamoros", "Indian/Mauritius", "Antarctica/Mawson", "Indian/Mayotte", "America/Mazatlan", "Africa/Mbabane", "Antarctica/McMurdo", "Australia/Melbourne", "America/Mendoza", "America/Argentina/Mendoza", "America/Menominee", "America/Merida", "MET", "America/Metlakatla", "America/Mexico_City", "US/Michigan", "Pacific/Midway", "Europe/Minsk", "America/Miquelon", "Africa/Mogadishu", "Europe/Monaco", "America/Moncton", "Africa/Monrovia", "America/Monterrey", "America/Montevideo", "America/Kentucky/Monticello", "America/Montreal", "America/Montserrat", "Europe/Moscow", "US/Mountain", "Canada/Mountain", "MST", "MST7MDT", "Asia/Muscat", "Africa/Nairobi", "America/Nassau", "Pacific/Nauru", "Navajo", "Africa/Ndjamena", "America/North_Dakota/New_Salem", "America/New_York", "Canada/Newfoundland", "Africa/Niamey", "Europe/Nicosia", "Asia/Nicosia", "America/Nipigon", "Pacific/Niue", "America/Nome", "Pacific/Norfolk", "America/Noronha", "Australia/North", "Africa/Nouakchott", "Pacific/Noumea", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Australia/NSW", "America/Nuuk", "NZ", "NZ-CHAT", "America/Ojinaga", "Asia/Omsk", "Asia/Oral", "Europe/Oslo", "Africa/Ouagadougou", "US/Pacific", "Canada/Pacific", "Pacific/Pago_Pago", "Pacific/Palau", "Antarctica/Palmer", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "Europe/Paris", "Australia/Perth", "America/Indiana/Petersburg", "Asia/Phnom_Penh", "America/Phoenix", "Pacific/Pitcairn", "Europe/Podgorica", "Pacific/Pohnpei", "Poland", "Pacific/Ponape", "Asia/Pontianak", "Pacific/Port_Moresby", "America/Port_of_Spain", "America/Port-au-Prince", "America/Porto_Acre", "America/Porto_Velho", "Africa/Porto-Novo", "Portugal", "Europe/Prague", "PRC", "PST8PDT", "America/Puerto_Rico", "America/Punta_Arenas", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Australia/Queensland", "Asia/Qyzylorda", "America/Rainy_River", "Asia/Rangoon", "America/Rankin_Inlet", "Pacific/Rarotonga", "America/Recife", "America/Regina", "America/Resolute", "Indian/Reunion", "Atlantic/Reykjavik", "Europe/Riga", "America/Rio_Branco", "America/Argentina/Rio_Gallegos", "Asia/Riyadh", "ROC", "ROK", "Europe/Rome", "America/Rosario", "Antarctica/Rothera", "Asia/Saigon", "Pacific/Saipan", "Asia/Sakhalin", "America/Argentina/Salta", "Europe/Samara", "Asia/Samarkand", "Pacific/Samoa", "US/Samoa", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "Europe/San_Marino", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "Africa/Sao_Tome", "Europe/Sarajevo", "Europe/Saratov", "Canada/Saskatchewan", "America/Scoresbysund", "Asia/Seoul", "Asia/Shanghai", "America/Shiprock", "Europe/Simferopol", "Asia/Singapore", "Singapore", "America/Sitka", "Europe/Skopje", "Europe/Sofia", "Australia/South", "Atlantic/South_Georgia", "Antarctica/South_Pole", "Asia/Srednekolymsk", "America/St_Barthelemy", "Atlantic/St_Helena", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "Atlantic/Stanley", "Europe/Stockholm", "America/Swift_Current", "Australia/Sydney", "Antarctica/Syowa", "Pacific/Tahiti", "Asia/Taipei", "Europe/Tallinn", "Pacific/Tarawa", "Asia/Tashkent", "Australia/Tasmania", "Asia/Tbilisi", "America/Tegucigalpa", "Asia/Tehran", "Asia/Tel_Aviv", "America/Indiana/Tell_City", "Asia/Thimbu", "Asia/Thimphu", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "Africa/Timbuktu", "Europe/Tirane", "Europe/Tiraspol", "Asia/Tokyo", "Asia/Tomsk", "Pacific/Tongatapu", "America/Toronto", "America/Tortola", "Africa/Tripoli", "Antarctica/Troll", "Pacific/Truk", "America/Argentina/Tucuman", "Africa/Tunis", "Turkey", "Etc/UCT", "UCT", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Europe/Ulyanovsk", "Etc/Universal", "Universal", "Asia/Urumqi", "America/Argentina/Ushuaia", "Asia/Ust-Nera", "UTC", "Etc/UTC", "Europe/Uzhgorod", "Europe/Vaduz", "America/Vancouver", "Europe/Vatican", "America/Indiana/Vevay", "Australia/Victoria", "Europe/Vienna", "Asia/Vientiane", "Europe/Vilnius", "America/Indiana/Vincennes", "America/Virgin", "Asia/Vladivostok", "Europe/Volgograd", "Antarctica/Vostok", "W-SU", "Pacific/Wake", "Pacific/Wallis", "Europe/Warsaw", "Brazil/West", "Australia/West", "WET", "America/Whitehorse", "America/Indiana/Winamac", "Africa/Windhoek", "America/Winnipeg", "America/Yakutat", "Asia/Yakutsk", "Australia/Yancowinna", "Asia/Yangon", "Pacific/Yap", "Asia/Yekaterinburg", "America/Yellowknife", "Asia/Yerevan", "Canada/Yukon", "Europe/Zagreb", "Europe/Zaporozhye", "Etc/Zulu", "Zulu", "Europe/Zurich" ] }, "dateFormat": { "type": "string", "enum": [ "DD.MM.YYYY", "MM/DD/YYYY", "YYYY-MM-DD" ] }, "timeFormat": { "type": "string", "enum": [ "HH:mm", "hh:mm A" ] }, "startOfDay": { "type": "string", "enum": [ "monday", "saturday", "sunday" ] }, "unitSystem": { "type": "string", "enum": [ "METRIC", "US", "UK", "AU" ] }, "termsOfServiceUrl": { "type": "string" }, "termsOfServiceName": { "type": "string" }, "privacyPolicyUrl": { "type": "string" }, "privacyPolicyName": { "type": "string" }, "cookieNotice": { "type": "string", "enum": [ "show_notice", "disable", "enable" ] }, "cookieNoticeEmbed": { "type": "string", "enum": [ "show_notice", "disable", "enable" ] }, "disableTwiceBranding": { "type": "boolean" }, "plugins": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "enum": [ "cloud_pos" ] }, "config": { "type": "object", "properties": { "triggerTypes": { "type": "array", "items": { "type": "string", "enum": [ "onOrderReceiptPrint", "onShopperReceiptPrint", "externalButton" ] } } }, "required": [ "triggerTypes" ], "additionalProperties": false } }, "required": [ "name", "config" ], "additionalProperties": false }, { "type": "object", "properties": { "config": { "type": "object", "properties": { "triggerTypes": { "type": "array", "items": { "type": "string", "enum": [ "onOrderReceiptPrint", "onShopperReceiptPrint", "externalButton" ] } } }, "required": [ "triggerTypes" ], "additionalProperties": false }, "name": { "type": "string", "enum": [ "tekso_pos" ] } }, "required": [ "config", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "custom_accounting_groups" ] }, "config": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "groups" ], "additionalProperties": false } }, "required": [ "name", "config" ], "additionalProperties": false } ] } }, "loginMethods": { "type": "array", "items": { "type": "string", "enum": [ "email_password", "google", "microsoft", "facebook" ] } }, "verifiedLoginDomains": { "type": "array", "items": { "type": "string" } }, "tenantNumber": { "type": "number" }, "slug": { "type": "string" }, "customDomains": { "type": "array", "items": { "type": "string" } }, "primaryCustomDomain": { "type": "string" }, "plan": { "type": "string", "enum": [ "LITE", "FREE", "DEMO", "INACTIVE", "DISABLED", "NONPROFIT", "INTERNAL", "EXTERNAL_IMPORT", "WIX_TRIAL", "GENIE_FREE", "DISCOVER_TRIAL", "DISCOVER", "BUILD", "ADVANCE", "ENTERPRISE", "BASIC", "GROW", "ADVANCED", "LEGACY_DISCOVER", "LEGACY_BUILD", "LEGACY_ADVANCE", "WIX_START", "WIX_EXPAND" ] }, "enabledFeatures": { "type": "array", "items": { "type": "string" } }, "hiddenFeatures": { "type": "array", "items": { "type": "string" } }, "uploadUrlPathId": { "type": "string" } }, "required": [ "id", "createdAt", "languages", "countryCode", "currencyCode", "currencySymbol", "currencyPosition", "taxExcluded", "timezone", "dateFormat", "timeFormat", "startOfDay", "unitSystem", "cookieNotice", "cookieNoticeEmbed", "disableTwiceBranding", "verifiedLoginDomains", "tenantNumber", "slug", "customDomains", "plan", "enabledFeatures", "hiddenFeatures", "uploadUrlPathId" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/merchant/users": { "get": { "summary": "Get all users for a tenant", "tags": [ "tenants" ], "parameters": [], "operationId": "internal.tenants.getTenantUsers", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/merchant/me": { "get": { "summary": "Get your own tenant user data", "tags": [ "tenants" ], "parameters": [], "operationId": "internal.tenants.getOwnTenantUser", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedBy": { "type": "string" }, "createdBy": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "avatarUrl": { "type": "string", "format": "uri" }, "phone": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "manager", "editor", "member", "rentle_support" ] } }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "modify_payments", "allow_overbookings", "edit_booking", "cancel_booking", "home_chart", "edit_article_status", "sensitive_data" ] } }, "restrictions": { "type": "array", "items": { "type": "string", "enum": [ "modify_payments", "allow_overbookings", "edit_booking", "cancel_booking", "home_chart", "edit_article_status", "sensitive_data" ] } }, "serviceLocations": { "type": "array", "items": { "type": "string" } }, "userId": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "roles", "permissions", "restrictions", "serviceLocations", "userId" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/merchant/verify-slug": { "post": { "summary": "Verify tenant slug", "tags": [ "tenants" ], "parameters": [], "operationId": "internal.tenants.validateTenantSlug", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string" } }, "required": [ "slug" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" } }, "required": [ "valid" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/attribute-groups/{groupId}": { "get": { "summary": "Get an attribute group by ID", "tags": [ "attributes" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.attributes.getAttributeGroup", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "description": { "type": "string" }, "resource": { "type": "string", "enum": [ "inventory", "customers" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sortOrder": { "type": "number" }, "attributeCount": { "type": "number" } }, "required": [ "id", "name", "resource", "createdAt", "updatedAt", "sortOrder", "attributeCount" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "500": { "description": "500" } } }, "patch": { "summary": "Update an attribute group", "tags": [ "attributes" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.attributes.updateAttributeGroup", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "sortOrder": { "type": "number" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "description": { "type": "string" }, "resource": { "type": "string", "enum": [ "inventory", "customers" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sortOrder": { "type": "number" }, "attributeCount": { "type": "number" } }, "required": [ "id", "name", "resource", "createdAt", "updatedAt", "sortOrder", "attributeCount" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete an attribute group", "tags": [ "attributes" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.attributes.deleteAttributeGroup", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/attribute-groups": { "get": { "summary": "Get all attribute groups", "tags": [ "attributes" ], "parameters": [ { "name": "resource", "in": "query", "schema": { "type": "string", "enum": [ "inventory", "customers" ] } } ], "operationId": "internal.attributes.getAttributeGroups", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "description": { "type": "string" }, "resource": { "type": "string", "enum": [ "inventory", "customers" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sortOrder": { "type": "number" }, "attributeCount": { "type": "number" } }, "required": [ "id", "name", "resource", "createdAt", "updatedAt", "sortOrder", "attributeCount" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "post": { "summary": "Create a new attribute group", "tags": [ "attributes" ], "parameters": [], "operationId": "internal.attributes.createAttributeGroup", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "resource": { "type": "string", "enum": [ "inventory", "customers" ] } }, "required": [ "name", "resource" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "description": { "type": "string" }, "resource": { "type": "string", "enum": [ "inventory", "customers" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sortOrder": { "type": "number" }, "attributeCount": { "type": "number" } }, "required": [ "id", "name", "resource", "createdAt", "updatedAt", "sortOrder", "attributeCount" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/attributes-groups/delete": { "post": { "summary": "Delete many attribute groups", "tags": [ "attributes" ], "parameters": [], "operationId": "internal.attributes.deleteManyAttributeGroups", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/attributes/{attributeId}": { "get": { "summary": "Get an attribute by ID", "tags": [ "attributes" ], "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.attributes.getAttribute", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "valueOptions": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "formula": { "type": "string" }, "resource": { "type": "string", "enum": [ "inventory", "customers" ] }, "groupId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sortOrder": { "type": "number" }, "systemGroup": { "type": "string", "enum": [ "sustainability", "system" ] }, "global": { "type": "boolean" } }, "required": [ "id", "key", "name", "format", "resource", "createdAt", "updatedAt", "sortOrder", "global" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "500": { "description": "500" } } }, "patch": { "summary": "Update an attribute", "tags": [ "attributes" ], "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.attributes.updateAttribute", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z0-9_-]+$" }, "name": { "type": "string" }, "description": { "type": "string" }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "valueOptions": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "formula": { "type": "string" }, "groupId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "systemGroup": { "type": "string", "enum": [ "sustainability", "system" ] }, "sortOrder": { "type": "number" }, "global": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "valueOptions": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "formula": { "type": "string" }, "resource": { "type": "string", "enum": [ "inventory", "customers" ] }, "groupId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sortOrder": { "type": "number" }, "systemGroup": { "type": "string", "enum": [ "sustainability", "system" ] }, "global": { "type": "boolean" } }, "required": [ "id", "key", "name", "format", "resource", "createdAt", "updatedAt", "sortOrder", "global" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete an attribute", "tags": [ "attributes" ], "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.attributes.deleteAttribute", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/attributes": { "get": { "summary": "Get all attributes", "tags": [ "attributes" ], "parameters": [ { "name": "resource", "in": "query", "schema": { "type": "string", "enum": [ "inventory", "customers" ] } }, { "name": "groupId", "in": "query", "schema": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "systemGroup", "in": "query", "schema": { "nullable": true, "type": "string", "enum": [ "sustainability", "system" ] } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "operationId": "internal.attributes.getAttributes", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "valueOptions": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "formula": { "type": "string" }, "resource": { "type": "string", "enum": [ "inventory", "customers" ] }, "groupId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sortOrder": { "type": "number" }, "systemGroup": { "type": "string", "enum": [ "sustainability", "system" ] }, "global": { "type": "boolean" } }, "required": [ "id", "key", "name", "format", "resource", "createdAt", "updatedAt", "sortOrder", "global" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "post": { "summary": "Create a new attribute", "tags": [ "attributes" ], "parameters": [], "operationId": "internal.attributes.createAttribute", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z0-9_-]+$" }, "name": { "type": "string" }, "description": { "type": "string" }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "valueOptions": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "formula": { "type": "string" }, "resource": { "type": "string", "enum": [ "inventory", "customers" ] }, "groupId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "systemGroup": { "type": "string", "enum": [ "sustainability", "system" ] }, "global": { "type": "boolean" } }, "required": [ "name", "format", "resource" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "valueOptions": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "formula": { "type": "string" }, "resource": { "type": "string", "enum": [ "inventory", "customers" ] }, "groupId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sortOrder": { "type": "number" }, "systemGroup": { "type": "string", "enum": [ "sustainability", "system" ] }, "global": { "type": "boolean" } }, "required": [ "id", "key", "name", "format", "resource", "createdAt", "updatedAt", "sortOrder", "global" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/attributes/{attributeId}/values": { "get": { "summary": "Get all values for an attribute", "tags": [ "attributes" ], "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.attributes.getAttributeValues", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "values" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/attributes/many": { "post": { "summary": "Create multiple attributes", "tags": [ "attributes" ], "parameters": [], "operationId": "internal.attributes.createAttributes", "responses": { "201": { "description": "201" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/attributes/delete": { "post": { "summary": "Delete many attributes", "tags": [ "attributes" ], "parameters": [], "operationId": "internal.attributes.deleteManyAttributes", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/uploader/{pathId}/image": { "post": { "summary": "Upload image via url", "tags": [ "uploadUrl" ], "parameters": [ { "name": "pathId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.uploadUrl.uploadImage", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/saved-table-views/saved-table-views": { "get": { "summary": "List saved table views", "tags": [ "savedTableViews" ], "parameters": [ { "name": "tableName", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "inventory-articles", "inventory-skus", "inventory-attributes", "inventory-article-events", "inventory-audit-log", "inventory-documents", "orders", "single-order", "catalog-listings", "catalog-events", "catalog-activity-log", "attributes", "catalog-rules", "catalog-orders-log", "catalog-add-listing", "catalog-stock-availability", "catalog-variants-table", "catalog-documents", "collections", "customers", "customer-attributes", "customer-documents", "customer-orders", "customer-stock-items", "customer-listings", "file-manager", "import-validation", "api-keys", "activity-log", "order-customer-line-items", "stock-item-costs", "stock-item-incomes", "financial-entries", "order-customers", "order-listings", "order-stock-items", "checkout-requirement-fields" ] } } ], "operationId": "internal.savedTableViews.list", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "post": { "summary": "Create a saved table view", "tags": [ "savedTableViews" ], "parameters": [], "operationId": "internal.savedTableViews.create", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "table": { "type": "string", "enum": [ "inventory-articles", "inventory-skus", "inventory-attributes", "inventory-article-events", "inventory-audit-log", "inventory-documents", "orders", "single-order", "catalog-listings", "catalog-events", "catalog-activity-log", "attributes", "catalog-rules", "catalog-orders-log", "catalog-add-listing", "catalog-stock-availability", "catalog-variants-table", "catalog-documents", "collections", "customers", "customer-attributes", "customer-documents", "customer-orders", "customer-stock-items", "customer-listings", "file-manager", "import-validation", "api-keys", "activity-log", "order-customer-line-items", "stock-item-costs", "stock-item-incomes", "financial-entries", "order-customers", "order-listings", "order-stock-items", "checkout-requirement-fields" ] }, "name": { "type": "string" }, "columns": { "type": "array", "items": { "type": "string" } }, "columnDetails": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "align": { "type": "string", "enum": [ "left", "center", "right" ] }, "width": { "type": "number" } }, "required": [ "field" ], "additionalProperties": false } }, "filterModel": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "sortModel": { "nullable": true, "type": "object", "properties": { "field": { "type": "string" }, "sort": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field", "sort" ], "additionalProperties": false }, "paginationModel": { "nullable": true, "type": "object", "properties": { "page": { "type": "number" }, "pageSize": { "type": "number" } }, "required": [ "page", "pageSize" ], "additionalProperties": false }, "groupingModel": { "nullable": true, "type": "array", "items": { "type": "string" } }, "density": { "type": "string", "enum": [ "compact", "standard", "comfortable" ] }, "shared": { "type": "boolean" } }, "required": [ "table", "name", "shared" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "table": { "nullable": true, "type": "string", "enum": [ "inventory-articles", "inventory-skus", "inventory-attributes", "inventory-article-events", "inventory-audit-log", "inventory-documents", "orders", "single-order", "catalog-listings", "catalog-events", "catalog-activity-log", "attributes", "catalog-rules", "catalog-orders-log", "catalog-add-listing", "catalog-stock-availability", "catalog-variants-table", "catalog-documents", "collections", "customers", "customer-attributes", "customer-documents", "customer-orders", "customer-stock-items", "customer-listings", "file-manager", "import-validation", "api-keys", "activity-log", "order-customer-line-items", "stock-item-costs", "stock-item-incomes", "financial-entries", "order-customers", "order-listings", "order-stock-items", "checkout-requirement-fields" ] }, "name": { "type": "string" }, "columns": { "type": "array", "items": { "type": "string" } }, "columnDetails": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "align": { "type": "string", "enum": [ "left", "center", "right" ] }, "width": { "type": "number" } }, "required": [ "field" ], "additionalProperties": false } }, "filterModel": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "sortModel": { "nullable": true, "type": "object", "properties": { "field": { "type": "string" }, "sort": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field", "sort" ], "additionalProperties": false }, "paginationModel": { "nullable": true, "type": "object", "properties": { "page": { "type": "number" }, "pageSize": { "type": "number" } }, "required": [ "page", "pageSize" ], "additionalProperties": false }, "groupingModel": { "nullable": true, "type": "array", "items": { "type": "string" } }, "density": { "type": "string", "enum": [ "compact", "standard", "comfortable" ] }, "shared": { "type": "boolean" } }, "required": [ "id", "table", "name", "shared" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/saved-table-views/saved-table-views/{id}": { "get": { "summary": "Get a saved table view", "tags": [ "savedTableViews" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tableName", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "inventory-articles", "inventory-skus", "inventory-attributes", "inventory-article-events", "inventory-audit-log", "inventory-documents", "orders", "single-order", "catalog-listings", "catalog-events", "catalog-activity-log", "attributes", "catalog-rules", "catalog-orders-log", "catalog-add-listing", "catalog-stock-availability", "catalog-variants-table", "catalog-documents", "collections", "customers", "customer-attributes", "customer-documents", "customer-orders", "customer-stock-items", "customer-listings", "file-manager", "import-validation", "api-keys", "activity-log", "order-customer-line-items", "stock-item-costs", "stock-item-incomes", "financial-entries", "order-customers", "order-listings", "order-stock-items", "checkout-requirement-fields" ] } } ], "operationId": "internal.savedTableViews.get", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "table": { "nullable": true, "type": "string", "enum": [ "inventory-articles", "inventory-skus", "inventory-attributes", "inventory-article-events", "inventory-audit-log", "inventory-documents", "orders", "single-order", "catalog-listings", "catalog-events", "catalog-activity-log", "attributes", "catalog-rules", "catalog-orders-log", "catalog-add-listing", "catalog-stock-availability", "catalog-variants-table", "catalog-documents", "collections", "customers", "customer-attributes", "customer-documents", "customer-orders", "customer-stock-items", "customer-listings", "file-manager", "import-validation", "api-keys", "activity-log", "order-customer-line-items", "stock-item-costs", "stock-item-incomes", "financial-entries", "order-customers", "order-listings", "order-stock-items", "checkout-requirement-fields" ] }, "name": { "type": "string" }, "columns": { "type": "array", "items": { "type": "string" } }, "columnDetails": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "align": { "type": "string", "enum": [ "left", "center", "right" ] }, "width": { "type": "number" } }, "required": [ "field" ], "additionalProperties": false } }, "filterModel": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "sortModel": { "nullable": true, "type": "object", "properties": { "field": { "type": "string" }, "sort": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field", "sort" ], "additionalProperties": false }, "paginationModel": { "nullable": true, "type": "object", "properties": { "page": { "type": "number" }, "pageSize": { "type": "number" } }, "required": [ "page", "pageSize" ], "additionalProperties": false }, "groupingModel": { "nullable": true, "type": "array", "items": { "type": "string" } }, "density": { "type": "string", "enum": [ "compact", "standard", "comfortable" ] }, "shared": { "type": "boolean" } }, "required": [ "id", "table", "name", "shared" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "put": { "summary": "Update a saved table view", "tags": [ "savedTableViews" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.savedTableViews.update", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "table": { "nullable": true, "type": "string", "enum": [ "inventory-articles", "inventory-skus", "inventory-attributes", "inventory-article-events", "inventory-audit-log", "inventory-documents", "orders", "single-order", "catalog-listings", "catalog-events", "catalog-activity-log", "attributes", "catalog-rules", "catalog-orders-log", "catalog-add-listing", "catalog-stock-availability", "catalog-variants-table", "catalog-documents", "collections", "customers", "customer-attributes", "customer-documents", "customer-orders", "customer-stock-items", "customer-listings", "file-manager", "import-validation", "api-keys", "activity-log", "order-customer-line-items", "stock-item-costs", "stock-item-incomes", "financial-entries", "order-customers", "order-listings", "order-stock-items", "checkout-requirement-fields" ] }, "name": { "type": "string" }, "columns": { "type": "array", "items": { "type": "string" } }, "columnDetails": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "align": { "type": "string", "enum": [ "left", "center", "right" ] }, "width": { "type": "number" } }, "required": [ "field" ], "additionalProperties": false } }, "filterModel": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "sortModel": { "nullable": true, "type": "object", "properties": { "field": { "type": "string" }, "sort": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field", "sort" ], "additionalProperties": false }, "paginationModel": { "nullable": true, "type": "object", "properties": { "page": { "type": "number" }, "pageSize": { "type": "number" } }, "required": [ "page", "pageSize" ], "additionalProperties": false }, "groupingModel": { "nullable": true, "type": "array", "items": { "type": "string" } }, "density": { "type": "string", "enum": [ "compact", "standard", "comfortable" ] }, "shared": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "table": { "nullable": true, "type": "string", "enum": [ "inventory-articles", "inventory-skus", "inventory-attributes", "inventory-article-events", "inventory-audit-log", "inventory-documents", "orders", "single-order", "catalog-listings", "catalog-events", "catalog-activity-log", "attributes", "catalog-rules", "catalog-orders-log", "catalog-add-listing", "catalog-stock-availability", "catalog-variants-table", "catalog-documents", "collections", "customers", "customer-attributes", "customer-documents", "customer-orders", "customer-stock-items", "customer-listings", "file-manager", "import-validation", "api-keys", "activity-log", "order-customer-line-items", "stock-item-costs", "stock-item-incomes", "financial-entries", "order-customers", "order-listings", "order-stock-items", "checkout-requirement-fields" ] }, "name": { "type": "string" }, "columns": { "type": "array", "items": { "type": "string" } }, "columnDetails": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "align": { "type": "string", "enum": [ "left", "center", "right" ] }, "width": { "type": "number" } }, "required": [ "field" ], "additionalProperties": false } }, "filterModel": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "sortModel": { "nullable": true, "type": "object", "properties": { "field": { "type": "string" }, "sort": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field", "sort" ], "additionalProperties": false }, "paginationModel": { "nullable": true, "type": "object", "properties": { "page": { "type": "number" }, "pageSize": { "type": "number" } }, "required": [ "page", "pageSize" ], "additionalProperties": false }, "groupingModel": { "nullable": true, "type": "array", "items": { "type": "string" } }, "density": { "type": "string", "enum": [ "compact", "standard", "comfortable" ] }, "shared": { "type": "boolean" } }, "required": [ "id", "table", "name", "shared" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete a saved table view", "tags": [ "savedTableViews" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.savedTableViews.delete", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/changeHistory": { "get": { "summary": "Get change history records with pagination and filtering", "tags": [ "changeHistory" ], "parameters": [ { "name": "page", "in": "query", "required": true, "schema": { "type": "number", "minimum": 0, "exclusiveMinimum": true } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "number", "minimum": 0, "exclusiveMinimum": true, "maximum": 100 } }, { "name": "tableName", "in": "query", "schema": { "type": "string" } }, { "name": "recordId", "in": "query", "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "action", "in": "query", "schema": { "type": "string", "enum": [ "INSERT", "UPDATE", "DELETE" ] } }, { "name": "createdAtFrom", "in": "query", "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, { "name": "createdAtTo", "in": "query", "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, { "name": "sortDirection", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "operationId": "internal.changeHistory.listChangeHistory", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "createdById": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "tenantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "tableName": { "type": "string" }, "recordId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string", "enum": [ "INSERT", "UPDATE", "DELETE" ] }, "updatedKeys": { "nullable": true, "type": "array", "items": { "type": "string" } } }, "required": [ "id", "createdAt", "createdById", "tenantId", "tableName", "recordId", "action", "updatedKeys" ], "additionalProperties": false } }, "totalCount": { "type": "number" }, "pageCount": { "type": "number" }, "currentPage": { "type": "number" } }, "required": [ "data", "totalCount", "pageCount", "currentPage" ], "additionalProperties": false } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/skus/{skuId}": { "get": { "summary": "Get a SKU by ID", "tags": [ "skus" ], "parameters": [ { "name": "skuId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.skus.getSku", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "taxonomyCategory": { "nullable": true, "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "level": { "type": "number" }, "parentId": { "nullable": true, "type": "string" }, "isLeaf": { "type": "boolean" } }, "required": [ "id", "name", "fullName", "level", "parentId", "isLeaf" ], "additionalProperties": false }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "groupId": { "nullable": true, "type": "string" }, "systemGroup": { "nullable": true, "type": "string", "enum": [ "sustainability", "system" ] }, "origin": { "type": "string", "enum": [ "article", "sku", "customer" ] } }, "required": [ "id", "name", "key", "value", "format", "groupId", "systemGroup", "origin" ], "additionalProperties": false } }, "fulfilmentType": { "default": "item", "type": "string", "enum": [ "item", "sku" ] } }, "required": [ "id", "name", "code", "createdAt", "updatedAt", "fulfilmentType" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "500": { "description": "500" } } }, "patch": { "summary": "Update a SKU", "tags": [ "skus" ], "parameters": [ { "name": "skuId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.skus.updateSku", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "fulfilmentType": { "default": "item", "type": "string", "enum": [ "item", "sku" ] }, "attributes": { "type": "object", "additionalProperties": { "description": "attribute_value", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "string", "nullable": true, "enum": [ null ] } ] } } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "taxonomyCategory": { "nullable": true, "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "level": { "type": "number" }, "parentId": { "nullable": true, "type": "string" }, "isLeaf": { "type": "boolean" } }, "required": [ "id", "name", "fullName", "level", "parentId", "isLeaf" ], "additionalProperties": false }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "groupId": { "nullable": true, "type": "string" }, "systemGroup": { "nullable": true, "type": "string", "enum": [ "sustainability", "system" ] }, "origin": { "type": "string", "enum": [ "article", "sku", "customer" ] } }, "required": [ "id", "name", "key", "value", "format", "groupId", "systemGroup", "origin" ], "additionalProperties": false } }, "fulfilmentType": { "default": "item", "type": "string", "enum": [ "item", "sku" ] } }, "required": [ "id", "name", "code", "createdAt", "updatedAt", "fulfilmentType" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Delete a SKU", "tags": [ "skus" ], "parameters": [ { "name": "skuId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "internal.skus.deleteSku", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/skus/suggest-code": { "post": { "summary": "Suggest SKU code", "tags": [ "skus" ], "parameters": [], "operationId": "internal.skus.suggestSkuCode", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/skus": { "get": { "summary": "Get all SKUs", "tags": [ "skus" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } } ], "operationId": "internal.skus.getSkus", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "taxonomyCategory": { "nullable": true, "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "level": { "type": "number" }, "parentId": { "nullable": true, "type": "string" }, "isLeaf": { "type": "boolean" } }, "required": [ "id", "name", "fullName", "level", "parentId", "isLeaf" ], "additionalProperties": false }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "groupId": { "nullable": true, "type": "string" }, "systemGroup": { "nullable": true, "type": "string", "enum": [ "sustainability", "system" ] }, "origin": { "type": "string", "enum": [ "article", "sku", "customer" ] } }, "required": [ "id", "name", "key", "value", "format", "groupId", "systemGroup", "origin" ], "additionalProperties": false } }, "fulfilmentType": { "default": "item", "type": "string", "enum": [ "item", "sku" ] } }, "required": [ "id", "name", "code", "createdAt", "updatedAt", "fulfilmentType" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "post": { "summary": "Create a new SKU", "tags": [ "skus" ], "parameters": [], "operationId": "internal.skus.createSku", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "fulfilmentType": { "default": "item", "type": "string", "enum": [ "item", "sku" ] }, "attributes": { "type": "object", "additionalProperties": { "description": "attribute_value", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "name", "fulfilmentType" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "taxonomyCategoryId": { "nullable": true, "type": "string" }, "taxonomyCategory": { "nullable": true, "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "level": { "type": "number" }, "parentId": { "nullable": true, "type": "string" }, "isLeaf": { "type": "boolean" } }, "required": [ "id", "name", "fullName", "level", "parentId", "isLeaf" ], "additionalProperties": false }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "format": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "groupId": { "nullable": true, "type": "string" }, "systemGroup": { "nullable": true, "type": "string", "enum": [ "sustainability", "system" ] }, "origin": { "type": "string", "enum": [ "article", "sku", "customer" ] } }, "required": [ "id", "name", "key", "value", "format", "groupId", "systemGroup", "origin" ], "additionalProperties": false } }, "fulfilmentType": { "default": "item", "type": "string", "enum": [ "item", "sku" ] } }, "required": [ "id", "name", "code", "createdAt", "updatedAt", "fulfilmentType" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/skus/many": { "post": { "summary": "Create multiple SKUs", "tags": [ "skus" ], "parameters": [], "operationId": "internal.skus.createSkus", "responses": { "201": { "description": "201" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/skus/validate-codes": { "post": { "summary": "Validate codes to ensure they are unique and valid", "tags": [ "skus" ], "parameters": [], "operationId": "internal.skus.validateCodes", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "codes": { "type": "array", "items": { "type": "string" } } }, "required": [ "codes" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "invalid": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "reason": { "type": "string", "enum": [ "existing" ] } }, "required": [ "code", "reason" ], "additionalProperties": false } } }, "required": [ "invalid" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/skus/delete": { "post": { "summary": "Delete many SKUs", "tags": [ "skus" ], "parameters": [], "operationId": "internal.skus.deleteManySkus", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/field-values": { "get": { "summary": "Get unique values for a given field", "tags": [ "skus" ], "parameters": [ { "name": "field", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "name", "code" ] } } ], "operationId": "internal.skus.getFieldValues", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/internal/field-values-search": { "get": { "summary": "Search values for a given field", "tags": [ "skus" ], "parameters": [ { "name": "field", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "name", "code" ] } }, { "name": "search", "in": "query", "required": true, "schema": { "type": "string" } } ], "operationId": "internal.skus.searchFieldValues", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/storefront/site/site": { "get": { "summary": "Get public site information", "tags": [ "storefront", "site" ], "parameters": [], "operationId": "storefront.site.getSiteInfo", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "logoUrl": { "type": "string" }, "languages": { "type": "array", "items": { "type": "string" } }, "currency": { "type": "object", "properties": { "code": { "type": "string" }, "symbol": { "type": "string" }, "position": { "type": "string", "enum": [ "prefix", "prefix-no-space", "suffix", "suffix-no-space" ] } }, "required": [ "code", "symbol", "position" ], "additionalProperties": false }, "dateTimeFormat": { "type": "object", "properties": { "dateFormat": { "type": "string", "enum": [ "DD.MM.YYYY", "MM/DD/YYYY", "YYYY-MM-DD" ] }, "timeFormat": { "type": "string", "enum": [ "HH:mm", "hh:mm A" ] }, "startDay": { "type": "string", "enum": [ "monday", "saturday", "sunday" ] } }, "required": [ "dateFormat", "timeFormat", "startDay" ], "additionalProperties": false }, "unitSystem": { "type": "string", "enum": [ "METRIC", "US", "UK", "AU" ] }, "storeCount": { "type": "number" }, "timezone": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Brazil/Acre", "Australia/ACT", "America/Adak", "Africa/Addis_Ababa", "Australia/Adelaide", "Asia/Aden", "US/Alaska", "US/Aleutian", "Africa/Algiers", "Asia/Almaty", "Asia/Amman", "Europe/Amsterdam", "Asia/Anadyr", "America/Anchorage", "Europe/Andorra", "America/Anguilla", "Indian/Antananarivo", "America/Antigua", "Pacific/Apia", "Asia/Aqtau", "Asia/Aqtobe", "America/Araguaina", "US/Arizona", "America/Aruba", "Asia/Ashgabat", "Asia/Ashkhabad", "Africa/Asmara", "Africa/Asmera", "Europe/Astrakhan", "America/Asuncion", "Europe/Athens", "America/Atikokan", "America/Atka", "Canada/Atlantic", "Asia/Atyrau", "Pacific/Auckland", "Atlantic/Azores", "Asia/Baghdad", "America/Bahia", "America/Bahia_Banderas", "Asia/Bahrain", "Mexico/BajaNorte", "Mexico/BajaSur", "Asia/Baku", "Africa/Bamako", "Asia/Bangkok", "Africa/Bangui", "Africa/Banjul", "America/Barbados", "Asia/Barnaul", "Asia/Beirut", "America/Belem", "Europe/Belfast", "Europe/Belgrade", "America/Belize", "Europe/Berlin", "Atlantic/Bermuda", "America/North_Dakota/Beulah", "Asia/Bishkek", "Africa/Bissau", "America/Blanc-Sablon", "Africa/Blantyre", "America/Boa_Vista", "America/Bogota", "America/Boise", "Pacific/Bougainville", "Europe/Bratislava", "Africa/Brazzaville", "Australia/Brisbane", "Australia/Broken_Hill", "Asia/Brunei", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "America/Buenos_Aires", "America/Argentina/Buenos_Aires", "Africa/Bujumbura", "Europe/Busingen", "Africa/Cairo", "Asia/Calcutta", "America/Cambridge_Bay", "America/Campo_Grande", "Atlantic/Canary", "Australia/Canberra", "America/Cancun", "Atlantic/Cape_Verde", "America/Caracas", "Africa/Casablanca", "Antarctica/Casey", "America/Catamarca", "America/Argentina/Catamarca", "America/Cayenne", "America/Cayman", "America/North_Dakota/Center", "US/Central", "Canada/Central", "CET", "Africa/Ceuta", "Indian/Chagos", "Pacific/Chatham", "America/Chicago", "America/Chihuahua", "Europe/Chisinau", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Indian/Christmas", "Asia/Chungking", "Pacific/Chuuk", "Indian/Cocos", "Asia/Colombo", "America/Argentina/ComodRivadavia", "Indian/Comoro", "Africa/Conakry", "Chile/Continental", "Europe/Copenhagen", "America/Coral_Harbour", "America/Cordoba", "America/Argentina/Cordoba", "America/Costa_Rica", "America/Creston", "CST6CDT", "Cuba", "America/Cuiaba", "America/Curacao", "Australia/Currie", "Asia/Dacca", "Africa/Dakar", "Asia/Damascus", "America/Danmarkshavn", "Africa/Dar_es_Salaam", "Australia/Darwin", "Antarctica/Davis", "America/Dawson", "America/Dawson_Creek", "Brazil/DeNoronha", "America/Denver", "America/Detroit", "Asia/Dhaka", "Asia/Dili", "Africa/Djibouti", "America/Dominica", "Africa/Douala", "Asia/Dubai", "Europe/Dublin", "Antarctica/DumontDUrville", "Asia/Dushanbe", "Brazil/East", "US/East-Indiana", "Pacific/Easter", "Chile/EasterIsland", "US/Eastern", "Canada/Eastern", "America/Edmonton", "EET", "Pacific/Efate", "Egypt", "Eire", "America/Eirunepe", "Africa/El_Aaiun", "America/El_Salvador", "Pacific/Enderbury", "America/Ensenada", "EST", "EST5EDT", "Australia/Eucla", "Atlantic/Faeroe", "Pacific/Fakaofo", "Asia/Famagusta", "Atlantic/Faroe", "Pacific/Fiji", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "Africa/Freetown", "Pacific/Funafuti", "Africa/Gaborone", "Pacific/Galapagos", "Pacific/Gambier", "Asia/Gaza", "GB", "GB-Eire", "Mexico/General", "Europe/Gibraltar", "America/Glace_Bay", "Etc/GMT", "GMT", "GMT-0", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT+0", "GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT0", "GMT0", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "Etc/Greenwich", "Greenwich", "America/Grenada", "Pacific/Guadalcanal", "America/Guadeloupe", "Pacific/Guam", "America/Guatemala", "America/Guayaquil", "Europe/Guernsey", "America/Guyana", "America/Halifax", "Africa/Harare", "Asia/Harbin", "America/Havana", "US/Hawaii", "Asia/Hebron", "Europe/Helsinki", "America/Hermosillo", "Asia/Ho_Chi_Minh", "Australia/Hobart", "Asia/Hong_Kong", "Hongkong", "Pacific/Honolulu", "Asia/Hovd", "HST", "Iceland", "US/Indiana-Starke", "America/Indiana/Indianapolis", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "Iran", "Asia/Irkutsk", "Europe/Isle_of_Man", "Israel", "Asia/Istanbul", "Europe/Istanbul", "Asia/Jakarta", "Jamaica", "America/Jamaica", "Atlantic/Jan_Mayen", "Japan", "Asia/Jayapura", "Europe/Jersey", "Asia/Jerusalem", "Africa/Johannesburg", "Pacific/Johnston", "Africa/Juba", "America/Jujuy", "America/Argentina/Jujuy", "America/Juneau", "Asia/Kabul", "Europe/Kaliningrad", "Asia/Kamchatka", "Africa/Kampala", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Indian/Kerguelen", "Asia/Khandyga", "Africa/Khartoum", "Europe/Kiev", "Africa/Kigali", "Africa/Kinshasa", "Pacific/Kiritimati", "Europe/Kirov", "America/Indiana/Knox", "America/Knox_IN", "Asia/Kolkata", "Pacific/Kosrae", "America/Kralendijk", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Kwajalein", "Pacific/Kwajalein", "America/La_Paz", "America/Argentina/La_Rioja", "Africa/Lagos", "Australia/LHI", "Africa/Libreville", "Libya", "America/Lima", "Australia/Lindeman", "Europe/Lisbon", "Europe/Ljubljana", "Africa/Lome", "Europe/London", "Arctic/Longyearbyen", "Australia/Lord_Howe", "America/Los_Angeles", "America/Louisville", "America/Kentucky/Louisville", "America/Lower_Princes", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Europe/Luxembourg", "Asia/Macao", "Asia/Macau", "America/Maceio", "Antarctica/Macquarie", "Atlantic/Madeira", "Europe/Madrid", "Asia/Magadan", "Indian/Mahe", "Pacific/Majuro", "Asia/Makassar", "Africa/Malabo", "Indian/Maldives", "Europe/Malta", "America/Managua", "America/Manaus", "Asia/Manila", "Africa/Maputo", "America/Indiana/Marengo", "Europe/Mariehamn", "America/Marigot", "Pacific/Marquesas", "America/Martinique", "Africa/Maseru", "America/Matamoros", "Indian/Mauritius", "Antarctica/Mawson", "Indian/Mayotte", "America/Mazatlan", "Africa/Mbabane", "Antarctica/McMurdo", "Australia/Melbourne", "America/Mendoza", "America/Argentina/Mendoza", "America/Menominee", "America/Merida", "MET", "America/Metlakatla", "America/Mexico_City", "US/Michigan", "Pacific/Midway", "Europe/Minsk", "America/Miquelon", "Africa/Mogadishu", "Europe/Monaco", "America/Moncton", "Africa/Monrovia", "America/Monterrey", "America/Montevideo", "America/Kentucky/Monticello", "America/Montreal", "America/Montserrat", "Europe/Moscow", "US/Mountain", "Canada/Mountain", "MST", "MST7MDT", "Asia/Muscat", "Africa/Nairobi", "America/Nassau", "Pacific/Nauru", "Navajo", "Africa/Ndjamena", "America/North_Dakota/New_Salem", "America/New_York", "Canada/Newfoundland", "Africa/Niamey", "Europe/Nicosia", "Asia/Nicosia", "America/Nipigon", "Pacific/Niue", "America/Nome", "Pacific/Norfolk", "America/Noronha", "Australia/North", "Africa/Nouakchott", "Pacific/Noumea", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Australia/NSW", "America/Nuuk", "NZ", "NZ-CHAT", "America/Ojinaga", "Asia/Omsk", "Asia/Oral", "Europe/Oslo", "Africa/Ouagadougou", "US/Pacific", "Canada/Pacific", "Pacific/Pago_Pago", "Pacific/Palau", "Antarctica/Palmer", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "Europe/Paris", "Australia/Perth", "America/Indiana/Petersburg", "Asia/Phnom_Penh", "America/Phoenix", "Pacific/Pitcairn", "Europe/Podgorica", "Pacific/Pohnpei", "Poland", "Pacific/Ponape", "Asia/Pontianak", "Pacific/Port_Moresby", "America/Port_of_Spain", "America/Port-au-Prince", "America/Porto_Acre", "America/Porto_Velho", "Africa/Porto-Novo", "Portugal", "Europe/Prague", "PRC", "PST8PDT", "America/Puerto_Rico", "America/Punta_Arenas", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Australia/Queensland", "Asia/Qyzylorda", "America/Rainy_River", "Asia/Rangoon", "America/Rankin_Inlet", "Pacific/Rarotonga", "America/Recife", "America/Regina", "America/Resolute", "Indian/Reunion", "Atlantic/Reykjavik", "Europe/Riga", "America/Rio_Branco", "America/Argentina/Rio_Gallegos", "Asia/Riyadh", "ROC", "ROK", "Europe/Rome", "America/Rosario", "Antarctica/Rothera", "Asia/Saigon", "Pacific/Saipan", "Asia/Sakhalin", "America/Argentina/Salta", "Europe/Samara", "Asia/Samarkand", "Pacific/Samoa", "US/Samoa", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "Europe/San_Marino", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "Africa/Sao_Tome", "Europe/Sarajevo", "Europe/Saratov", "Canada/Saskatchewan", "America/Scoresbysund", "Asia/Seoul", "Asia/Shanghai", "America/Shiprock", "Europe/Simferopol", "Asia/Singapore", "Singapore", "America/Sitka", "Europe/Skopje", "Europe/Sofia", "Australia/South", "Atlantic/South_Georgia", "Antarctica/South_Pole", "Asia/Srednekolymsk", "America/St_Barthelemy", "Atlantic/St_Helena", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "Atlantic/Stanley", "Europe/Stockholm", "America/Swift_Current", "Australia/Sydney", "Antarctica/Syowa", "Pacific/Tahiti", "Asia/Taipei", "Europe/Tallinn", "Pacific/Tarawa", "Asia/Tashkent", "Australia/Tasmania", "Asia/Tbilisi", "America/Tegucigalpa", "Asia/Tehran", "Asia/Tel_Aviv", "America/Indiana/Tell_City", "Asia/Thimbu", "Asia/Thimphu", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "Africa/Timbuktu", "Europe/Tirane", "Europe/Tiraspol", "Asia/Tokyo", "Asia/Tomsk", "Pacific/Tongatapu", "America/Toronto", "America/Tortola", "Africa/Tripoli", "Antarctica/Troll", "Pacific/Truk", "America/Argentina/Tucuman", "Africa/Tunis", "Turkey", "Etc/UCT", "UCT", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Europe/Ulyanovsk", "Etc/Universal", "Universal", "Asia/Urumqi", "America/Argentina/Ushuaia", "Asia/Ust-Nera", "UTC", "Etc/UTC", "Europe/Uzhgorod", "Europe/Vaduz", "America/Vancouver", "Europe/Vatican", "America/Indiana/Vevay", "Australia/Victoria", "Europe/Vienna", "Asia/Vientiane", "Europe/Vilnius", "America/Indiana/Vincennes", "America/Virgin", "Asia/Vladivostok", "Europe/Volgograd", "Antarctica/Vostok", "W-SU", "Pacific/Wake", "Pacific/Wallis", "Europe/Warsaw", "Brazil/West", "Australia/West", "WET", "America/Whitehorse", "America/Indiana/Winamac", "Africa/Windhoek", "America/Winnipeg", "America/Yakutat", "Asia/Yakutsk", "Australia/Yancowinna", "Asia/Yangon", "Pacific/Yap", "Asia/Yekaterinburg", "America/Yellowknife", "Asia/Yerevan", "Canada/Yukon", "Europe/Zagreb", "Europe/Zaporozhye", "Etc/Zulu", "Zulu", "Europe/Zurich" ] } }, "required": [ "id", "name", "languages", "currency", "dateTimeFormat", "unitSystem", "storeCount", "timezone" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/storefront/site/stores": { "get": { "summary": "Get all stores/pickup points", "tags": [ "storefront", "site" ], "parameters": [ { "name": "active", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "operationId": "storefront.site.getStores", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/storefront/site/stores/{storeId}": { "get": { "summary": "Get specific store/pickup point by ID", "tags": [ "storefront", "site" ], "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "storefront.site.getStore", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "address": { "nullable": true, "type": "object", "properties": { "address": { "type": "string" }, "zipCode": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "details": { "type": "string" } }, "required": [ "address" ], "additionalProperties": false }, "openingHours": { "type": "array", "items": { "type": "object", "properties": { "validityDateRange": { "nullable": true, "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "weekday": { "nullable": true, "type": "number", "minimum": 1, "maximum": 7 }, "specificDate": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timeRanges": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } }, "isClosed": { "default": false, "type": "boolean" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "serviceLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "validityDateRange", "weekday", "specificDate", "timeRanges", "isClosed", "id", "serviceLocationId", "createdAt" ], "additionalProperties": false } } }, "required": [ "id", "name", "address", "openingHours" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "500": { "description": "500" } } } }, "/storefront/catalog/collections": { "get": { "summary": "Get collections", "tags": [ "storefront", "catalog" ], "parameters": [], "operationId": "storefront.catalog.getCollections", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/storefront/catalog/collections/{collectionId}": { "get": { "summary": "Get collection by ID", "tags": [ "storefront", "catalog" ], "parameters": [ { "name": "collectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "storefront.catalog.getCollection", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "description": { "type": "string" }, "imageUrl": { "type": "string", "format": "uri" }, "productCount": { "type": "number" } }, "required": [ "id", "name", "productCount" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "500": { "description": "500" } } } }, "/storefront/catalog/products": { "get": { "summary": "Get paginated product listing with filters", "tags": [ "storefront", "catalog" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "collectionId", "in": "query", "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "operationId": "storefront.catalog.getProducts", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "imageUrls": { "nullable": true, "type": "array", "items": { "type": "string" } }, "purchaseOptions": { "type": "array", "items": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] } }, "bookingPricingTypes": { "type": "array", "items": { "type": "string", "enum": [ "fixed", "dynamic" ] } }, "priceFrom": { "nullable": true, "type": "object", "properties": { "amount": { "type": "number" }, "timePeriod": { "nullable": true, "type": "object", "properties": { "unit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "value": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 } }, "required": [ "unit", "value" ], "additionalProperties": false } }, "required": [ "amount", "timePeriod" ], "additionalProperties": false }, "availability": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false }, "byVariantValue": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false } } }, "required": [ "total", "byVariantValue" ], "additionalProperties": false }, "byLocation": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false }, "byVariantValue": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false } } }, "required": [ "total", "byVariantValue" ], "additionalProperties": false } } }, "required": [ "total", "byLocation" ], "additionalProperties": false }, "variants": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "values" ], "additionalProperties": false } } }, "required": [ "id", "name", "description", "imageUrls", "purchaseOptions", "bookingPricingTypes", "priceFrom", "availability", "variants" ], "additionalProperties": false } }, "pagination": { "type": "object", "properties": { "page": { "type": "number" }, "limit": { "type": "number" }, "total": { "type": "number" }, "pages": { "type": "number" } }, "required": [ "page", "limit", "total", "pages" ], "additionalProperties": false } }, "required": [ "data", "pagination" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/storefront/catalog/products/{productId}": { "get": { "summary": "Get detailed product info by ID", "tags": [ "storefront", "catalog" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, { "name": "selectedVariants", "in": "query", "schema": { "type": "object", "additionalProperties": { "description": "Variant Value ID", "type": "string" } } }, { "name": "catalogItemFilters", "in": "query", "style": "deepObject", "schema": { "type": "object", "properties": { "serviceLocationIds": { "type": "array", "items": { "type": "string" } }, "ids": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "draft" ] }, "search": { "type": "string" } }, "additionalProperties": false } }, { "name": "existingSelection", "in": "query", "schema": { "type": "array", "items": { "type": "object", "properties": { "selectionId": { "description": "Selection ID, used to identify the selection in response", "type": "string" }, "catalogItemId": { "type": "string" }, "selectedVariants": { "type": "object", "additionalProperties": { "type": "string" } }, "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pricingRowId": { "nullable": true, "type": "string" }, "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "selectionId", "catalogItemId", "quantity", "pricingRowId", "start", "end" ], "additionalProperties": false } } } ], "operationId": "storefront.catalog.getProduct", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "imageUrls": { "nullable": true, "type": "array", "items": { "type": "string" } }, "purchaseOptions": { "type": "array", "items": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] } }, "bookingPricingTypes": { "type": "array", "items": { "type": "string", "enum": [ "fixed", "dynamic" ] } }, "priceFrom": { "nullable": true, "type": "object", "properties": { "amount": { "type": "number" }, "timePeriod": { "nullable": true, "type": "object", "properties": { "unit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "value": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 } }, "required": [ "unit", "value" ], "additionalProperties": false } }, "required": [ "amount", "timePeriod" ], "additionalProperties": false }, "availability": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false }, "byVariantValue": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false } } }, "required": [ "total", "byVariantValue" ], "additionalProperties": false }, "byLocation": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false }, "byVariantValue": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false } } }, "required": [ "total", "byVariantValue" ], "additionalProperties": false } } }, "required": [ "total", "byLocation" ], "additionalProperties": false }, "variants": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "values" ], "additionalProperties": false } }, "bookingOptions": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "pricingRowId": { "type": "string" }, "label": { "nullable": true, "type": "string" }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "timeUnitAmount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991 }, "timeUnitPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "isDynamicPricing": { "type": "boolean" }, "variantPriceContributions": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "variantValueId": { "type": "string" }, "priceContribution": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "variantId", "variantValueId", "priceContribution" ], "additionalProperties": false } }, "availability": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false }, "byVariantValue": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false } } }, "required": [ "total", "byVariantValue" ], "additionalProperties": false }, "byLocation": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false }, "byVariantValue": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false } } }, "required": [ "total", "byVariantValue" ], "additionalProperties": false } } }, "required": [ "total", "byLocation" ], "additionalProperties": false }, "valid": { "type": "boolean" }, "invalidReason": { "type": "string" }, "calculatedPrice": { "nullable": true, "type": "number" } }, "required": [ "pricingRowId", "label", "timeUnit", "timeUnitAmount", "timeUnitPrice", "isDynamicPricing", "variantPriceContributions", "availability", "valid", "calculatedPrice" ], "additionalProperties": false } }, "salesOption": { "nullable": true, "type": "object", "properties": { "pricingRowId": { "type": "string" }, "basePrice": { "type": "number" }, "compareAtPrice": { "nullable": true, "type": "number" }, "tax": { "type": "number" }, "variantPriceContributions": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string" }, "variantValueId": { "type": "string" }, "priceContribution": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "variantId", "variantValueId", "priceContribution" ], "additionalProperties": false } }, "availability": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false }, "byVariantValue": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false } } }, "required": [ "total", "byVariantValue" ], "additionalProperties": false }, "byLocation": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false }, "byVariantValue": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" } }, "required": [ "total", "available" ], "additionalProperties": false } } }, "required": [ "total", "byVariantValue" ], "additionalProperties": false } } }, "required": [ "total", "byLocation" ], "additionalProperties": false }, "calculatedPrice": { "nullable": true, "type": "number" } }, "required": [ "pricingRowId", "basePrice", "compareAtPrice", "tax", "variantPriceContributions", "availability", "calculatedPrice" ], "additionalProperties": false }, "checkoutRequirements": { "type": "object", "properties": { "assignToCustomer": { "type": "boolean" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "attributeFormat": { "type": "string", "enum": [ "text", "number", "boolean", "date", "datetime", "formula" ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } }, "required": [ "assignToCustomer", "fields" ], "additionalProperties": false } }, "required": [ "id", "name", "description", "imageUrls", "purchaseOptions", "bookingPricingTypes", "priceFrom", "availability", "variants", "bookingOptions", "salesOption" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "500": { "description": "500" } } } }, "/storefront/catalog/products/{productId}/availability": { "get": { "summary": "Get product availability", "tags": [ "storefront", "catalog" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, { "name": "selectedVariants", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "locationIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "operationId": "storefront.catalog.getProductAvailability", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "availability": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "total": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" }, "unavailable": { "nullable": true, "type": "number" } }, "required": [ "total", "available", "unavailable" ], "additionalProperties": false }, "byLocation": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "nullable": true, "type": "number" }, "available": { "nullable": true, "type": "number" }, "unavailable": { "nullable": true, "type": "number" } }, "required": [ "total", "available", "unavailable" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "byLocation" ], "additionalProperties": false } } }, "required": [ "availability" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/storefront/catalog/products/{productId}/booking-rows": { "get": { "summary": "Get available booking rows", "tags": [ "storefront", "catalog" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, { "name": "selectedVariants", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "locationIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "operationId": "storefront.catalog.getAvailablePricingTables", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/storefront/catalog/validate-selection": { "post": { "summary": "Validate selection", "tags": [ "storefront", "catalog" ], "parameters": [], "operationId": "storefront.catalog.validateSelection", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "serviceLocationId": { "type": "string" }, "selection": { "type": "array", "items": { "type": "object", "properties": { "selectionId": { "description": "Selection ID, used to identify the selection in response", "type": "string" }, "catalogItemId": { "type": "string" }, "selectedVariants": { "type": "object", "additionalProperties": { "type": "string" } }, "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pricingRowId": { "nullable": true, "type": "string" }, "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "selectionId", "catalogItemId", "quantity", "pricingRowId", "start", "end" ], "additionalProperties": false } }, "orderIdToModify": { "type": "string" } }, "required": [ "selection" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "issues": { "type": "object", "additionalProperties": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "unavailable", "missing_variants", "invalid_selection" ] }, "details": { "type": "object", "properties": { "maxAvailable": { "type": "number" } }, "additionalProperties": false } }, "required": [ "code" ], "additionalProperties": false } } }, "required": [ "valid" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/storefront/cart/": { "post": { "summary": "Create new cart (returns cart ID or session token)", "tags": [ "storefront", "cart" ], "parameters": [], "operationId": "storefront.cart.createCart", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "locationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "additionalProperties": false } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/storefront/cart/{cartId}/validate": { "get": { "summary": "Validate cart ID", "tags": [ "storefront", "cart" ], "parameters": [ { "name": "cartId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "storefront.cart.validateCartId", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/storefront/cart/{cartId}": { "get": { "summary": "Get cart", "tags": [ "storefront", "cart" ], "parameters": [ { "name": "cartId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "storefront.cart.getCart", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "listingId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "listingName": { "type": "string" }, "listingImageUrl": { "type": "string", "format": "uri" }, "selectedVariants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "valueId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "valueName": { "type": "string" } }, "required": [ "id", "name", "valueId", "valueName" ], "additionalProperties": false } }, "quantity": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "unitPricing": { "type": "object", "properties": { "currency": { "type": "string" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "subtotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalInfo": { "type": "string" }, "totalTaxes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscounts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "taxExcluded": { "type": "boolean" }, "taxLines": { "type": "array", "items": { "type": "object", "properties": { "combinedLabel": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "label": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "price": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "price", "rate" ], "additionalProperties": false } }, "discountCodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscountValue": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "quantity", "totalDiscountValue" ], "additionalProperties": false } }, "manualDiscount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deposit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "listPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "originalListPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "currency", "total", "subtotal", "totalTaxes", "totalDiscounts", "taxExcluded", "taxLines", "listPrice", "originalListPrice" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "sales", "booking" ] }, "pricingRowId": { "nullable": true, "type": "string" }, "booking": { "nullable": true, "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "label": { "nullable": true, "type": "string" }, "timeUnitAmount": { "type": "number" }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "type": { "type": "string", "enum": [ "fixed", "dynamic" ] } }, "required": [ "start", "end", "label", "timeUnitAmount", "timeUnit", "type" ], "additionalProperties": false }, "filledDetails": { "type": "array", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "fieldId": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "required": [ "name", "fieldId", "value" ], "additionalProperties": false } } }, "required": [ "fields" ], "additionalProperties": false } } }, "required": [ "id", "listingName", "quantity", "unitPricing", "type", "pricingRowId", "booking" ], "additionalProperties": false } }, "pricing": { "type": "object", "properties": { "currency": { "type": "string" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "subtotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalInfo": { "type": "string" }, "totalTaxes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscounts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "taxExcluded": { "type": "boolean" }, "taxLines": { "type": "array", "items": { "type": "object", "properties": { "combinedLabel": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "label": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "price": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "price", "rate" ], "additionalProperties": false } }, "discountCodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscountValue": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "quantity", "totalDiscountValue" ], "additionalProperties": false } }, "manualDiscount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deposit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "listPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "originalListPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "currency", "total", "subtotal", "totalTaxes", "totalDiscounts", "taxExcluded", "taxLines", "listPrice", "originalListPrice" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "locationId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "state": { "type": "string", "enum": [ "draft", "locked", "completed" ] }, "termsAcceptance": { "type": "object", "properties": { "accepted": { "type": "boolean" }, "timestamp": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "accepted" ], "additionalProperties": false }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string" }, "marketingConsent": { "type": "boolean" }, "address": { "type": "object", "properties": { "address": { "type": "string" }, "zipCode": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "details": { "type": "string" } }, "required": [ "address" ], "additionalProperties": false }, "isMainContact": { "type": "boolean" } }, "required": [ "id", "firstName", "isMainContact" ], "additionalProperties": false } } }, "required": [ "id", "items", "createdAt", "updatedAt", "locationId", "state" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Clear all items from cart", "tags": [ "storefront", "cart" ], "parameters": [ { "name": "cartId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "storefront.cart.clearCart", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/storefront/cart/{cartId}/checkout-requirements": { "get": { "summary": "Get checkout requirements for cart", "tags": [ "storefront", "cart" ], "parameters": [ { "name": "cartId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "storefront.cart.getCartCheckoutRequirements", "responses": { "200": { "description": "200" }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/storefront/cart/{cartId}/items": { "post": { "summary": "Add item to cart", "tags": [ "storefront", "cart" ], "parameters": [ { "name": "cartId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "storefront.cart.addItem", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "selectedVariants": { "type": "object", "additionalProperties": { "type": "string" } }, "quantity": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "type": { "type": "string", "enum": [ "sales", "booking" ] }, "pricingRowId": { "nullable": true, "type": "string" }, "booking": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "type": { "type": "string", "enum": [ "fixed", "dynamic" ] } }, "required": [ "start", "end", "type" ], "additionalProperties": false } }, "required": [ "listingId", "quantity", "type", "pricingRowId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "listingId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "listingName": { "type": "string" }, "listingImageUrl": { "type": "string", "format": "uri" }, "selectedVariants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "valueId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "valueName": { "type": "string" } }, "required": [ "id", "name", "valueId", "valueName" ], "additionalProperties": false } }, "quantity": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "unitPricing": { "type": "object", "properties": { "currency": { "type": "string" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "subtotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalInfo": { "type": "string" }, "totalTaxes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscounts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "taxExcluded": { "type": "boolean" }, "taxLines": { "type": "array", "items": { "type": "object", "properties": { "combinedLabel": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "label": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "price": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "price", "rate" ], "additionalProperties": false } }, "discountCodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscountValue": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "quantity", "totalDiscountValue" ], "additionalProperties": false } }, "manualDiscount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deposit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "listPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "originalListPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "currency", "total", "subtotal", "totalTaxes", "totalDiscounts", "taxExcluded", "taxLines", "listPrice", "originalListPrice" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "sales", "booking" ] }, "pricingRowId": { "nullable": true, "type": "string" }, "booking": { "nullable": true, "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "label": { "nullable": true, "type": "string" }, "timeUnitAmount": { "type": "number" }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "type": { "type": "string", "enum": [ "fixed", "dynamic" ] } }, "required": [ "start", "end", "label", "timeUnitAmount", "timeUnit", "type" ], "additionalProperties": false }, "filledDetails": { "type": "array", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "fieldId": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "required": [ "name", "fieldId", "value" ], "additionalProperties": false } } }, "required": [ "fields" ], "additionalProperties": false } } }, "required": [ "id", "listingName", "quantity", "unitPricing", "type", "pricingRowId", "booking" ], "additionalProperties": false } }, "pricing": { "type": "object", "properties": { "currency": { "type": "string" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "subtotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalInfo": { "type": "string" }, "totalTaxes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscounts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "taxExcluded": { "type": "boolean" }, "taxLines": { "type": "array", "items": { "type": "object", "properties": { "combinedLabel": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "label": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "price": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "price", "rate" ], "additionalProperties": false } }, "discountCodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscountValue": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "quantity", "totalDiscountValue" ], "additionalProperties": false } }, "manualDiscount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deposit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "listPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "originalListPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "currency", "total", "subtotal", "totalTaxes", "totalDiscounts", "taxExcluded", "taxLines", "listPrice", "originalListPrice" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "locationId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "state": { "type": "string", "enum": [ "draft", "locked", "completed" ] }, "termsAcceptance": { "type": "object", "properties": { "accepted": { "type": "boolean" }, "timestamp": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "accepted" ], "additionalProperties": false }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string" }, "marketingConsent": { "type": "boolean" }, "address": { "type": "object", "properties": { "address": { "type": "string" }, "zipCode": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "details": { "type": "string" } }, "required": [ "address" ], "additionalProperties": false }, "isMainContact": { "type": "boolean" } }, "required": [ "id", "firstName", "isMainContact" ], "additionalProperties": false } } }, "required": [ "id", "items", "createdAt", "updatedAt", "locationId", "state" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/storefront/cart/{cartId}/items/{itemId}": { "patch": { "summary": "Update quantity of item in cart", "tags": [ "storefront", "cart" ], "parameters": [ { "name": "cartId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "storefront.cart.updateItem", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "quantity": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": [ "quantity" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "listingId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "listingName": { "type": "string" }, "listingImageUrl": { "type": "string", "format": "uri" }, "selectedVariants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "valueId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "valueName": { "type": "string" } }, "required": [ "id", "name", "valueId", "valueName" ], "additionalProperties": false } }, "quantity": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "unitPricing": { "type": "object", "properties": { "currency": { "type": "string" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "subtotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalInfo": { "type": "string" }, "totalTaxes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscounts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "taxExcluded": { "type": "boolean" }, "taxLines": { "type": "array", "items": { "type": "object", "properties": { "combinedLabel": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "label": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "price": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "price", "rate" ], "additionalProperties": false } }, "discountCodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscountValue": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "quantity", "totalDiscountValue" ], "additionalProperties": false } }, "manualDiscount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deposit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "listPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "originalListPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "currency", "total", "subtotal", "totalTaxes", "totalDiscounts", "taxExcluded", "taxLines", "listPrice", "originalListPrice" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "sales", "booking" ] }, "pricingRowId": { "nullable": true, "type": "string" }, "booking": { "nullable": true, "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "label": { "nullable": true, "type": "string" }, "timeUnitAmount": { "type": "number" }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "type": { "type": "string", "enum": [ "fixed", "dynamic" ] } }, "required": [ "start", "end", "label", "timeUnitAmount", "timeUnit", "type" ], "additionalProperties": false }, "filledDetails": { "type": "array", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "fieldId": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "required": [ "name", "fieldId", "value" ], "additionalProperties": false } } }, "required": [ "fields" ], "additionalProperties": false } } }, "required": [ "id", "listingName", "quantity", "unitPricing", "type", "pricingRowId", "booking" ], "additionalProperties": false } }, "pricing": { "type": "object", "properties": { "currency": { "type": "string" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "subtotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalInfo": { "type": "string" }, "totalTaxes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscounts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "taxExcluded": { "type": "boolean" }, "taxLines": { "type": "array", "items": { "type": "object", "properties": { "combinedLabel": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "label": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "price": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "price", "rate" ], "additionalProperties": false } }, "discountCodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscountValue": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "quantity", "totalDiscountValue" ], "additionalProperties": false } }, "manualDiscount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deposit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "listPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "originalListPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "currency", "total", "subtotal", "totalTaxes", "totalDiscounts", "taxExcluded", "taxLines", "listPrice", "originalListPrice" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "locationId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "state": { "type": "string", "enum": [ "draft", "locked", "completed" ] }, "termsAcceptance": { "type": "object", "properties": { "accepted": { "type": "boolean" }, "timestamp": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "accepted" ], "additionalProperties": false }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string" }, "marketingConsent": { "type": "boolean" }, "address": { "type": "object", "properties": { "address": { "type": "string" }, "zipCode": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "details": { "type": "string" } }, "required": [ "address" ], "additionalProperties": false }, "isMainContact": { "type": "boolean" } }, "required": [ "id", "firstName", "isMainContact" ], "additionalProperties": false } } }, "required": [ "id", "items", "createdAt", "updatedAt", "locationId", "state" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } }, "delete": { "summary": "Remove item from cart", "tags": [ "storefront", "cart" ], "parameters": [ { "name": "cartId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "storefront.cart.removeItem", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "listingId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "listingName": { "type": "string" }, "listingImageUrl": { "type": "string", "format": "uri" }, "selectedVariants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "valueId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "valueName": { "type": "string" } }, "required": [ "id", "name", "valueId", "valueName" ], "additionalProperties": false } }, "quantity": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "unitPricing": { "type": "object", "properties": { "currency": { "type": "string" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "subtotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalInfo": { "type": "string" }, "totalTaxes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscounts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "taxExcluded": { "type": "boolean" }, "taxLines": { "type": "array", "items": { "type": "object", "properties": { "combinedLabel": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "label": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "price": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "price", "rate" ], "additionalProperties": false } }, "discountCodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscountValue": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "quantity", "totalDiscountValue" ], "additionalProperties": false } }, "manualDiscount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deposit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "listPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "originalListPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "currency", "total", "subtotal", "totalTaxes", "totalDiscounts", "taxExcluded", "taxLines", "listPrice", "originalListPrice" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "sales", "booking" ] }, "pricingRowId": { "nullable": true, "type": "string" }, "booking": { "nullable": true, "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "label": { "nullable": true, "type": "string" }, "timeUnitAmount": { "type": "number" }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "type": { "type": "string", "enum": [ "fixed", "dynamic" ] } }, "required": [ "start", "end", "label", "timeUnitAmount", "timeUnit", "type" ], "additionalProperties": false }, "filledDetails": { "type": "array", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "fieldId": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "required": [ "name", "fieldId", "value" ], "additionalProperties": false } } }, "required": [ "fields" ], "additionalProperties": false } } }, "required": [ "id", "listingName", "quantity", "unitPricing", "type", "pricingRowId", "booking" ], "additionalProperties": false } }, "pricing": { "type": "object", "properties": { "currency": { "type": "string" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "subtotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalInfo": { "type": "string" }, "totalTaxes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscounts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "taxExcluded": { "type": "boolean" }, "taxLines": { "type": "array", "items": { "type": "object", "properties": { "combinedLabel": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "label": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "price": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "price", "rate" ], "additionalProperties": false } }, "discountCodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscountValue": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "quantity", "totalDiscountValue" ], "additionalProperties": false } }, "manualDiscount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deposit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "listPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "originalListPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "currency", "total", "subtotal", "totalTaxes", "totalDiscounts", "taxExcluded", "taxLines", "listPrice", "originalListPrice" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "locationId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "state": { "type": "string", "enum": [ "draft", "locked", "completed" ] }, "termsAcceptance": { "type": "object", "properties": { "accepted": { "type": "boolean" }, "timestamp": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "accepted" ], "additionalProperties": false }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string" }, "marketingConsent": { "type": "boolean" }, "address": { "type": "object", "properties": { "address": { "type": "string" }, "zipCode": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "details": { "type": "string" } }, "required": [ "address" ], "additionalProperties": false }, "isMainContact": { "type": "boolean" } }, "required": [ "id", "firstName", "isMainContact" ], "additionalProperties": false } } }, "required": [ "id", "items", "createdAt", "updatedAt", "locationId", "state" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/storefront/cart/{cartId}/checkout-data": { "patch": { "summary": "Update checkout data for cart", "tags": [ "storefront", "cart" ], "parameters": [ { "name": "cartId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "operationId": "storefront.cart.updateCartCheckoutData", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "locationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "termsAccepted": { "type": "boolean" }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string" }, "marketingConsent": { "type": "boolean" }, "address": { "type": "object", "properties": { "address": { "type": "string" }, "zipCode": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "details": { "type": "string" } }, "required": [ "address" ], "additionalProperties": false }, "isMainContact": { "type": "boolean" } }, "required": [ "id" ], "additionalProperties": false } }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "filledDetails": { "type": "array", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "fieldId": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "required": [ "name", "fieldId", "value" ], "additionalProperties": false } } }, "required": [ "fields" ], "additionalProperties": false } } }, "required": [ "id" ], "additionalProperties": false } } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "listingId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "listingName": { "type": "string" }, "listingImageUrl": { "type": "string", "format": "uri" }, "selectedVariants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "valueId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "valueName": { "type": "string" } }, "required": [ "id", "name", "valueId", "valueName" ], "additionalProperties": false } }, "quantity": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "unitPricing": { "type": "object", "properties": { "currency": { "type": "string" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "subtotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalInfo": { "type": "string" }, "totalTaxes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscounts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "taxExcluded": { "type": "boolean" }, "taxLines": { "type": "array", "items": { "type": "object", "properties": { "combinedLabel": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "label": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "price": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "price", "rate" ], "additionalProperties": false } }, "discountCodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscountValue": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "quantity", "totalDiscountValue" ], "additionalProperties": false } }, "manualDiscount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deposit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "listPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "originalListPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "currency", "total", "subtotal", "totalTaxes", "totalDiscounts", "taxExcluded", "taxLines", "listPrice", "originalListPrice" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "sales", "booking" ] }, "pricingRowId": { "nullable": true, "type": "string" }, "booking": { "nullable": true, "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "label": { "nullable": true, "type": "string" }, "timeUnitAmount": { "type": "number" }, "timeUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks", "months", "years" ] }, "type": { "type": "string", "enum": [ "fixed", "dynamic" ] } }, "required": [ "start", "end", "label", "timeUnitAmount", "timeUnit", "type" ], "additionalProperties": false }, "filledDetails": { "type": "array", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "fieldId": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "required": [ "name", "fieldId", "value" ], "additionalProperties": false } } }, "required": [ "fields" ], "additionalProperties": false } } }, "required": [ "id", "listingName", "quantity", "unitPricing", "type", "pricingRowId", "booking" ], "additionalProperties": false } }, "pricing": { "type": "object", "properties": { "currency": { "type": "string" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "subtotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "additionalInfo": { "type": "string" }, "totalTaxes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscounts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "taxExcluded": { "type": "boolean" }, "taxLines": { "type": "array", "items": { "type": "object", "properties": { "combinedLabel": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "label": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "price": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "price", "rate" ], "additionalProperties": false } }, "discountCodes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalDiscountValue": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "quantity", "totalDiscountValue" ], "additionalProperties": false } }, "manualDiscount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deposit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "listPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "originalListPrice": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "currency", "total", "subtotal", "totalTaxes", "totalDiscounts", "taxExcluded", "taxLines", "listPrice", "originalListPrice" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "locationId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "state": { "type": "string", "enum": [ "draft", "locked", "completed" ] }, "termsAcceptance": { "type": "object", "properties": { "accepted": { "type": "boolean" }, "timestamp": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "accepted" ], "additionalProperties": false }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string" }, "marketingConsent": { "type": "boolean" }, "address": { "type": "object", "properties": { "address": { "type": "string" }, "zipCode": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "details": { "type": "string" } }, "required": [ "address" ], "additionalProperties": false }, "isMainContact": { "type": "boolean" } }, "required": [ "id", "firstName", "isMainContact" ], "additionalProperties": false } } }, "required": [ "id", "items", "createdAt", "updatedAt", "locationId", "state" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } }, "/storefront/": { "post": { "summary": "Create order from cart", "tags": [ "storefront", "checkout" ], "parameters": [], "operationId": "storefront.checkout.createOrder", "requestBody": { "description": "Body", "content": { "application/json": { "schema": { "type": "object", "properties": { "cartId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "price": { "type": "object", "properties": { "total": { "type": "number" }, "currency": { "type": "string" } }, "required": [ "total", "currency" ], "additionalProperties": false } }, "required": [ "cartId", "price" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "number": { "type": "number" }, "state": { "type": "string", "enum": [ "draft", "open", "active", "completed", "cancelled" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "updatedBy": { "type": "string" }, "channel": { "type": "string" }, "validFrom": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "validTo": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "assignedTo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "currentlyViewing": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "tags": { "type": "array", "items": { "type": "string" } }, "pickupLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "returnLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "mainContact": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "crmCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "firstName", "fullName", "email", "crmCustomerId" ], "additionalProperties": false }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "marketingConsent": { "type": "boolean" }, "address": {}, "language": { "type": "string" }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "name", "type", "ids" ], "additionalProperties": false } }, "crmCustomerId": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "firstName", "fullName" ], "additionalProperties": false } }, "payment": {}, "deposit": {}, "pricing": {}, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "allOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "object", "properties": { "def": { "type": "string" } }, "required": [ "def" ], "additionalProperties": false } ] }, "variants": { "type": "array", "items": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantValueId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variantLabel": { "type": "string" }, "variantValueLabel": { "type": "string" } }, "required": [ "variantId", "variantValueId", "variantLabel", "variantValueLabel" ], "additionalProperties": false } }, "orderCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pricing": {}, "duration": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "returnedDate": { "type": "string" }, "purchaseType": { "type": "string", "enum": [ "booking", "sale", "subscription", "buyback" ] }, "catalogItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "imageUrl": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] }, "checkoutRequirements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "select", "number", "checkbox", "customer_attribute" ] }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "internal": { "type": "boolean" }, "attributeId": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "value": { "type": "string" } }, "required": [ "id", "name", "type" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "name", "pricing" ], "additionalProperties": false } }, "stockItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "type": "string" }, "code": { "type": "string" }, "codeType": { "type": "string", "enum": [ "suggested", "confirmed" ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "attributeId": { "type": "string" }, "key": { "type": "string", "enum": [ "attribute", "item_code", "sku_code", "item_name", "sku_name" ] }, "operator": { "type": "string", "enum": [ "startsWith", "endsWith", "contains", "doesNotContain", "eq", "ne", "gt", "gte", "lt", "lte", "inArray", "notInArray", "between", "notBetween", "isEmpty", "isNotEmpty" ] }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "key", "operator", "values" ], "additionalProperties": false } }, "lineItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inventoryArticleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pickupServiceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "pickupDate": { "type": "string" }, "returnServiceLocation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "returnDate": { "type": "string" }, "fulfillmentState": { "type": "string", "enum": [ "pending", "assigned", "active", "returned", "cancelled" ] } }, "required": [ "id", "createdAt", "updatedAt", "name", "lineItemId", "fulfillmentState" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "type": { "type": "string", "enum": [ "email", "document" ] }, "name": { "type": "string" }, "fileRef": { "type": "string" } }, "required": [ "id", "type" ], "additionalProperties": false } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "authorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "authorType": { "type": "string", "enum": [ "system", "user" ] }, "content": { "type": "string" }, "parentCommentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "author": { "nullable": true, "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "authorType", "content", "author" ], "additionalProperties": false } } }, "required": [ "id", "number", "state", "createdAt", "updatedAt", "channel", "currentlyViewing", "pickupLocation", "returnLocation", "customers", "payment", "deposit", "pricing", "lineItems", "stockItems", "documents", "comments" ], "additionalProperties": false } } } }, "400": { "description": "400" }, "401": { "description": "401" }, "403": { "description": "403" }, "404": { "description": "404" }, "500": { "description": "500" } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "name": "X-API-KEY", "in": "header", "description": "API key for the Twice API" } } }, "security": [ { "ApiKeyAuth": [] } ], "servers": [ { "url": "https://server.dev.twicecommerce.com" } ], "info": { "title": "Unofficial TWICE API", "description": "Experimental Twice API", "version": "2025-06" } }