{ "openapi": "3.1.0", "info": { "title": "API de Ready for Commerce", "version": "1.0.0", "description": "La referencia de cada operación de la API de Ready for Commerce. Todas las operaciones están en beta hasta el lanzamiento." }, "servers": [ { "url": "https://app.readyforcommerce.com" } ], "security": [ { "apiKey": [] } ], "tags": [ { "name": "Credentials", "x-group": "Credenciales", "description": "La credencial que llama: su organización, sus permisos, sus límites y las llamadas que aún puede hacer." }, { "name": "Organization", "x-group": "Organización", "description": "Los ajustes de la organización: su nombre, su slug y su moneda." }, { "name": "Billing", "x-group": "Facturación", "description": "La suscripción de la organización, la factura y el tope de cada módulo, y el uso del mes frente a su cuota gratuita." }, { "name": "Record types", "x-group": "Tipos de registro", "description": "Los tipos de registro que la credencial puede importar o exportar, con los campos y opciones de cada uno." }, { "name": "Imports", "x-group": "Importaciones", "description": "Para traer archivos CSV o Excel: subir o traer un archivo, inspeccionarlo y revisarlo, iniciar la importación y leer sus resultados." }, { "name": "Files", "x-group": "Archivos", "description": "El estado de un archivo subido, hasta que queda listo o rechazado." }, { "name": "Exports", "x-group": "Exportaciones", "description": "Para exportar a archivos CSV o Excel los registros que coinciden con un filtro; se guardan 14 días." }, { "name": "Export templates", "x-group": "Plantillas de exportación", "description": "Configuraciones de exportación guardadas con un nombre, para repetir la misma exportación." }, { "name": "Jobs", "x-group": "Trabajos", "description": "Las tareas largas corren como trabajos: su estado y su avance, sus mensajes, sus archivos para descargar o su cancelación." }, { "name": "Search", "x-group": "Búsqueda", "description": "Encuentra los registros de la organización por palabras, aunque lleven una errata, agrupados por tipo." }, { "name": "Version history", "x-group": "Historial de versiones", "description": "Las versiones de un registro, de la más nueva a la más antigua: compararlas y restaurar el registro a una de ellas." }, { "name": "Incidents", "x-group": "Incidencias", "description": "Los problemas de la organización que puedes ver: marcarlos como leídos o no leídos y resolverlos." }, { "name": "Notifications", "x-group": "Notificaciones", "description": "Tus notificaciones, de la más nueva a la más antigua: marcar una como leída o no leída, o todas como leídas." }, { "name": "Saved views", "x-group": "Vistas guardadas", "description": "La búsqueda, los filtros, el orden y las columnas de una tabla guardados con un nombre, tuyos o compartidos con la organización, y la vista con la que se abre cada tabla para ti." }, { "name": "Store connections", "x-group": "Conexiones de tienda", "description": "Las tiendas de la organización, conectadas con sus credenciales pegadas: listarlas, conectar una, reconectarla con credenciales nuevas o desconectarla." }, { "name": "Products", "x-group": "Productos", "description": "Los productos de la organización con sus opciones, variantes y precios: listarlos, leer uno, crear uno, cambiar el contenido, los precios o el estado de uno, duplicar uno como borrador, o eliminar uno." } ], "paths": { "/api/v1/credential": { "get": { "operationId": "coreGetCredential", "summary": "Obtener la credencial que llama", "description": "Lee la credencial que llama: su organización, sus permisos, sus límites y las llamadas que puede hacer ahora. No cuenta para ningún límite.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credential" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Credentials"], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-get-credential", "metadata": { "sidebarTitle": "Obtener la credencial que llama" } } } }, "/api/v1/orgs/{orgId}/core/org": { "get": { "operationId": "coreGetOrg", "summary": "Obtener la organización", "description": "Lee los ajustes de la organización: su nombre, su slug y su moneda.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgSettings" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Organization"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-get-org", "metadata": { "sidebarTitle": "Obtener la organización" } } }, "patch": { "operationId": "coreUpdateOrg", "summary": "Actualizar la organización", "description": "Cambia el nombre o el slug de la organización.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgSettings" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.slug_taken", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Organization"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrgInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-update-org", "metadata": { "sidebarTitle": "Actualizar la organización" } } } }, "/api/v1/orgs/{orgId}/core/billing": { "get": { "operationId": "coreGetBilling", "summary": "Obtener el resumen de facturación", "description": "Lee la suscripción de la organización, la factura prevista y el tope de cada módulo, el resumen de la tarjeta y cualquier factura pendiente.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingSummary" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Billing"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-get-billing", "metadata": { "sidebarTitle": "Obtener el resumen de facturación" } } } }, "/api/v1/orgs/{orgId}/core/billing/usage": { "get": { "operationId": "coreGetBillingUsage", "summary": "Obtener el uso del mes", "description": "Lee cuántas unidades de cada módulo van este mes y lo que queda de su cuota gratuita, sin importes.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingUsage" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Billing"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-get-billing-usage", "metadata": { "sidebarTitle": "Obtener el uso del mes" } } } }, "/api/v1/orgs/{orgId}/core/dataio/adapters": { "get": { "operationId": "coreListDataioAdapters", "summary": "Listar los tipos de registro", "description": "Lista lo que quien llama puede importar o exportar, con los campos y opciones de cada tipo.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataioAdapterPage" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Record types"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-list-dataio-adapters", "metadata": { "sidebarTitle": "Listar los tipos de registro" } } } }, "/api/v1/orgs/{orgId}/core/dataio/adapters/{entity}": { "get": { "operationId": "coreGetDataioAdapter", "summary": "Obtener un tipo de registro", "description": "Lee un tipo de registro que quien llama puede importar o exportar, con cuántos tiene la organización.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataioAdapterDetail" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.dataio_adapter_not_found", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Record types"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "entity", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-get-dataio-adapter", "metadata": { "sidebarTitle": "Obtener un tipo de registro" } } } }, "/api/v1/orgs/{orgId}/core/imports": { "get": { "operationId": "coreListImports", "summary": "Listar importaciones", "description": "Lista las importaciones de la organización, de la más nueva a la más antigua, con el archivo, el estado, los conteos y quién inició cada una. La búsqueda lee el nombre del archivo; el filtro lee file, entity, mode, fields (cuántos campos asigna), state (active, succeeded, withErrors, failed o canceled) y los conteos de filas success, warning, error y blocked.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportPage" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Imports"], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": 200, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "enum": ["true"] }, "in": "query", "name": "withTotal", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-list-imports", "metadata": { "sidebarTitle": "Listar importaciones" } } }, "post": { "operationId": "coreStartImport", "summary": "Iniciar una importación", "description": "Inicia una importación de un archivo CSV o Excel subido que crea o actualiza registros, fila por fila.", "responses": { "202": { "description": "Aceptado: el trabajo empezó. Síguelo por su `jobId`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStarted" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.dataio_adapter_not_found", "core.file_not_found", "core.import_blocked", "core.idempotency_in_progress", "core.idempotency_mismatch", "core.job_limit_reached", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Imports"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartImportInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-start-import", "metadata": { "sidebarTitle": "Iniciar una importación" } } } }, "/api/v1/orgs/{orgId}/core/imports/uploads": { "post": { "operationId": "coreCreateImportUpload", "summary": "Crear una URL de carga", "description": "Da una URL a la que subir con un PUT un archivo CSV o Excel para una importación; completa la carga cuando hayas enviado sus bytes.", "responses": { "201": { "description": "Creado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportUpload" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.dataio_adapter_not_found", "core.file_type_not_allowed", "core.file_too_large", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Imports"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateImportUploadInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-create-import-upload", "metadata": { "sidebarTitle": "Crear una URL de carga" } } } }, "/api/v1/orgs/{orgId}/core/imports/uploads/{fileId}/complete": { "post": { "operationId": "coreCompleteImportUpload", "summary": "Completar una carga", "description": "Completa la carga de un archivo de importación una vez enviados sus bytes, para que se revise; luego el archivo queda listo o rechazado.", "responses": { "202": { "description": "Aceptado: el trabajo empezó. Síguelo por su `jobId`." }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.file_not_uploaded", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Imports"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "fileId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-complete-import-upload", "metadata": { "sidebarTitle": "Completar una carga" } } } }, "/api/v1/orgs/{orgId}/core/imports/from-url": { "post": { "operationId": "coreFetchImportFile", "summary": "Traer un archivo desde una URL", "description": "Empieza a traer un archivo CSV o Excel desde una dirección web, para importarlo como uno subido; su trabajo devuelve el archivo.", "responses": { "202": { "description": "Aceptado: el trabajo empezó. Síguelo por su `jobId`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStarted" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.dataio_adapter_not_found", "core.file_type_not_allowed", "core.idempotency_in_progress", "core.idempotency_mismatch", "core.job_limit_reached", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Imports"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchImportFileInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-fetch-import-file", "metadata": { "sidebarTitle": "Traer un archivo desde una URL" } } } }, "/api/v1/orgs/{orgId}/core/imports/inspect": { "post": { "operationId": "coreInspectImport", "summary": "Inspeccionar un archivo de importación", "description": "Empieza a examinar un archivo de importación subido: sus hojas, su encabezado, sus primeras filas y cuántas filas tiene.", "responses": { "202": { "description": "Aceptado: el trabajo empezó. Síguelo por su `jobId`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStarted" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.dataio_adapter_not_found", "core.file_not_found", "core.idempotency_in_progress", "core.idempotency_mismatch", "core.job_limit_reached", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Imports"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InspectImportInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-inspect-import", "metadata": { "sidebarTitle": "Inspeccionar un archivo de importación" } } } }, "/api/v1/orgs/{orgId}/core/imports/precheck": { "post": { "operationId": "coreCheckImport", "summary": "Revisar una importación", "description": "Empieza las revisiones que pasaría una importación con un archivo y una asignación de columnas: las filas que darán advertencias y lo que impide iniciarla.", "responses": { "202": { "description": "Aceptado: el trabajo empezó. Síguelo por su `jobId`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStarted" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.dataio_adapter_not_found", "core.file_not_found", "core.idempotency_in_progress", "core.idempotency_mismatch", "core.job_limit_reached", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Imports"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckImportInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-check-import", "metadata": { "sidebarTitle": "Revisar una importación" } } } }, "/api/v1/orgs/{orgId}/core/imports/{jobId}/results": { "post": { "operationId": "coreStartImportResults", "summary": "Generar los resultados de una importación", "description": "Empieza a generar el archivo de una importación terminada con el resultado y el mensaje de cada fila, en CSV o Excel; su trabajo devuelve el archivo.", "responses": { "202": { "description": "Aceptado: el trabajo empezó. Síguelo por su `jobId`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStarted" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.job_not_found", "core.import_not_ended", "core.file_expired", "core.idempotency_in_progress", "core.idempotency_mismatch", "core.job_limit_reached", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Imports"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartImportResultsInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "jobId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-start-import-results", "metadata": { "sidebarTitle": "Generar los resultados de una importación" } } } }, "/api/v1/orgs/{orgId}/core/files/{fileId}": { "get": { "operationId": "coreGetFile", "summary": "Obtener el estado de un archivo", "description": "Lee el estado de un archivo subido, hasta que queda listo o rechazado.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadedFile" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.file_not_found", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Files"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "fileId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-get-file", "metadata": { "sidebarTitle": "Obtener el estado de un archivo" } } } }, "/api/v1/orgs/{orgId}/core/exports": { "get": { "operationId": "coreListExports", "summary": "Listar exportaciones", "description": "Lista las exportaciones de la organización, de la más nueva a la más antigua, con el archivo, el estado, el formato, el tamaño y quién inició cada una. La búsqueda lee el nombre del archivo; el filtro lee file, entity (cualquiera de las entidades que contiene), fields (sus columnas), filters (sus condiciones), format, state (active, succeeded, failed o canceled) y rows (ninguna hasta que se escribe su archivo).", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportPage" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Exports"], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": 200, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "enum": ["true"] }, "in": "query", "name": "withTotal", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-list-exports", "metadata": { "sidebarTitle": "Listar exportaciones" } } }, "post": { "operationId": "coreStartExport", "summary": "Iniciar una exportación", "description": "Inicia una exportación de los campos elegidos de los registros que coinciden con un filtro, para uno o varios tipos de registro de un módulo, a archivos CSV o Excel, comprimidos con gzip o zip si lo pides y varios tipos siempre en un solo zip, que se guardan 14 días.", "responses": { "202": { "description": "Aceptado: el trabajo empezó. Síguelo por su `jobId`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStarted" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.dataio_adapter_not_found", "core.idempotency_in_progress", "core.idempotency_mismatch", "core.job_limit_reached", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Exports"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartExportInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-start-export", "metadata": { "sidebarTitle": "Iniciar una exportación" } } } }, "/api/v1/orgs/{orgId}/core/exports/{jobId}": { "patch": { "operationId": "coreRenameExport", "summary": "Cambiar el nombre de una exportación", "description": "Cambia el nombre del archivo de una exportación terminada, conservando sus extensiones, para que su próxima descarga lleve el nombre nuevo.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportFileName" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.job_not_found", "core.export_not_ready", "core.file_expired", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Exports"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportFileNameInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "jobId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-rename-export", "metadata": { "sidebarTitle": "Cambiar el nombre de una exportación" } } } }, "/api/v1/orgs/{orgId}/core/exports/templates": { "get": { "operationId": "coreListExportTemplates", "summary": "Listar plantillas de exportación", "description": "Lista las plantillas de exportación guardadas de la organización para un módulo, por nombre, cada una con la configuración de exportación que guarda.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportTemplatePage" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Export templates"], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "enum": ["core", "integrations", "catalog", "pricing"], "examples": ["core"] }, "in": "query", "name": "module", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-list-export-templates", "metadata": { "sidebarTitle": "Listar plantillas de exportación" } } }, "post": { "operationId": "coreCreateExportTemplate", "summary": "Crear una plantilla de exportación", "description": "Guarda una configuración de exportación (sus tipos de registro, columnas, filtros y opciones) como plantilla con un nombre único en la organización.", "responses": { "201": { "description": "Creado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportTemplate" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.template_name_taken", "core.idempotency_in_progress", "core.idempotency_mismatch", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Export templates"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExportTemplateInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-create-export-template", "metadata": { "sidebarTitle": "Crear una plantilla de exportación" } } } }, "/api/v1/orgs/{orgId}/core/exports/templates/{templateId}": { "patch": { "operationId": "coreUpdateExportTemplate", "summary": "Actualizar una plantilla de exportación", "description": "Cambia el nombre de una plantilla de exportación guardada, la configuración de exportación que guarda, o ambos.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportTemplate" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.template_not_found", "core.template_name_taken", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Export templates"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateExportTemplateInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "templateId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-update-export-template", "metadata": { "sidebarTitle": "Actualizar una plantilla de exportación" } } }, "delete": { "operationId": "coreDeleteExportTemplate", "summary": "Eliminar una plantilla de exportación", "description": "Elimina una plantilla de exportación guardada; las exportaciones hechas con ella se quedan como están.", "responses": { "204": { "description": "Sin contenido" }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.template_not_found", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Export templates"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "templateId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-delete-export-template", "metadata": { "sidebarTitle": "Eliminar una plantilla de exportación" } } } }, "/api/v1/orgs/{orgId}/core/jobs/{jobId}": { "get": { "operationId": "coreGetJob", "summary": "Obtener un trabajo", "description": "Lee el estado y el avance de un trabajo.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.job_not_found", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Jobs"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "jobId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-get-job", "metadata": { "sidebarTitle": "Obtener un trabajo" } } } }, "/api/v1/orgs/{orgId}/core/jobs/{jobId}/messages": { "get": { "operationId": "coreListJobMessages", "summary": "Listar los mensajes de un trabajo", "description": "Lista los mensajes de un trabajo, página por página.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobMessagePage" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.job_not_found", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Jobs"], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": 200, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "enum": ["true"] }, "in": "query", "name": "withTotal", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "jobId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-list-job-messages", "metadata": { "sidebarTitle": "Listar los mensajes de un trabajo" } } } }, "/api/v1/orgs/{orgId}/core/jobs/{jobId}/files/{file}": { "get": { "operationId": "coreGetJobFile", "summary": "Obtener el enlace de un archivo del trabajo", "description": "Da un enlace que dura 5 minutos para descargar el archivo de entrada o de salida de un trabajo.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobFile" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.job_not_found", "core.file_expired", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Jobs"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "jobId", "required": true }, { "schema": { "type": "string", "enum": ["input", "output"], "examples": ["input"] }, "in": "path", "name": "file", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-get-job-file", "metadata": { "sidebarTitle": "Obtener el enlace de un archivo del trabajo" } } } }, "/api/v1/orgs/{orgId}/core/jobs/{jobId}/cancel": { "post": { "operationId": "coreCancelJob", "summary": "Cancelar un trabajo", "description": "Cancela un trabajo que todavía está en curso.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.job_not_found", "core.job_ended", "core.idempotency_in_progress", "core.idempotency_mismatch", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Jobs"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "jobId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-cancel-job", "metadata": { "sidebarTitle": "Cancelar un trabajo" } } } }, "/api/v1/orgs/{orgId}/core/search": { "get": { "operationId": "coreSearch", "summary": "Buscar registros", "description": "Encuentra los registros de la organización por palabras, aunque lleven una errata, agrupados por tipo.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResult" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Search"], "parameters": [ { "schema": { "type": "string", "minLength": 2, "maxLength": 100 }, "in": "query", "name": "q", "required": true }, { "schema": { "type": "string", "pattern": "^(core|integrations|catalog|pricing)\\.[\\s\\S]{0,}$" }, "in": "query", "name": "kind", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-search", "metadata": { "sidebarTitle": "Buscar registros" } } } }, "/api/v1/orgs/{orgId}/core/history": { "get": { "operationId": "coreListVersions", "summary": "Listar las versiones de un registro", "description": "Lista las versiones de un registro, de la más nueva a la más antigua.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionList" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.history_not_found", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Version history"], "parameters": [ { "schema": { "type": "string", "pattern": "^(core|integrations|catalog|pricing)\\.[\\s\\S]{0,}$" }, "in": "query", "name": "type", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "id", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-list-versions", "metadata": { "sidebarTitle": "Listar las versiones de un registro" } } } }, "/api/v1/orgs/{orgId}/core/history/{versionId}": { "get": { "operationId": "coreGetVersion", "summary": "Comparar una versión", "description": "Lee el estado de una versión junto a la versión con la que se compara, por defecto la anterior.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionComparison" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.history_not_found", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Version history"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "against", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "versionId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-get-version", "metadata": { "sidebarTitle": "Comparar una versión" } } } }, "/api/v1/orgs/{orgId}/core/history/{versionId}/restore": { "post": { "operationId": "coreRestoreVersion", "summary": "Restaurar una versión", "description": "Restaura un registro a una de sus versiones.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreResult" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.history_not_found", "core.idempotency_in_progress", "core.idempotency_mismatch", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Version history"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer" } }, "required": ["expectedVersion"] } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "versionId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-restore-version", "metadata": { "sidebarTitle": "Restaurar una versión" } } } }, "/api/v1/orgs/{orgId}/core/incidents": { "get": { "operationId": "coreListIncidents", "summary": "Listar incidencias", "description": "Lista los problemas de la organización que puedes ver.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentPage" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Incidents"], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": 200, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "enum": ["true"] }, "in": "query", "name": "withTotal", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-list-incidents", "metadata": { "sidebarTitle": "Listar incidencias" } } } }, "/api/v1/orgs/{orgId}/core/incidents/{incidentId}/read": { "put": { "operationId": "coreMarkIncident", "summary": "Marcar una incidencia como leída o no leída", "description": "Marca uno de los problemas de la organización como leído o no leído para ti.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Incident" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.incident_not_found", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Incidents"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkIncidentInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "incidentId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-mark-incident", "metadata": { "sidebarTitle": "Marcar una incidencia como leída o no leída" } } } }, "/api/v1/orgs/{orgId}/core/incidents/{incidentId}/resolve": { "post": { "operationId": "coreResolveIncident", "summary": "Resolver una incidencia", "description": "Resuelve uno de los problemas de la organización.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Incident" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.incident_not_found", "core.incident_resolved", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Incidents"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "incidentId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-resolve-incident", "metadata": { "sidebarTitle": "Resolver una incidencia" } } } }, "/api/v1/orgs/{orgId}/core/notifications": { "get": { "operationId": "coreListNotifications", "summary": "Listar notificaciones", "description": "Lista tus notificaciones, de la más nueva a la más antigua.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationPage" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Notifications"], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": 200, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "enum": ["true"] }, "in": "query", "name": "withTotal", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-list-notifications", "metadata": { "sidebarTitle": "Listar notificaciones" } } } }, "/api/v1/orgs/{orgId}/core/notifications/{notificationId}/read": { "put": { "operationId": "coreMarkNotification", "summary": "Marcar una notificación como leída o no leída", "description": "Marca una de tus notificaciones como leída o no leída.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.notification_not_found", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Notifications"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkNotificationInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "notificationId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-mark-notification", "metadata": { "sidebarTitle": "Marcar una notificación como leída o no leída" } } } }, "/api/v1/orgs/{orgId}/core/notifications/read": { "post": { "operationId": "coreMarkAllNotificationsRead", "summary": "Marcar todo como leído", "description": "Marca como leídas todas tus notificaciones y los problemas que ves.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkedAllRead" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Notifications"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-mark-all-notifications-read", "metadata": { "sidebarTitle": "Marcar todo como leído" } } } }, "/api/v1/orgs/{orgId}/core/views": { "get": { "operationId": "coreListViews", "summary": "Listar vistas guardadas", "description": "Lista las vistas guardadas de una tabla que puedes leer (resource: core.imports o core.exports), las tuyas y todas las compartidas, por nombre: cada una con si está compartida, la búsqueda, los filtros, el orden y las columnas que guarda, y si es tuya.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewPage" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.view_resource_not_found", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Saved views"], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "resource", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-list-views", "metadata": { "sidebarTitle": "Listar vistas guardadas" } } }, "post": { "operationId": "coreCreateView", "summary": "Crear una vista guardada", "description": "Guarda lo que muestra una tabla (su búsqueda, filtros, orden y columnas) como una vista tuya con nombre, privada o compartida con la organización. Su filtro y su orden leen los campos de la tabla: en core.imports, file, entity, mode, fields, state (active, succeeded, withErrors, failed o canceled), success, warning, error y blocked; en core.exports, file, entity, fields, filters, format, state (active, succeeded, failed o canceled) y rows.", "responses": { "201": { "description": "Creado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/View" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.view_resource_not_found", "core.view_unreadable", "core.view_name_taken", "core.view_needs_person", "core.idempotency_in_progress", "core.idempotency_mismatch", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Saved views"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateViewInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-create-view", "metadata": { "sidebarTitle": "Crear una vista guardada" } } } }, "/api/v1/orgs/{orgId}/core/views/default": { "put": { "operationId": "coreSetDefaultView", "summary": "Fijar la vista predeterminada de una tabla", "description": "Fija la vista guardada con la que se abre para ti una tabla (resource: core.imports o core.exports), cualquier vista suya que veas, tuya o compartida, o la quita con viewId null.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultView" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.view_resource_not_found", "core.view_not_found", "core.view_needs_person", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Saved views"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultViewInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-set-default-view", "metadata": { "sidebarTitle": "Fijar la vista predeterminada de una tabla" } } } }, "/api/v1/orgs/{orgId}/core/views/{viewId}": { "patch": { "operationId": "coreUpdateView", "summary": "Actualizar una vista guardada", "description": "Cambia una vista guardada tuya: le cambia el nombre, la comparte con la organización o la vuelve privada (lo que la quita como vista predeterminada de los demás), o guarda encima la búsqueda, los filtros, el orden y las columnas que guarda.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/View" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.view_not_found", "core.view_resource_not_found", "core.view_needs_person", "core.view_not_owner", "core.view_unreadable", "core.view_name_taken", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Saved views"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateViewInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "viewId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-update-view", "metadata": { "sidebarTitle": "Actualizar una vista guardada" } } }, "delete": { "operationId": "coreDeleteView", "summary": "Eliminar una vista guardada", "description": "Elimina una vista guardada tuya; quien la tenía como la vista con la que se abre su tabla se queda sin ninguna.", "responses": { "204": { "description": "Sin contenido" }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.view_not_found", "core.view_resource_not_found", "core.view_needs_person", "core.view_not_owner", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Saved views"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "viewId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/core-delete-view", "metadata": { "sidebarTitle": "Eliminar una vista guardada" } } } }, "/api/v1/orgs/{orgId}/integrations/connections": { "get": { "operationId": "integrationsListConnections", "summary": "Listar conexiones de tienda", "description": "Lista las conexiones de tienda de la organización.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionPage" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Store connections"], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/integrations-list-connections", "metadata": { "sidebarTitle": "Listar conexiones de tienda" } } }, "post": { "operationId": "integrationsConnectStore", "summary": "Conectar una tienda", "description": "Conecta una tienda con sus credenciales pegadas, después de una prueba en vivo.", "responses": { "201": { "description": "Creado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "integrations.provider_not_available", "integrations.credentials_refused", "integrations.provider_unavailable", "integrations.currency_mismatch", "integrations.already_connected_here", "integrations.connected_elsewhere", "core.idempotency_in_progress", "core.idempotency_mismatch", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Store connections"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectStoreInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/integrations-connect-store", "metadata": { "sidebarTitle": "Conectar una tienda" } } } }, "/api/v1/orgs/{orgId}/integrations/connections/{connectionId}/credentials": { "put": { "operationId": "integrationsReconnectStore", "summary": "Reconectar una tienda", "description": "Reconecta una tienda con credenciales nuevas pegadas, conservando su conexión y su configuración.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "integrations.connection_not_found", "integrations.provider_not_available", "integrations.credentials_refused", "integrations.provider_unavailable", "integrations.reconnect_other_account", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Store connections"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconnectStoreInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "connectionId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/integrations-reconnect-store", "metadata": { "sidebarTitle": "Reconectar una tienda" } } } }, "/api/v1/orgs/{orgId}/integrations/connections/{connectionId}": { "delete": { "operationId": "integrationsDisconnectStore", "summary": "Desconectar una tienda", "description": "Desconecta una tienda y elimina todo lo que vino de ella, sin tocar nada en la tienda.", "responses": { "202": { "description": "Aceptado: el trabajo empezó. Síguelo por su `jobId`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "integrations.connection_not_found", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Store connections"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "connectionId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/integrations-disconnect-store", "metadata": { "sidebarTitle": "Desconectar una tienda" } } } }, "/api/v1/orgs/{orgId}/catalog/products": { "get": { "operationId": "catalogListProducts", "summary": "Listar productos", "description": "Lista los productos de la organización, del cambiado más recientemente al más antiguo, con el título, el slug, el estado y el número de variantes de cada uno. La búsqueda lee el título; el filtro lee status (draft, active, unlisted o archived); el orden lee updatedAt o title.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductPage" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Products"], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": 200, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "enum": ["true"] }, "in": "query", "name": "withTotal", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/catalog-list-products", "metadata": { "sidebarTitle": "Listar productos" } } }, "post": { "operationId": "catalogCreateProduct", "summary": "Crear un producto", "description": "Crea un producto con sus opciones y sus variantes, cada variante una combinación de los valores de las opciones con sus identificadores: SKU, GTIN, ISBN, número de pieza (mpn) y códigos propios con su etiqueta, con el dígito de control del GTIN y del ISBN verificado y cada SKU, GTIN e ISBN único en la organización. Cada variante también puede llevar su precio, precio de comparación, MAP, MSRP y costos como textos decimales en la moneda de la organización, lo que necesita el permiso de editar precios, y se rechaza cuando rompen una regla de precios, como un precio de comparación por debajo del precio. La respuesta trae el producto y los avisos del guardado, como un número de pieza que se distingue del de otro producto solo en la puntuación, como guiones o espacios, o un precio por debajo del MAP.", "responses": { "201": { "description": "Creado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSaved" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "catalog.no_variants", "catalog.option_without_values", "catalog.option_repeated", "catalog.option_value_repeated", "catalog.variant_option_values", "catalog.variant_repeated", "catalog.variant_limit", "catalog.slug_empty", "catalog.slug_taken", "catalog.identifier_invalid", "catalog.identifier_repeated", "catalog.identifier_taken", "catalog.price_invalid", "catalog.price_out_of_range", "catalog.compare_below_price", "catalog.price_below_cost", "catalog.map_above_msrp", "catalog.measure_out_of_range", "catalog.hs_code_invalid", "catalog.country_invalid", "catalog.stock_untracked", "core.usage_limit_reached", "core.idempotency_in_progress", "core.idempotency_mismatch", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Products"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCreateInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/catalog-create-product", "metadata": { "sidebarTitle": "Crear un producto" } } } }, "/api/v1/orgs/{orgId}/catalog/products/{productId}": { "get": { "operationId": "catalogGetProduct", "summary": "Obtener un producto", "description": "Obtiene un producto con sus opciones, sus valores y sus variantes, cada variante con sus identificadores en su orden (SKU, GTIN, ISBN, número de pieza (mpn) y códigos propios con su etiqueta), su moneda, y sus precios y costos como textos decimales en esa moneda, null donde no tiene.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Products"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "productId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/catalog-get-product", "metadata": { "sidebarTitle": "Obtener un producto" } } }, "patch": { "operationId": "catalogUpdateProduct", "summary": "Actualizar un producto", "description": "Cambia el título, el slug, la condición, el tipo de producto, los textos SEO, las opciones o las variantes de un producto, solo los campos enviados, con la versión en que se leyó: un producto guardado desde entonces se rechaza. Las opciones y las variantes se envían completas, las que se conservan con sus ids: la que falta se elimina, y eliminar una variante también necesita el permiso de borrar variantes. Los identificadores de una variante, cuando se envían, reemplazan todos sus códigos, y se rechaza un SKU, GTIN o ISBN que tenga otra variante de la organización. La respuesta trae el producto y los avisos del guardado, como un número de pieza que se distingue del de otro producto solo en la puntuación, como guiones o espacios.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSaved" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "catalog.no_variants", "catalog.option_without_values", "catalog.option_repeated", "catalog.option_value_repeated", "catalog.option_unknown", "catalog.variant_option_values", "catalog.variant_repeated", "catalog.variant_unknown", "catalog.variant_limit", "catalog.slug_empty", "catalog.slug_taken", "catalog.identifier_invalid", "catalog.identifier_repeated", "catalog.identifier_taken", "catalog.measure_out_of_range", "catalog.hs_code_invalid", "catalog.country_invalid", "catalog.stock_untracked", "core.usage_limit_reached", "core.version_conflict", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Products"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductUpdateInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "productId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/catalog-update-product", "metadata": { "sidebarTitle": "Actualizar un producto" } } }, "delete": { "operationId": "catalogDeleteProduct", "summary": "Eliminar un producto", "description": "Elimina un producto para siempre con todas sus variantes y libera sus publicaciones en cada tienda; no se puede deshacer.", "responses": { "204": { "description": "Sin contenido" }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Products"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "productId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/catalog-delete-product", "metadata": { "sidebarTitle": "Eliminar un producto" } } } }, "/api/v1/orgs/{orgId}/catalog/products/free-sku": { "get": { "operationId": "catalogGetFreeSku", "summary": "Obtener un SKU libre", "description": "Obtiene un SKU que ninguna variante de la organización tiene, tres letras, tres dígitos y tres letras como KMT-472-BXR, para dárselo a una variante nueva o cambiada; no queda reservado, así que se rechaza el guardado que lo encuentre ya tomado.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FreeSku" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Products"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/catalog-get-free-sku", "metadata": { "sidebarTitle": "Obtener un SKU libre" } } } }, "/api/v1/orgs/{orgId}/catalog/products/{productId}/prices": { "patch": { "operationId": "catalogUpdateProductPrices", "summary": "Actualizar los precios de un producto", "description": "Cambia el precio, el precio de comparación, el MAP, el MSRP y los costos en existencia, del proveedor y de respaldo de las variantes del producto que nombra por su id, como textos decimales en la moneda de cada variante como 19.99, null para quitar uno, con la versión en que se leyó el producto; un precio de comparación por debajo del precio, un precio por debajo del costo (el costo en existencia, o si no el del proveedor) y un MAP por encima del MSRP se rechazan cuando el cambio pone uno de sus precios, y la respuesta avisa de las otras reglas que los precios rompen.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSaved" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "catalog.variant_unknown", "catalog.price_invalid", "catalog.price_out_of_range", "catalog.compare_below_price", "catalog.price_below_cost", "catalog.map_above_msrp", "core.version_conflict", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Products"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductPricesUpdateInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "productId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/catalog-update-product-prices", "metadata": { "sidebarTitle": "Actualizar los precios de un producto" } } } }, "/api/v1/orgs/{orgId}/catalog/products/{productId}/status": { "put": { "operationId": "catalogSetProductStatus", "summary": "Poner el estado de un producto", "description": "Pone el estado de un producto en draft, active, unlisted o archived, desde cualquier otro, con la versión en que se leyó: un producto guardado desde entonces se rechaza, y poner el estado que ya tiene no cambia nada.", "responses": { "200": { "description": "Correcto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSaved" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "core.version_conflict", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Products"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductStatusUpdateInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "productId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/catalog-set-product-status", "metadata": { "sidebarTitle": "Poner el estado de un producto" } } } }, "/api/v1/orgs/{orgId}/catalog/products/{productId}/duplicate": { "post": { "operationId": "catalogDuplicateProduct", "summary": "Duplicar un producto", "description": "Copia un producto como un nuevo borrador, con su título seguido de (Copy), luego (Copy 2) y así sucesivamente, con su descripción, sus opciones y sus variantes con sus precios, costos, medidas y ajustes de inventario pero sin sus identificadores, para empezar un producto parecido a partir de uno que ya existe.", "responses": { "201": { "description": "Creado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "default": { "description": "Un error, como `application/problem+json`: su `code` dice qué salió mal y `params` lleva sus valores", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "properties": { "code": { "enum": [ "catalog.slug_taken", "core.usage_limit_reached", "core.idempotency_in_progress", "core.idempotency_mismatch", "core.bad_request", "core.invalid_credential", "core.forbidden", "core.module_not_enabled", "core.module_read_only", "core.not_found", "core.conflict", "core.org_deletion_scheduled", "core.payload_too_large", "core.unsupported_media_type", "core.validation_failed", "core.rate_limited", "core.surface_disabled", "core.internal", "core.unavailable" ] } } } ] } } } } }, "tags": ["Products"], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "orgId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "productId", "required": true } ], "x-stability-level": "beta", "x-rfc-action": "direct", "x-mint": { "href": "/es/api-reference/catalog-duplicate-product", "metadata": { "sidebarTitle": "Duplicar un producto" } } } } }, "components": { "schemas": { "UpdateOrgInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "slug": { "type": "string", "minLength": 3, "maxLength": 48, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" } }, "additionalProperties": false }, "CreateViewInput": { "type": "object", "properties": { "resource": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1, "maxLength": 30 }, "visibility": { "type": "string", "enum": ["private", "org"], "examples": ["private"] }, "state": { "type": "object", "properties": { "question": { "type": "object", "properties": { "search": { "type": "string" }, "filter": { "type": "object", "properties": { "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "required": ["field", "op"] } }, "logic": { "type": "string", "enum": ["and", "or"], "examples": ["and"] } }, "required": ["items", "logic"] }, "sort": { "type": "object", "properties": { "field": { "type": "string" }, "direction": { "type": "string", "enum": ["asc", "desc"], "examples": ["asc"] } }, "required": ["field", "direction"] } } }, "columns": { "type": "array", "items": { "type": "string" } }, "hide": { "type": "array", "items": { "type": "string" } } }, "required": ["question"], "additionalProperties": false } }, "required": ["resource", "name", "visibility", "state"] }, "UpdateViewInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 30 }, "visibility": { "type": "string", "enum": ["private", "org"] }, "state": { "type": "object", "properties": { "question": { "type": "object", "properties": { "search": { "type": "string" }, "filter": { "type": "object", "properties": { "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "required": ["field", "op"] } }, "logic": { "type": "string", "enum": ["and", "or"], "examples": ["and"] } }, "required": ["items", "logic"] }, "sort": { "type": "object", "properties": { "field": { "type": "string" }, "direction": { "type": "string", "enum": ["asc", "desc"], "examples": ["asc"] } }, "required": ["field", "direction"] } } }, "columns": { "type": "array", "items": { "type": "string" } }, "hide": { "type": "array", "items": { "type": "string" } } }, "required": ["question"], "additionalProperties": false } } }, "DefaultViewInput": { "type": "object", "properties": { "resource": { "type": "string", "minLength": 1 }, "viewId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": ["resource", "viewId"] }, "StartImportInput": { "type": "object", "properties": { "entity": { "type": "string" }, "fileId": { "type": "string", "format": "uuid" }, "worksheet": { "type": "string", "minLength": 1 }, "hasHeader": { "type": "boolean" }, "mode": { "type": "string", "enum": ["create", "update", "clean", "delete"], "examples": ["create"] }, "mapping": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "matchBy": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "pairs": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "target": { "type": "string" }, "column": { "type": "string" } }, "required": ["target", "column"] } } }, "required": ["pairs"] } }, "cleanFields": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "options": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "required": ["entity", "fileId", "hasHeader", "mode", "mapping", "matchBy", "options"] }, "StartExportInput": { "type": "object", "properties": { "entities": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "columns": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "question": { "type": "object", "properties": { "search": { "type": "string" }, "filter": { "type": "object", "properties": { "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "required": ["field", "op"] } }, "logic": { "type": "string", "enum": ["and", "or"], "examples": ["and"] } }, "required": ["items", "logic"] }, "sort": { "type": "object", "properties": { "field": { "type": "string" }, "direction": { "type": "string", "enum": ["asc", "desc"], "examples": ["asc"] } }, "required": ["field", "direction"] } } } }, "required": ["entity", "columns", "question"] } }, "format": { "type": "string", "enum": ["csv", "xlsx"], "examples": ["csv"] }, "delimiter": { "default": ",", "type": "string", "enum": [",", ";", "\t", "|"] }, "dateFormat": { "default": "sql", "type": "string", "enum": ["sql", "iso"] }, "compression": { "default": "none", "type": "string", "enum": ["none", "gzip", "zip"] }, "listSeparator": { "default": "|", "type": "string", "minLength": 1, "maxLength": 3 }, "systemFields": { "default": false, "type": "boolean" }, "fileName": { "type": "string", "maxLength": 100 } }, "required": ["entities", "format"] }, "ExportDefinitionInput": { "type": "object", "properties": { "entities": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "columns": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "question": { "type": "object", "properties": { "search": { "type": "string" }, "filter": { "type": "object", "properties": { "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "required": ["field", "op"] } }, "logic": { "type": "string", "enum": ["and", "or"], "examples": ["and"] } }, "required": ["items", "logic"] }, "sort": { "type": "object", "properties": { "field": { "type": "string" }, "direction": { "type": "string", "enum": ["asc", "desc"], "examples": ["asc"] } }, "required": ["field", "direction"] } } } }, "required": ["entity", "columns", "question"] } }, "format": { "type": "string", "enum": ["csv", "xlsx"], "examples": ["csv"] }, "delimiter": { "default": ",", "type": "string", "enum": [",", ";", "\t", "|"] }, "dateFormat": { "default": "sql", "type": "string", "enum": ["sql", "iso"] }, "compression": { "default": "none", "type": "string", "enum": ["none", "gzip", "zip"] }, "listSeparator": { "default": "|", "type": "string", "minLength": 1, "maxLength": 3 }, "systemFields": { "default": false, "type": "boolean" } }, "required": ["entities", "format"] }, "CreateExportTemplateInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "definition": { "$ref": "#/components/schemas/ExportDefinitionInput" } }, "required": ["name", "definition"] }, "UpdateExportTemplateInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "definition": { "$ref": "#/components/schemas/ExportDefinitionInput" } } }, "ExportFileNameInput": { "type": "object", "properties": { "fileName": { "type": "string" } }, "required": ["fileName"] }, "FetchImportFileInput": { "type": "object", "properties": { "entity": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": ["entity", "url"] }, "CreateImportUploadInput": { "type": "object", "properties": { "entity": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "size": { "type": "integer", "minimum": 0 } }, "required": ["entity", "name", "size"] }, "StartImportResultsInput": { "type": "object", "properties": { "format": { "type": "string", "enum": ["csv", "xlsx"], "examples": ["csv"] } }, "required": ["format"] }, "InspectImportInput": { "type": "object", "properties": { "entity": { "type": "string" }, "fileId": { "type": "string", "format": "uuid" }, "worksheet": { "type": "string", "minLength": 1 }, "hasHeader": { "type": "boolean" } }, "required": ["entity", "fileId"] }, "CheckImportInput": { "type": "object", "properties": { "entity": { "type": "string" }, "fileId": { "type": "string", "format": "uuid" }, "worksheet": { "type": "string", "minLength": 1 }, "hasHeader": { "type": "boolean" }, "mode": { "type": "string", "enum": ["create", "update", "clean", "delete"], "examples": ["create"] }, "mapping": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "required": ["entity", "fileId", "hasHeader", "mode", "mapping"] }, "MarkIncidentInput": { "type": "object", "properties": { "read": { "type": "boolean" } }, "required": ["read"] }, "MarkNotificationInput": { "type": "object", "properties": { "read": { "type": "boolean" } }, "required": ["read"] }, "ProductCreateInput": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 300 }, "slug": { "type": "string", "minLength": 1, "maxLength": 200 }, "status": { "default": "draft", "type": "string", "enum": ["draft", "active", "unlisted", "archived"] }, "condition": { "default": "new", "type": "string", "enum": [ "new", "open_box", "new_with_defects", "used", "used_like_new", "used_very_good", "used_good", "used_acceptable", "refurbished", "collectible_like_new", "collectible_very_good", "collectible_good", "collectible_acceptable", "for_parts_or_not_working" ] }, "productType": { "type": "string", "maxLength": 100 }, "descriptionHtml": { "type": "string", "description": "The product's description in HTML, which keeps paragraphs, headings, lists and task lists, quotes, code blocks, images, tables, rules, line breaks, links, bold, italic, underline, strikethrough, subscript, superscript, text colour, highlight, alignment, and YouTube, Vimeo or video embeds. Anything else, such as a script, an event attribute or another site's frame, is removed and its text kept; a description left with nothing is saved as none." }, "metaTitle": { "type": "string", "maxLength": 200 }, "metaDescription": { "type": "string", "maxLength": 300 }, "options": { "default": [], "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "values": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 150 } } }, "required": ["name", "values"] } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "optionValues": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 150 } }, "identifiers": { "default": [], "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": ["sku", "gtin", "isbn", "mpn"], "examples": ["sku"] }, "value": { "type": "string" } }, "required": ["type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "custom" }, "value": { "type": "string" }, "label": { "type": "string", "minLength": 1, "maxLength": 50 } }, "required": ["type", "value", "label"], "additionalProperties": false } ] } }, "price": { "type": "string", "maxLength": 40 }, "compareAt": { "type": "string", "maxLength": 40 }, "map": { "type": "string", "maxLength": 40 }, "msrp": { "type": "string", "maxLength": 40 }, "onHandCost": { "type": "string", "maxLength": 40 }, "supplierCost": { "type": "string", "maxLength": 40 }, "fallbackCost": { "type": "string", "maxLength": 40 }, "productWeight": { "description": "The product's own weight, a value with its unit (g, kg, oz, lb, ct); a value of 0 is saved as none.", "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["g", "kg", "oz", "lb", "ct"], "examples": ["g"] } }, "required": ["value", "unit"], "additionalProperties": false }, "productLength": { "description": "The product's own length, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none.", "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"], "examples": ["mm"] } }, "required": ["value", "unit"], "additionalProperties": false }, "productWidth": { "description": "The product's own width, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none.", "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"], "examples": ["mm"] } }, "required": ["value", "unit"], "additionalProperties": false }, "productHeight": { "description": "The product's own height, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none.", "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"], "examples": ["mm"] } }, "required": ["value", "unit"], "additionalProperties": false }, "shippingWeight": { "description": "The weight it ships with, packed, a value with its unit (g, kg, oz, lb, ct); a value of 0 is saved as none.", "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["g", "kg", "oz", "lb", "ct"], "examples": ["g"] } }, "required": ["value", "unit"], "additionalProperties": false }, "shippingLength": { "description": "The length of its package, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none.", "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"], "examples": ["mm"] } }, "required": ["value", "unit"], "additionalProperties": false }, "shippingWidth": { "description": "The width of its package, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none.", "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"], "examples": ["mm"] } }, "required": ["value", "unit"], "additionalProperties": false }, "shippingHeight": { "description": "The height of its package, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none.", "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"], "examples": ["mm"] } }, "required": ["value", "unit"], "additionalProperties": false }, "countryOfOrigin": { "type": "string", "maxLength": 100, "description": "The country it is made in, as its two-letter ISO 3166-1 code such as MX, in any case." }, "hsCode": { "type": "string", "maxLength": 100, "description": "Its Harmonized System customs code: 6 to 13 digits, once every other character, such as dots, spaces and hyphens, is removed." }, "trackInventory": { "type": "boolean", "description": "Whether its stock is tracked; a variant no longer tracked has none of its three stocks." }, "fallbackStock": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "The stock it falls back on when it has none on hand or at its supplier, for a tracked variant only; one tracked without it has 0." } }, "required": ["optionValues"] } } }, "required": ["title", "variants"] }, "ProductUpdateInput": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 300 }, "slug": { "type": "string", "minLength": 1, "maxLength": 200 }, "condition": { "type": "string", "enum": [ "new", "open_box", "new_with_defects", "used", "used_like_new", "used_very_good", "used_good", "used_acceptable", "refurbished", "collectible_like_new", "collectible_very_good", "collectible_good", "collectible_acceptable", "for_parts_or_not_working" ] }, "productType": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "descriptionHtml": { "anyOf": [ { "type": "string", "description": "The product's description in HTML, which keeps paragraphs, headings, lists and task lists, quotes, code blocks, images, tables, rules, line breaks, links, bold, italic, underline, strikethrough, subscript, superscript, text colour, highlight, alignment, and YouTube, Vimeo or video embeds. Anything else, such as a script, an event attribute or another site's frame, is removed and its text kept; a description left with nothing is saved as none." }, { "type": "null" } ] }, "metaTitle": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "metaDescription": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 150 } }, "required": ["name"] } } }, "required": ["name", "values"] } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "optionValues": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 150 } }, "identifiers": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": ["sku", "gtin", "isbn", "mpn"], "examples": ["sku"] }, "value": { "type": "string" } }, "required": ["type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "custom" }, "value": { "type": "string" }, "label": { "type": "string", "minLength": 1, "maxLength": 50 } }, "required": ["type", "value", "label"], "additionalProperties": false } ] } }, "productWeight": { "description": "The product's own weight, a value with its unit (g, kg, oz, lb, ct); a value of 0 is saved as none.", "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["g", "kg", "oz", "lb", "ct"], "examples": ["g"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ] }, "productLength": { "description": "The product's own length, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none.", "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"], "examples": ["mm"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ] }, "productWidth": { "description": "The product's own width, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none.", "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"], "examples": ["mm"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ] }, "productHeight": { "description": "The product's own height, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none.", "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"], "examples": ["mm"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ] }, "shippingWeight": { "description": "The weight it ships with, packed, a value with its unit (g, kg, oz, lb, ct); a value of 0 is saved as none.", "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["g", "kg", "oz", "lb", "ct"], "examples": ["g"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ] }, "shippingLength": { "description": "The length of its package, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none.", "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"], "examples": ["mm"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ] }, "shippingWidth": { "description": "The width of its package, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none.", "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"], "examples": ["mm"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ] }, "shippingHeight": { "description": "The height of its package, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none.", "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"], "examples": ["mm"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ] }, "countryOfOrigin": { "anyOf": [ { "type": "string", "maxLength": 100, "description": "The country it is made in, as its two-letter ISO 3166-1 code such as MX, in any case." }, { "type": "null" } ] }, "hsCode": { "anyOf": [ { "type": "string", "maxLength": 100, "description": "Its Harmonized System customs code: 6 to 13 digits, once every other character, such as dots, spaces and hyphens, is removed." }, { "type": "null" } ] }, "trackInventory": { "type": "boolean", "description": "Whether its stock is tracked; a variant no longer tracked has none of its three stocks." }, "fallbackStock": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "The stock it falls back on when it has none on hand or at its supplier, for a tracked variant only; one tracked without it has 0." }, { "type": "null" } ] } }, "required": ["optionValues"] } }, "expectedVersion": { "type": "integer", "minimum": 1 } }, "required": ["expectedVersion"] }, "ProductPricesUpdateInput": { "type": "object", "properties": { "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "price": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "compareAt": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "map": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "msrp": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "onHandCost": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "supplierCost": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "fallbackCost": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] } }, "required": ["id"] } }, "expectedVersion": { "type": "integer", "minimum": 1 } }, "required": ["variants", "expectedVersion"] }, "ProductStatusUpdateInput": { "type": "object", "properties": { "status": { "type": "string", "enum": ["draft", "active", "unlisted", "archived"], "examples": ["draft"] }, "expectedVersion": { "type": "integer", "minimum": 1 } }, "required": ["status", "expectedVersion"] }, "ConnectStoreInput": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "amazon", "shopify", "bigcommerce", "square", "walmart", "ebay", "google_merchant" ], "examples": ["amazon"] }, "credentials": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": ["provider", "credentials"] }, "ReconnectStoreInput": { "type": "object", "properties": { "credentials": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": ["credentials"] }, "OrgSettings": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" }, "defaultCurrency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XCD", "XCG", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWG" ] } }, "required": ["id", "name", "slug", "defaultCurrency"], "additionalProperties": false }, "BillingUsage": { "type": "object", "properties": { "standing": { "type": "string", "enum": ["free", "complimentary", "subscribed"] }, "modules": { "type": "array", "items": { "type": "object", "properties": { "module": { "type": "string", "enum": ["catalog", "pricing"] }, "units": { "type": "array", "items": { "type": "object", "properties": { "unit": { "type": "string" }, "count": { "type": "integer", "minimum": 0 }, "freeAllowance": { "type": "integer", "minimum": 0 }, "left": { "type": "integer", "minimum": 0 } }, "required": ["unit", "count", "freeAllowance", "left"], "additionalProperties": false } } }, "required": ["module", "units"], "additionalProperties": false } } }, "required": ["standing", "modules"], "additionalProperties": false }, "BillingSummary": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XCD", "XCG", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWG" ] }, "status": { "type": "string", "enum": ["none", "active", "past_due", "canceled", "complimentary"] }, "currentPeriodEnd": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "cancelAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "complimentaryUntil": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "projectedTotalMinor": { "type": "integer", "minimum": 0 }, "modules": { "type": "array", "items": { "type": "object", "properties": { "module": { "type": "string", "enum": ["catalog", "pricing"] }, "projectedMinor": { "type": "integer", "minimum": 0 }, "capMinor": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "units": { "type": "array", "items": { "type": "object", "properties": { "unit": { "type": "string" }, "count": { "type": "integer", "minimum": 0 }, "freeAllowance": { "type": "integer", "minimum": 0 }, "left": { "type": "integer", "minimum": 0 }, "capAt": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "tiers": { "type": "array", "items": { "type": "object", "properties": { "upTo": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "unitAmountMinor": { "type": "integer", "minimum": 0 } }, "required": ["upTo", "unitAmountMinor"], "additionalProperties": false } } }, "required": ["unit", "count", "freeAllowance", "left", "capAt", "tiers"], "additionalProperties": false } } }, "required": ["module", "projectedMinor", "capMinor", "units"], "additionalProperties": false } }, "estimate": { "type": "object", "properties": { "projectedTotalMinor": { "type": "integer", "minimum": 0 }, "modules": { "type": "object", "propertyNames": { "type": "string", "enum": ["catalog", "pricing"] }, "additionalProperties": { "type": "object", "properties": { "projectedMinor": { "type": "integer", "minimum": 0 }, "capMinor": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] } }, "required": ["projectedMinor", "capMinor"], "additionalProperties": false } } }, "required": ["projectedTotalMinor", "modules"], "additionalProperties": false }, "rateMissing": { "type": "boolean", "const": true }, "card": { "type": "object", "properties": { "brand": { "type": "string" }, "last4": { "type": "string" }, "expMonth": { "type": "integer" }, "expYear": { "type": "integer" } }, "required": ["brand", "last4", "expMonth", "expYear"], "additionalProperties": false }, "openInvoice": { "type": "object", "properties": { "amountMinor": { "type": "integer", "minimum": 0 }, "issuedOn": { "type": "string", "format": "date" }, "declineCode": { "type": "string" }, "nextAttemptAt": { "type": "string", "format": "date-time" }, "actionRequired": { "type": "boolean" }, "hostedUrl": { "type": "string", "format": "uri" } }, "required": ["amountMinor", "issuedOn", "actionRequired"], "additionalProperties": false }, "cardUnavailable": { "type": "boolean" } }, "required": [ "currency", "status", "currentPeriodEnd", "cancelAt", "complimentaryUntil", "projectedTotalMinor", "modules", "cardUnavailable" ], "additionalProperties": false }, "ImportCheckSummary": { "oneOf": [ { "type": "object", "properties": { "stage": { "type": "string", "const": "inspect" }, "worksheets": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "header": { "type": "array", "items": { "type": "string" } }, "sample": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "rows": { "type": "integer", "minimum": 0 } }, "required": ["stage", "worksheets", "header", "sample", "rows"], "additionalProperties": false }, { "type": "object", "properties": { "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "rows": { "type": "integer", "exclusiveMinimum": 0 } }, "required": ["code", "rows"], "additionalProperties": false } }, "blocking": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number"] } }, "fields": { "type": "array", "items": { "type": "string" } } }, "required": ["code", "params", "fields"], "additionalProperties": false } }, "stage": { "type": "string", "const": "precheck" } }, "required": ["warnings", "blocking", "stage"], "additionalProperties": false } ] }, "ImportFetchSummary": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid" } }, "required": ["fileId"], "additionalProperties": false }, "Job": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string" }, "waitingReason": { "anyOf": [ { "type": "string", "enum": ["paused"] }, { "type": "null" } ] }, "phase": { "type": ["string", "null"] }, "progress": { "type": "object", "properties": { "done": { "type": "integer" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": ["done", "total"], "additionalProperties": false }, "counters": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "integer" } }, "errorCount": { "type": "integer" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "apiKey": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" } }, "required": ["name"], "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "finishedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "canCancel": { "type": "boolean" }, "summary": { "anyOf": [ { "anyOf": [ { "$ref": "#/components/schemas/ImportCheckSummary" }, { "$ref": "#/components/schemas/ImportFetchSummary" } ] }, { "type": "null" } ] }, "state": { "type": "string", "const": "failed" }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number"] } } }, "required": ["code", "params"], "additionalProperties": false } }, "required": [ "id", "kind", "waitingReason", "phase", "progress", "counters", "errorCount", "createdBy", "apiKey", "createdAt", "finishedAt", "canCancel", "summary", "state", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string" }, "waitingReason": { "anyOf": [ { "type": "string", "enum": ["paused"] }, { "type": "null" } ] }, "phase": { "type": ["string", "null"] }, "progress": { "type": "object", "properties": { "done": { "type": "integer" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": ["done", "total"], "additionalProperties": false }, "counters": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "integer" } }, "errorCount": { "type": "integer" }, "createdBy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "apiKey": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" } }, "required": ["name"], "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "finishedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "canCancel": { "type": "boolean" }, "summary": { "anyOf": [ { "anyOf": [ { "$ref": "#/components/schemas/ImportCheckSummary" }, { "$ref": "#/components/schemas/ImportFetchSummary" } ] }, { "type": "null" } ] }, "state": { "type": "string", "enum": ["waiting", "running", "succeeded", "canceled"] }, "error": { "type": "null" } }, "required": [ "id", "kind", "waitingReason", "phase", "progress", "counters", "errorCount", "createdBy", "apiKey", "createdAt", "finishedAt", "canCancel", "summary", "state", "error" ], "additionalProperties": false } ] }, "JobFile": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "size": { "type": "integer" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": ["url", "name", "size", "expiresAt"], "additionalProperties": false }, "JobMessage": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "severity": { "type": "string", "enum": ["error", "warning", "blocked"] }, "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number"] } }, "rowNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "column": { "type": ["string", "null"] } }, "required": ["id", "severity", "code", "params", "rowNumber", "column"], "additionalProperties": false }, "JobMessagePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/JobMessage" } }, "nextCursor": { "type": ["string", "null"] }, "total": { "type": "integer" } }, "required": ["items", "nextCursor"], "additionalProperties": false }, "Credential": { "type": "object", "properties": { "org": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "type": { "type": "string", "enum": ["api_key", "oauth_grant"] }, "name": { "type": "string" }, "display": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "permissions": { "type": "array", "items": { "type": "string" } }, "limits": { "type": "object", "properties": { "read": { "type": "integer" }, "write": { "type": "integer" }, "bulk": { "type": "integer" } }, "required": ["read", "write", "bulk"], "additionalProperties": false }, "remaining": { "type": "object", "properties": { "read": { "type": "integer" }, "write": { "type": "integer" }, "bulk": { "type": "integer" } }, "required": ["read", "write", "bulk"], "additionalProperties": false }, "notice": { "anyOf": [ { "type": "object", "properties": { "en": { "type": "string" }, "es": { "type": "string" } }, "required": ["en", "es"], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "org", "type", "name", "display", "expiresAt", "permissions", "limits", "remaining", "notice" ], "additionalProperties": false }, "UploadedFile": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "size": { "type": "integer", "minimum": 0 }, "status": { "type": "string", "enum": ["pending", "ready", "rejected", "deleting"] } }, "required": ["id", "name", "size", "status"], "additionalProperties": false }, "VersionItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "at": { "type": "string", "format": "date-time" }, "event": { "type": "string", "enum": ["created", "updated", "restored", "merged"] }, "cause": { "type": "string", "enum": ["edit", "bulk", "import", "feed", "merge", "restore", "sync"] }, "writer": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "import", "feed", "integration", "system", "check", "api_key", "oauth_grant" ] }, "name": { "type": ["string", "null"] } }, "required": ["type", "name"], "additionalProperties": false } }, "required": ["id", "at", "event", "cause", "writer"], "additionalProperties": false }, "VersionList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VersionItem" } }, "canRestore": { "type": "boolean" } }, "required": ["items", "canRestore"], "additionalProperties": false }, "VersionComparison": { "type": "object", "properties": { "version": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "state": {} }, "required": ["id", "state"], "additionalProperties": false }, "against": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "state": {} }, "required": ["id", "state"], "additionalProperties": false }, { "type": "null" } ] }, "sameAsCurrent": { "type": "boolean" } }, "required": ["version", "against", "sameAsCurrent"], "additionalProperties": false }, "RestoreResult": { "type": "object", "properties": { "versionId": { "type": "string", "format": "uuid" }, "notRestored": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number"] } } }, "required": ["code"], "additionalProperties": false } } }, "required": ["versionId", "notRestored"], "additionalProperties": false }, "View": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "visibility": { "type": "string", "enum": ["private", "org"] }, "state": { "type": "object", "properties": { "question": { "type": "object", "properties": { "search": { "type": "string" }, "filter": { "type": "object", "properties": { "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "required": ["field", "op"], "additionalProperties": false } }, "logic": { "type": "string", "enum": ["and", "or"] } }, "required": ["items", "logic"], "additionalProperties": false }, "sort": { "type": "object", "properties": { "field": { "type": "string" }, "direction": { "type": "string", "enum": ["asc", "desc"] } }, "required": ["field", "direction"], "additionalProperties": false } }, "additionalProperties": false }, "columns": { "type": "array", "items": { "type": "string" } }, "hide": { "type": "array", "items": { "type": "string" } } }, "required": ["question"], "additionalProperties": false }, "mine": { "type": "boolean" }, "default": { "type": "boolean" } }, "required": ["id", "name", "visibility", "state", "mine", "default"], "additionalProperties": false }, "ViewPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/View" } }, "nextCursor": { "type": ["string", "null"] }, "total": { "type": "integer" } }, "required": ["items", "nextCursor"], "additionalProperties": false }, "DefaultView": { "type": "object", "properties": { "resource": { "type": "string", "minLength": 1 }, "viewId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": ["resource", "viewId"], "additionalProperties": false }, "DataioAdapterItem": { "type": "object", "properties": { "entity": { "type": "string" }, "module": { "type": "string", "enum": ["core", "integrations", "catalog", "pricing"] }, "fields": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object", "properties": { "ops": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "eq", "neq", "gt", "gte", "lt", "lte", "between", "contains", "notContains", "startsWith", "endsWith", "in", "empty", "notEmpty" ] } }, "options": { "type": "array", "items": { "type": "string" } } }, "required": ["ops"], "additionalProperties": false }, "type": { "type": "string", "enum": ["text", "number", "measure", "boolean", "instant", "list"] }, "names": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "aliases": { "type": "array", "items": { "type": "string" } }, "group": { "type": "string" }, "requiredToCreate": { "type": "boolean" }, "cleanable": { "type": "boolean" }, "exportable": { "type": "boolean" }, "decodeHtml": { "type": "boolean" } }, "required": ["key", "type", "names", "aliases", "group"], "additionalProperties": false }, { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object", "properties": { "ops": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "eq", "neq", "gt", "gte", "lt", "lte", "between", "contains", "notContains", "startsWith", "endsWith", "in", "empty", "notEmpty" ] } }, "options": { "type": "array", "items": { "type": "string" } } }, "required": ["ops"], "additionalProperties": false }, "type": { "type": "string", "const": "money" }, "currency": { "anyOf": [ { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XCD", "XCG", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWG" ] }, { "type": "string", "const": "org" } ] }, "names": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "aliases": { "type": "array", "items": { "type": "string" } }, "group": { "type": "string" }, "requiredToCreate": { "type": "boolean" }, "cleanable": { "type": "boolean" }, "exportable": { "type": "boolean" }, "decodeHtml": { "type": "boolean" } }, "required": ["key", "type", "currency", "names", "aliases", "group"], "additionalProperties": false } ] } }, "systemFields": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object", "properties": { "ops": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "eq", "neq", "gt", "gte", "lt", "lte", "between", "contains", "notContains", "startsWith", "endsWith", "in", "empty", "notEmpty" ] } }, "options": { "type": "array", "items": { "type": "string" } } }, "required": ["ops"], "additionalProperties": false }, "type": { "type": "string", "enum": ["text", "number", "measure", "boolean", "instant", "list"] }, "names": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "aliases": { "type": "array", "items": { "type": "string" } }, "group": { "type": "string" }, "requiredToCreate": { "type": "boolean" }, "cleanable": { "type": "boolean" }, "exportable": { "type": "boolean" }, "decodeHtml": { "type": "boolean" } }, "required": ["key", "type", "names", "aliases", "group"], "additionalProperties": false }, { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object", "properties": { "ops": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "eq", "neq", "gt", "gte", "lt", "lte", "between", "contains", "notContains", "startsWith", "endsWith", "in", "empty", "notEmpty" ] } }, "options": { "type": "array", "items": { "type": "string" } } }, "required": ["ops"], "additionalProperties": false }, "type": { "type": "string", "const": "money" }, "currency": { "anyOf": [ { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XCD", "XCG", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWG" ] }, { "type": "string", "const": "org" } ] }, "names": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "aliases": { "type": "array", "items": { "type": "string" } }, "group": { "type": "string" }, "requiredToCreate": { "type": "boolean" }, "cleanable": { "type": "boolean" }, "exportable": { "type": "boolean" }, "decodeHtml": { "type": "boolean" } }, "required": ["key", "type", "currency", "names", "aliases", "group"], "additionalProperties": false } ] } }, "modes": { "type": "array", "items": { "type": "string", "enum": ["create", "update", "clean", "delete"] } }, "matchTargets": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } } }, "required": ["key", "fields"], "additionalProperties": false } }, "options": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "key": { "type": "string" }, "group": { "type": "string" }, "type": { "type": "string", "const": "values" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "default": { "type": "string" } }, "required": ["key", "group", "type", "values", "default"], "additionalProperties": false }, { "type": "object", "properties": { "key": { "type": "string" }, "group": { "type": "string" }, "type": { "type": "string", "const": "text" }, "maxLength": { "type": "integer", "exclusiveMinimum": 0 }, "default": { "type": "string" } }, "required": ["key", "group", "type", "maxLength", "default"], "additionalProperties": false } ] } }, "can": { "type": "object", "properties": { "import": { "type": "boolean" }, "export": { "type": "boolean" }, "template": { "type": "boolean" } }, "required": ["import", "export", "template"], "additionalProperties": false } }, "required": [ "entity", "module", "fields", "systemFields", "modes", "matchTargets", "options", "can" ], "additionalProperties": false }, "DataioAdapterPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DataioAdapterItem" } }, "nextCursor": { "type": ["string", "null"] }, "total": { "type": "integer" } }, "required": ["items", "nextCursor"], "additionalProperties": false }, "DataioAdapterDetail": { "type": "object", "properties": { "entity": { "type": "string" }, "module": { "type": "string", "enum": ["core", "integrations", "catalog", "pricing"] }, "fields": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object", "properties": { "ops": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "eq", "neq", "gt", "gte", "lt", "lte", "between", "contains", "notContains", "startsWith", "endsWith", "in", "empty", "notEmpty" ] } }, "options": { "type": "array", "items": { "type": "string" } } }, "required": ["ops"], "additionalProperties": false }, "type": { "type": "string", "enum": ["text", "number", "measure", "boolean", "instant", "list"] }, "names": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "aliases": { "type": "array", "items": { "type": "string" } }, "group": { "type": "string" }, "requiredToCreate": { "type": "boolean" }, "cleanable": { "type": "boolean" }, "exportable": { "type": "boolean" }, "decodeHtml": { "type": "boolean" } }, "required": ["key", "type", "names", "aliases", "group"], "additionalProperties": false }, { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object", "properties": { "ops": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "eq", "neq", "gt", "gte", "lt", "lte", "between", "contains", "notContains", "startsWith", "endsWith", "in", "empty", "notEmpty" ] } }, "options": { "type": "array", "items": { "type": "string" } } }, "required": ["ops"], "additionalProperties": false }, "type": { "type": "string", "const": "money" }, "currency": { "anyOf": [ { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XCD", "XCG", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWG" ] }, { "type": "string", "const": "org" } ] }, "names": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "aliases": { "type": "array", "items": { "type": "string" } }, "group": { "type": "string" }, "requiredToCreate": { "type": "boolean" }, "cleanable": { "type": "boolean" }, "exportable": { "type": "boolean" }, "decodeHtml": { "type": "boolean" } }, "required": ["key", "type", "currency", "names", "aliases", "group"], "additionalProperties": false } ] } }, "systemFields": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object", "properties": { "ops": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "eq", "neq", "gt", "gte", "lt", "lte", "between", "contains", "notContains", "startsWith", "endsWith", "in", "empty", "notEmpty" ] } }, "options": { "type": "array", "items": { "type": "string" } } }, "required": ["ops"], "additionalProperties": false }, "type": { "type": "string", "enum": ["text", "number", "measure", "boolean", "instant", "list"] }, "names": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "aliases": { "type": "array", "items": { "type": "string" } }, "group": { "type": "string" }, "requiredToCreate": { "type": "boolean" }, "cleanable": { "type": "boolean" }, "exportable": { "type": "boolean" }, "decodeHtml": { "type": "boolean" } }, "required": ["key", "type", "names", "aliases", "group"], "additionalProperties": false }, { "type": "object", "properties": { "key": { "type": "string" }, "filter": { "type": "object", "properties": { "ops": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "eq", "neq", "gt", "gte", "lt", "lte", "between", "contains", "notContains", "startsWith", "endsWith", "in", "empty", "notEmpty" ] } }, "options": { "type": "array", "items": { "type": "string" } } }, "required": ["ops"], "additionalProperties": false }, "type": { "type": "string", "const": "money" }, "currency": { "anyOf": [ { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XCD", "XCG", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWG" ] }, { "type": "string", "const": "org" } ] }, "names": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "aliases": { "type": "array", "items": { "type": "string" } }, "group": { "type": "string" }, "requiredToCreate": { "type": "boolean" }, "cleanable": { "type": "boolean" }, "exportable": { "type": "boolean" }, "decodeHtml": { "type": "boolean" } }, "required": ["key", "type", "currency", "names", "aliases", "group"], "additionalProperties": false } ] } }, "modes": { "type": "array", "items": { "type": "string", "enum": ["create", "update", "clean", "delete"] } }, "matchTargets": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } } }, "required": ["key", "fields"], "additionalProperties": false } }, "options": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "key": { "type": "string" }, "group": { "type": "string" }, "type": { "type": "string", "const": "values" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "default": { "type": "string" } }, "required": ["key", "group", "type", "values", "default"], "additionalProperties": false }, { "type": "object", "properties": { "key": { "type": "string" }, "group": { "type": "string" }, "type": { "type": "string", "const": "text" }, "maxLength": { "type": "integer", "exclusiveMinimum": 0 }, "default": { "type": "string" } }, "required": ["key", "group", "type", "maxLength", "default"], "additionalProperties": false } ] } }, "can": { "type": "object", "properties": { "import": { "type": "boolean" }, "export": { "type": "boolean" }, "template": { "type": "boolean" } }, "required": ["import", "export", "template"], "additionalProperties": false }, "counts": { "type": "array", "items": { "type": "object", "properties": { "noun": { "type": "string" }, "count": { "type": "integer", "minimum": 0 } }, "required": ["noun", "count"], "additionalProperties": false } } }, "required": [ "entity", "module", "fields", "systemFields", "modes", "matchTargets", "options", "can", "counts" ], "additionalProperties": false }, "ExportDefinition": { "type": "object", "properties": { "entities": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "columns": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "question": { "type": "object", "properties": { "search": { "type": "string" }, "filter": { "type": "object", "properties": { "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "required": ["field", "op"], "additionalProperties": false } }, "logic": { "type": "string", "enum": ["and", "or"] } }, "required": ["items", "logic"], "additionalProperties": false }, "sort": { "type": "object", "properties": { "field": { "type": "string" }, "direction": { "type": "string", "enum": ["asc", "desc"] } }, "required": ["field", "direction"], "additionalProperties": false } }, "additionalProperties": false } }, "required": ["entity", "columns", "question"], "additionalProperties": false } }, "format": { "type": "string", "enum": ["csv", "xlsx"] }, "delimiter": { "default": ",", "type": "string", "enum": [",", ";", "\t", "|"] }, "dateFormat": { "default": "sql", "type": "string", "enum": ["sql", "iso"] }, "compression": { "default": "none", "type": "string", "enum": ["none", "gzip", "zip"] }, "listSeparator": { "default": "|", "type": "string", "minLength": 1, "maxLength": 3 }, "systemFields": { "default": false, "type": "boolean" } }, "required": [ "entities", "format", "delimiter", "dateFormat", "compression", "listSeparator", "systemFields" ], "additionalProperties": false }, "ExportTemplate": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "module": { "type": "string", "enum": ["core", "integrations", "catalog", "pricing"] }, "name": { "type": "string" }, "definition": { "$ref": "#/components/schemas/ExportDefinition" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": ["id", "module", "name", "definition", "createdAt", "updatedAt"], "additionalProperties": false }, "ExportTemplatePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExportTemplate" } }, "nextCursor": { "type": ["string", "null"] }, "total": { "type": "integer" } }, "required": ["items", "nextCursor"], "additionalProperties": false }, "ExportFileName": { "type": "object", "properties": { "fileName": { "type": "string" } }, "required": ["fileName"], "additionalProperties": false }, "ImportUpload": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" }, "contentType": { "type": "string" } }, "required": ["fileId", "url", "contentType"], "additionalProperties": false }, "ImportItem": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "waitingReason": { "anyOf": [ { "type": "string", "enum": ["paused"] }, { "type": "null" } ] }, "progress": { "type": "object", "properties": { "done": { "type": "integer" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": ["done", "total"], "additionalProperties": false }, "apiKey": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" } }, "required": ["name"], "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "finishedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "canCancel": { "type": "boolean" }, "file": { "type": "object", "properties": { "name": { "type": ["string", "null"] }, "expired": { "type": "boolean" } }, "required": ["name", "expired"], "additionalProperties": false }, "permission": { "type": "string" }, "module": { "type": "string", "enum": ["core", "integrations", "catalog", "pricing"] }, "createdBy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": ["string", "null"] } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "entity": { "type": "string" }, "mode": { "type": "string", "enum": ["create", "update", "clean", "delete"] }, "fields": { "type": "integer" }, "counters": { "type": "object", "properties": { "success": { "type": "integer" }, "warning": { "type": "integer" }, "error": { "type": "integer" }, "blocked": { "type": "integer" } }, "required": ["success", "warning", "error", "blocked"], "additionalProperties": false }, "state": { "type": "string", "const": "failed" }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number"] } } }, "required": ["code", "params"], "additionalProperties": false } }, "required": [ "id", "waitingReason", "progress", "apiKey", "createdAt", "finishedAt", "canCancel", "file", "permission", "module", "createdBy", "entity", "mode", "fields", "counters", "state", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "waitingReason": { "anyOf": [ { "type": "string", "enum": ["paused"] }, { "type": "null" } ] }, "progress": { "type": "object", "properties": { "done": { "type": "integer" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": ["done", "total"], "additionalProperties": false }, "apiKey": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" } }, "required": ["name"], "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "finishedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "canCancel": { "type": "boolean" }, "file": { "type": "object", "properties": { "name": { "type": ["string", "null"] }, "expired": { "type": "boolean" } }, "required": ["name", "expired"], "additionalProperties": false }, "permission": { "type": "string" }, "module": { "type": "string", "enum": ["core", "integrations", "catalog", "pricing"] }, "createdBy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": ["string", "null"] } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "entity": { "type": "string" }, "mode": { "type": "string", "enum": ["create", "update", "clean", "delete"] }, "fields": { "type": "integer" }, "counters": { "type": "object", "properties": { "success": { "type": "integer" }, "warning": { "type": "integer" }, "error": { "type": "integer" }, "blocked": { "type": "integer" } }, "required": ["success", "warning", "error", "blocked"], "additionalProperties": false }, "state": { "type": "string", "enum": ["waiting", "running", "succeeded", "canceled"] }, "error": { "type": "null" } }, "required": [ "id", "waitingReason", "progress", "apiKey", "createdAt", "finishedAt", "canCancel", "file", "permission", "module", "createdBy", "entity", "mode", "fields", "counters", "state", "error" ], "additionalProperties": false } ] }, "ImportPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ImportItem" } }, "nextCursor": { "type": ["string", "null"] }, "total": { "type": "integer" } }, "required": ["items", "nextCursor"], "additionalProperties": false }, "ExportItem": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "waitingReason": { "anyOf": [ { "type": "string", "enum": ["paused"] }, { "type": "null" } ] }, "progress": { "type": "object", "properties": { "done": { "type": "integer" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": ["done", "total"], "additionalProperties": false }, "apiKey": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" } }, "required": ["name"], "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "finishedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "canCancel": { "type": "boolean" }, "file": { "type": "object", "properties": { "name": { "type": ["string", "null"] }, "expired": { "type": "boolean" } }, "required": ["name", "expired"], "additionalProperties": false }, "permission": { "type": "string" }, "module": { "type": "string", "enum": ["core", "integrations", "catalog", "pricing"] }, "createdBy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": ["string", "null"] } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "entities": { "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "format": { "type": "string", "enum": ["csv", "xlsx"] }, "ceiling": { "type": "string", "enum": ["rows", "cell"] }, "filter": { "type": "object", "properties": { "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "required": ["field", "op"], "additionalProperties": false } }, "logic": { "type": "string", "enum": ["and", "or"] } }, "required": ["items", "logic"], "additionalProperties": false } }, "required": ["entity", "format"], "additionalProperties": false } }, "fields": { "type": "integer" }, "filters": { "type": "integer" }, "format": { "type": "string", "enum": ["csv", "xlsx"] }, "rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "state": { "type": "string", "const": "failed" }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number"] } } }, "required": ["code", "params"], "additionalProperties": false } }, "required": [ "id", "waitingReason", "progress", "apiKey", "createdAt", "finishedAt", "canCancel", "file", "permission", "module", "createdBy", "entities", "fields", "filters", "format", "rows", "size", "state", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "waitingReason": { "anyOf": [ { "type": "string", "enum": ["paused"] }, { "type": "null" } ] }, "progress": { "type": "object", "properties": { "done": { "type": "integer" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": ["done", "total"], "additionalProperties": false }, "apiKey": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" } }, "required": ["name"], "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "finishedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "canCancel": { "type": "boolean" }, "file": { "type": "object", "properties": { "name": { "type": ["string", "null"] }, "expired": { "type": "boolean" } }, "required": ["name", "expired"], "additionalProperties": false }, "permission": { "type": "string" }, "module": { "type": "string", "enum": ["core", "integrations", "catalog", "pricing"] }, "createdBy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": ["string", "null"] } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "entities": { "type": "array", "items": { "type": "object", "properties": { "entity": { "type": "string" }, "format": { "type": "string", "enum": ["csv", "xlsx"] }, "ceiling": { "type": "string", "enum": ["rows", "cell"] }, "filter": { "type": "object", "properties": { "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "required": ["field", "op"], "additionalProperties": false } }, "logic": { "type": "string", "enum": ["and", "or"] } }, "required": ["items", "logic"], "additionalProperties": false } }, "required": ["entity", "format"], "additionalProperties": false } }, "fields": { "type": "integer" }, "filters": { "type": "integer" }, "format": { "type": "string", "enum": ["csv", "xlsx"] }, "rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "state": { "type": "string", "enum": ["waiting", "running", "succeeded", "canceled"] }, "error": { "type": "null" } }, "required": [ "id", "waitingReason", "progress", "apiKey", "createdAt", "finishedAt", "canCancel", "file", "permission", "module", "createdBy", "entities", "fields", "filters", "format", "rows", "size", "state", "error" ], "additionalProperties": false } ] }, "ExportPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExportItem" } }, "nextCursor": { "type": ["string", "null"] }, "total": { "type": "integer" } }, "required": ["items", "nextCursor"], "additionalProperties": false }, "ImportStarted": { "type": "object", "properties": { "jobId": { "type": "string", "format": "uuid" } }, "required": ["jobId"], "additionalProperties": false }, "Incident": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number"] } }, "message": { "type": "string" }, "entity": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "pattern": "^(core|integrations|catalog|pricing)\\.[\\s\\S]{0,}$" }, "id": { "type": "string", "format": "uuid" }, "label": { "type": ["string", "null"] } }, "required": ["type", "id", "label"], "additionalProperties": false }, { "type": "null" } ] }, "action": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "link" }, "label": { "type": "string" }, "path": { "type": "string" } }, "required": ["kind", "label", "path"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "resolve" } }, "required": ["kind"], "additionalProperties": false } ] }, { "type": "null" } ] }, "read": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "resolvedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } }, "required": [ "id", "code", "params", "message", "entity", "action", "read", "createdAt", "resolvedAt" ], "additionalProperties": false }, "IncidentPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Incident" } }, "nextCursor": { "type": ["string", "null"] }, "total": { "type": "integer" } }, "required": ["items", "nextCursor"], "additionalProperties": false }, "Notification": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "key": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean", "null"] } }, "actorUserId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "link": { "type": ["string", "null"] }, "read": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": ["id", "key", "params", "actorUserId", "link", "read", "createdAt"], "additionalProperties": false }, "NotificationPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } }, "nextCursor": { "type": ["string", "null"] }, "total": { "type": "integer" } }, "required": ["items", "nextCursor"], "additionalProperties": false }, "MarkedAllRead": { "type": "object", "properties": { "notices": { "type": "integer", "minimum": 0 }, "problems": { "type": "integer", "minimum": 0 } }, "required": ["notices", "problems"], "additionalProperties": false }, "SearchHit": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "image": { "type": "string", "format": "uri" }, "status": { "type": "object", "properties": { "value": { "type": "string" }, "tone": { "type": "string", "enum": ["neutral", "accent", "success", "warning", "danger"] } }, "required": ["value", "tone"], "additionalProperties": false }, "url": { "type": "string", "format": "starts_with", "pattern": "^\\/.*" } }, "required": ["id", "title", "url"], "additionalProperties": false }, "SearchResult": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "pattern": "^(core|integrations|catalog|pricing)\\.[\\s\\S]{0,}$" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SearchHit" } }, "more": { "type": "boolean" } }, "required": ["kind", "items", "more"], "additionalProperties": false } } }, "required": ["groups"], "additionalProperties": false }, "Product": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string", "enum": ["draft", "active", "unlisted", "archived"] }, "condition": { "type": "string", "enum": [ "new", "open_box", "new_with_defects", "used", "used_like_new", "used_very_good", "used_good", "used_acceptable", "refurbished", "collectible_like_new", "collectible_very_good", "collectible_good", "collectible_acceptable", "for_parts_or_not_working" ] }, "productType": { "type": ["string", "null"] }, "descriptionHtml": { "description": "The product's description in HTML, as it was saved; null when it has none.", "type": ["string", "null"] }, "metaTitle": { "type": ["string", "null"] }, "metaDescription": { "type": ["string", "null"] }, "version": { "type": "integer" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "import", "feed", "integration", "system", "check", "api_key", "oauth_grant" ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": ["type", "id"], "additionalProperties": false }, "updatedBy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "import", "feed", "integration", "system", "check", "api_key", "oauth_grant" ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": ["type", "id"], "additionalProperties": false }, "options": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "position": { "type": "integer" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "position": { "type": "integer" } }, "required": ["id", "name", "position"], "additionalProperties": false } } }, "required": ["id", "name", "position", "values"], "additionalProperties": false } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "optionValueIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": ["sku", "gtin", "isbn", "mpn", "custom"] }, "value": { "type": "string" }, "label": { "type": ["string", "null"] } }, "required": ["type", "value", "label"], "additionalProperties": false } }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XCD", "XCG", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWG" ] }, "price": { "type": ["string", "null"] }, "compareAt": { "type": ["string", "null"] }, "map": { "type": ["string", "null"] }, "msrp": { "type": ["string", "null"] }, "onHandCost": { "type": ["string", "null"] }, "supplierCost": { "type": ["string", "null"] }, "fallbackCost": { "type": ["string", "null"] }, "productWeight": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["g", "kg", "oz", "lb", "ct"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The product's own weight, a value with its unit (g, kg, oz, lb, ct); a value of 0 is saved as none." }, "productLength": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The product's own length, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none." }, "productWidth": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The product's own width, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none." }, "productHeight": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The product's own height, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none." }, "shippingWeight": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["g", "kg", "oz", "lb", "ct"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The weight it ships with, packed, a value with its unit (g, kg, oz, lb, ct); a value of 0 is saved as none." }, "shippingLength": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The length of its package, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none." }, "shippingWidth": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The width of its package, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none." }, "shippingHeight": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The height of its package, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none." }, "countryOfOrigin": { "description": "The country it is made in, as its two-letter ISO 3166-1 code such as MX.", "type": ["string", "null"] }, "hsCode": { "description": "Its Harmonized System customs code, its 6 to 13 digits alone.", "type": ["string", "null"] }, "trackInventory": { "type": "boolean", "description": "Whether its stock is tracked; a variant no longer tracked has none of its three stocks." }, "onHandStock": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 2147483647 }, { "type": "null" } ], "description": "The stock on hand, as the stores report it, for a tracked variant only." }, "supplierStock": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 2147483647 }, { "type": "null" } ], "description": "The stock at its supplier, as the supplier's feed reports it, for a tracked variant only." }, "fallbackStock": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "The stock it falls back on when it has none on hand or at its supplier, for a tracked variant only; one tracked without it has 0." }, { "type": "null" } ] }, "createdBy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "import", "feed", "integration", "system", "check", "api_key", "oauth_grant" ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": ["type", "id"], "additionalProperties": false }, "updatedBy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "import", "feed", "integration", "system", "check", "api_key", "oauth_grant" ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": ["type", "id"], "additionalProperties": false } }, "required": [ "id", "optionValueIds", "identifiers", "currency", "price", "compareAt", "map", "msrp", "onHandCost", "supplierCost", "fallbackCost", "productWeight", "productLength", "productWidth", "productHeight", "shippingWeight", "shippingLength", "shippingWidth", "shippingHeight", "countryOfOrigin", "hsCode", "trackInventory", "onHandStock", "supplierStock", "fallbackStock", "createdBy", "updatedBy" ], "additionalProperties": false } } }, "required": [ "id", "title", "slug", "status", "condition", "productType", "descriptionHtml", "metaTitle", "metaDescription", "version", "createdAt", "updatedAt", "createdBy", "updatedBy", "options", "variants" ], "additionalProperties": false }, "FreeSku": { "type": "object", "properties": { "sku": { "type": "string" } }, "required": ["sku"], "additionalProperties": false }, "ProductSaved": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string", "enum": ["draft", "active", "unlisted", "archived"] }, "condition": { "type": "string", "enum": [ "new", "open_box", "new_with_defects", "used", "used_like_new", "used_very_good", "used_good", "used_acceptable", "refurbished", "collectible_like_new", "collectible_very_good", "collectible_good", "collectible_acceptable", "for_parts_or_not_working" ] }, "productType": { "type": ["string", "null"] }, "descriptionHtml": { "description": "The product's description in HTML, as it was saved; null when it has none.", "type": ["string", "null"] }, "metaTitle": { "type": ["string", "null"] }, "metaDescription": { "type": ["string", "null"] }, "version": { "type": "integer" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "import", "feed", "integration", "system", "check", "api_key", "oauth_grant" ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": ["type", "id"], "additionalProperties": false }, "updatedBy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "import", "feed", "integration", "system", "check", "api_key", "oauth_grant" ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": ["type", "id"], "additionalProperties": false }, "options": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "position": { "type": "integer" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "position": { "type": "integer" } }, "required": ["id", "name", "position"], "additionalProperties": false } } }, "required": ["id", "name", "position", "values"], "additionalProperties": false } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "optionValueIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": ["sku", "gtin", "isbn", "mpn", "custom"] }, "value": { "type": "string" }, "label": { "type": ["string", "null"] } }, "required": ["type", "value", "label"], "additionalProperties": false } }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XCD", "XCG", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWG" ] }, "price": { "type": ["string", "null"] }, "compareAt": { "type": ["string", "null"] }, "map": { "type": ["string", "null"] }, "msrp": { "type": ["string", "null"] }, "onHandCost": { "type": ["string", "null"] }, "supplierCost": { "type": ["string", "null"] }, "fallbackCost": { "type": ["string", "null"] }, "productWeight": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["g", "kg", "oz", "lb", "ct"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The product's own weight, a value with its unit (g, kg, oz, lb, ct); a value of 0 is saved as none." }, "productLength": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The product's own length, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none." }, "productWidth": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The product's own width, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none." }, "productHeight": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The product's own height, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none." }, "shippingWeight": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["g", "kg", "oz", "lb", "ct"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The weight it ships with, packed, a value with its unit (g, kg, oz, lb, ct); a value of 0 is saved as none." }, "shippingLength": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The length of its package, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none." }, "shippingWidth": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The width of its package, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none." }, "shippingHeight": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": ["mm", "cm", "in", "yd"] } }, "required": ["value", "unit"], "additionalProperties": false }, { "type": "null" } ], "description": "The height of its package, a value with its unit (mm, cm, in, yd); a value of 0 is saved as none." }, "countryOfOrigin": { "description": "The country it is made in, as its two-letter ISO 3166-1 code such as MX.", "type": ["string", "null"] }, "hsCode": { "description": "Its Harmonized System customs code, its 6 to 13 digits alone.", "type": ["string", "null"] }, "trackInventory": { "type": "boolean", "description": "Whether its stock is tracked; a variant no longer tracked has none of its three stocks." }, "onHandStock": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 2147483647 }, { "type": "null" } ], "description": "The stock on hand, as the stores report it, for a tracked variant only." }, "supplierStock": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 2147483647 }, { "type": "null" } ], "description": "The stock at its supplier, as the supplier's feed reports it, for a tracked variant only." }, "fallbackStock": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "The stock it falls back on when it has none on hand or at its supplier, for a tracked variant only; one tracked without it has 0." }, { "type": "null" } ] }, "createdBy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "import", "feed", "integration", "system", "check", "api_key", "oauth_grant" ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": ["type", "id"], "additionalProperties": false }, "updatedBy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "import", "feed", "integration", "system", "check", "api_key", "oauth_grant" ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": ["type", "id"], "additionalProperties": false } }, "required": [ "id", "optionValueIds", "identifiers", "currency", "price", "compareAt", "map", "msrp", "onHandCost", "supplierCost", "fallbackCost", "productWeight", "productLength", "productWidth", "productHeight", "shippingWeight", "shippingLength", "shippingWidth", "shippingHeight", "countryOfOrigin", "hsCode", "trackInventory", "onHandStock", "supplierStock", "fallbackStock", "createdBy", "updatedBy" ], "additionalProperties": false } }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "catalog.part_number_similar", "catalog.compare_below_price", "catalog.price_below_cost", "catalog.price_below_map", "catalog.price_above_msrp", "catalog.map_above_msrp", "catalog.cost_above_map", "catalog.cost_above_msrp" ] }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number"] } } }, "required": ["code", "params"], "additionalProperties": false } } }, "required": [ "id", "title", "slug", "status", "condition", "productType", "descriptionHtml", "metaTitle", "metaDescription", "version", "createdAt", "updatedAt", "createdBy", "updatedBy", "options", "variants", "warnings" ], "additionalProperties": false }, "ProductItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string", "enum": ["draft", "active", "unlisted", "archived"] }, "variantCount": { "type": "integer" }, "version": { "type": "integer" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": ["id", "title", "slug", "status", "variantCount", "version", "updatedAt"], "additionalProperties": false }, "ProductPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProductItem" } }, "nextCursor": { "type": ["string", "null"] }, "total": { "type": "integer" } }, "required": ["items", "nextCursor"], "additionalProperties": false }, "Connection": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "provider": { "type": "string", "enum": [ "amazon", "shopify", "bigcommerce", "square", "walmart", "ebay", "google_merchant" ] }, "label": { "type": "string" }, "authState": { "type": "string", "enum": ["connected", "needs_reauth", "unavailable", "terminated"] }, "lifecycle": { "type": "string", "enum": ["active", "disconnecting"] }, "writesPaused": { "type": "boolean" } }, "required": ["id", "provider", "label", "authState", "lifecycle", "writesPaused"], "additionalProperties": false }, "ConnectionPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Connection" } }, "nextCursor": { "type": ["string", "null"] }, "total": { "type": "integer" } }, "required": ["items", "nextCursor"], "additionalProperties": false }, "Problem": { "type": "object", "properties": { "type": { "type": "string", "pattern": "^urn:rfc:problem:[\\s\\S]{0,}\\.[\\s\\S]{0,}$" }, "status": { "type": "integer" }, "title": { "type": "string" }, "code": { "type": "string", "pattern": "^[\\s\\S]{0,}\\.[\\s\\S]{0,}$" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "requestId": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "location": { "type": "string" }, "pointer": { "type": "string" }, "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": ["location", "pointer", "code"], "additionalProperties": false } } }, "required": ["type", "status", "code", "requestId"], "additionalProperties": false } }, "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer", "description": "Una llave de API de la organización, enviada en cada llamada como `Authorization: Bearer `. La crea una persona de la organización en la aplicación, en **Ajustes › API y conexiones › Llaves de API**." } } } }