Actualizar · Reglas — Análisis y reglas de búsqueda
Modifica los datos indicados en «Análisis y reglas de búsqueda». A continuación se describen los campos obligatorios y las reglas de escritura.
PATCH/api/v1/search/rules/{rule_id}
- Autenticación
Bearer- Disponible desde
- STANDARD
- Permisos necesarios
search.rule:update
Ejemplos de código
Ejemplo de solicitud
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request PATCH \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--header 'Idempotency-Key: example-update_rule_api_v1_search_rules__rule_id__patch' \
--header 'Content-Type: application/json' \
--data-raw '{
"expected_version": 1,
"name": "Example"
}' \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/search/rules/example
PHP
<?php
declare(strict_types=1);
$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
isset($origin['query']) || isset($origin['fragment'])) {
throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
throw new RuntimeException('Invalid credential');
}
$headers = ['Idempotency-Key: example-update_rule_api_v1_search_rules__rule_id__patch', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/search/rules/example');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_SSL_VERIFYHOST => 2,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_TIMEOUT => 30,
CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
if (str_contains($line, ':')) {
[$name, $value] = explode(':', $line, 2);
$responseHeaders[strtolower(trim($name))] = trim($value);
}
return strlen($line);
},
]);
curl_setopt($handle, CURLOPT_POSTFIELDS, '{
"expected_version": 1,
"name": "Example"
}');
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
throw new RuntimeException('HTTP ' . $status . '; request_id=' .
($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;
Python
from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit
import requests # python -m pip install requests
base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
raise ValueError("Invalid credential")
headers = {'Idempotency-Key': 'example-update_rule_api_v1_search_rules__rule_id__patch'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n "expected_version": 1,\n "name": "Example"\n}'
if body is not None:
headers["Content-Type"] = "application/json"
with ExitStack() as stack:
session = stack.enter_context(requests.Session())
files = None
if False:
image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
if os.fstat(image.fileno()).st_size > 5242880:
raise ValueError("Image exceeds 5 MiB")
files = {"file": ("article.png", image, "image/png")}
response = session.request(
'PATCH', base_url + '/api/v1/search/rules/example', headers=headers,
data=body.encode("utf-8") if body is not None else None, files=files,
timeout=(5, 30), allow_redirects=False,
)
if not 200 <= response.status_code < 300:
raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
if False:
if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
raise ValueError("Unexpected image response")
with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
output.write(response.content)
else:
result = response.json() if response.content else None
print(json.dumps(result, ensure_ascii=False, indent=2))
Ejemplo de respuesta 200
{
"data": {
"deleted": false,
"id": "example",
"version": 1
},
"meta": {
"request_id": "example"
}
}
Cómo funciona
- GET /api/v1/search/overview y /api/v1/search/queries muestran estadísticas resumidas y consultas agrupadas.
- Obtén las apariciones de una consulta mediante su query_hash.
- Los periodos de informe admiten 7, 30 o 90 días, con los filtros indicados para cada endpoint.
- Las reglas de búsqueda relacionan frases con productos y categorías seleccionados y se pueden crear, consultar, actualizar o eliminar.
- Las reglas y el análisis tienen permisos independientes; leer estadísticas de búsqueda no concede acceso a la configuración.
Parámetros
Parámetros de ruta
rule_idCadena de textoObligatorioIdentificador de la regla de búsqueda.
Restricciones
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Parámetros de consulta
localeCadena de texto nullOpcionalIdioma seleccionado para esta solicitud.
Cadena de texto:minLength:2maxLength:20market_idCadena de texto nullOpcionalIdentificador del mercado devuelto por el endpoint de contexto.
Restricciones · Cadena de texto 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeCadena de texto nullOpcionalCódigo del mercado devuelto por el endpoint de contexto.
Cadena de texto:minLength:1maxLength:16
Cabeceras de solicitud
Idempotency-KeyCadena de textoObligatorioIdentificador único de una operación lógica de escritura.
minLength:1maxLength:128Restricciones
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Cuerpo de la solicitud
application/json · Obligatorio
RuleUpdate
category_idsLista <Cadena de texto> OpcionalIdentificadores de las categorías relacionadas.
maxItems:100Lista:minLength:1maxLength:63enabledBooleanoOpcionalIndica si esta opción está habilitada.
expected_versionNúmero enteroObligatorioVersión leída antes de escribir; si no coincide, se rechaza la actualización.
minimum:1maximum:2147483647market_idsLista <Cadena de texto> OpcionalIdentificadores de los mercados seleccionados.
maxItems:1000Lista:minLength:1maxLength:63market_scopeCadena de textoOpcionalIndica si el recurso se aplica a todos los mercados o solo a los seleccionados.
Restricciones
enum["all", "selected"]
nameCadena de textoOpcionalNombre del recurso en el contexto correspondiente.
minLength:1maxLength:160phrasesLista <Cadena de texto> OpcionalFrases utilizadas por la regla de búsqueda.
maxItems:20Lista:minLength:1maxLength:255product_idsLista <Cadena de texto> OpcionalIdentificadores de los productos relacionados.
maxItems:100Lista:minLength:1maxLength:63
Respuestas
Respuesta 200
Modelo completo: ApiResponse_MutationData_
dataMutationDataObligatorioContenido de una respuesta correcta.
Campos ·
datadeletedBooleanoObligatorioIndica si se aplicó la eliminación.
idCadena de textoObligatorioIdentificador del recurso; consérvalo tal como se devuelve.
versionNúmero entero nullObligatorioVersión del recurso utilizada para controlar cambios simultáneos.
metaContextPageMetaContextMetaPageMetaRequestMetaObligatorioMetadatos de la respuesta.
Campos ·
metaModelo completo:
ContextPageMetalocaleCadena de textoObligatorioIdioma seleccionado para esta solicitud.
market_codeCadena de textoObligatorioCódigo del mercado devuelto por el endpoint de contexto.
market_idCadena de textoObligatorioIdentificador del mercado devuelto por el endpoint de contexto.
paginationPaginationObligatorioMetadatos de la paginación por cursor.
request_idCadena de textoObligatorioIdentificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.
minLength:1maxLength:100
localeCadena de textoObligatorioIdioma seleccionado para esta solicitud.
market_codeCadena de textoObligatorioCódigo del mercado devuelto por el endpoint de contexto.
market_idCadena de textoObligatorioIdentificador del mercado devuelto por el endpoint de contexto.
request_idCadena de textoObligatorioIdentificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.
minLength:1maxLength:100
paginationPaginationObligatorioMetadatos de la paginación por cursor.
request_idCadena de textoObligatorioIdentificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.
minLength:1maxLength:100
request_idCadena de textoObligatorioIdentificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.
minLength:1maxLength:100
Estado HTTP
200- Respuesta correcta Esquema
400- Solicitud no válida
401- Autenticación necesaria
403- Permiso denegado
404- Recurso no encontrado
409- Conflicto de versión
422- Error de validación
429- Límite de solicitudes excedido
Otros estados HTTP (7)
405- Método no permitido
413- Solicitud demasiado grande
415- Formato no compatible
500- Error del servidor
502- Error de la pasarela API
503- Servicio no disponible
504- Tiempo de espera agotado
Catálogo de errores: ErrorResponse
Cabeceras
401
WWW-AuthenticateCadena de textoOpcionalEsquema de autenticación exigido por el servidor.
405
AllowCadena de textoOpcionalMétodos HTTP admitidos por este recurso.
429, 503
Retry-AfterNúmero enteroOpcionalEspera mínima antes de reintentar, en segundos.
minimum:0