Promociones · Listar

Promociones · Listar. Todos los códigos deben permitir combinaciones. Los descuentos se aplican en orden.

GET`/api/v1/discounts/promotions`

Autenticación: Bearer
Disponible desde: STANDARD
Permisos necesarios: discounts.promotions:read

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 GET \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/discounts/promotions

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 = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/discounts/promotions');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    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);
    },
]);
$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 = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
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(
        'GET', base_url + '/api/v1/discounts/promotions', 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

JSON

{
  "data": [],
  "meta": {
    "locale": "example",
    "market_code": "example",
    "market_id": "poland",
    "pagination": {
      "has_more": false,
      "limit": 1,
      "next_cursor": null
    },
    "request_id": "learn-example-request"
  }
}

Vista general

Se incluyen los productos y categorías seleccionados. Las categorías incluyen los productos asignados directamente.

Escrituras seguras

Permisos y planes

Parámetros

Parámetros de consulta

limitNúmero enteroOpcional

Número máximo de registros en esta página.

minimum: 1maximum: 100

Valor predeterminado: 50

cursorCadena de texto nullOpcional

Valor de continuación opaco devuelto por la página anterior.

Cadena de texto:minLength: 1maxLength: 1024

market_idCadena de texto nullOpcional

Identificador del mercado devuelto por el endpoint de contexto.

Restricciones · Cadena de texto 1

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Esta operación no acepta un cuerpo JSON.

Respuestas

Respuesta 200

Modelo completo: ApiResponse_list_CampaignData__

dataLista <CampaignData > Obligatorio

Contenido de una respuesta correcta.

Campos · data

CampaignData

Modelo completo: CampaignData

audienceCadena de textoOpcional

Clientes

Restricciones

enum: ["all", "guest", "customer", "selected"]

Valor predeterminado: "all"

benefit_typeCadena de textoOpcional

Variante de la estructura de datos definida por los valores admitidos.

Restricciones

enum: ["percentage", "fixed", "none"]

Valor predeterminado: "percentage"

category_idsLista <Cadena de texto> Opcional

Identificadores de las categorías relacionadas.

maxItems: 1000

Restricciones · Lista 1

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

codeCadena de texto nullOpcional

Código estable legible por programas.

Restricciones · Cadena de texto 1

pattern: "^[A-Za-z0-9]{6,16}$"

combine_couponsBooleanoOpcional

Combinar con otros códigos

Valor predeterminado: false

combine_promotionsBooleanoOpcional

Permitir este código en productos con promociones automáticas

Valor predeterminado: false

created_atCadena de textoObligatorio

Momento de creación.

format: "date-time"

created_byCreatorData Obligatorio

Creado por

customer_idsLista <Cadena de texto> Opcional

Información del cliente registrada para este recurso.

maxItems: 1000

Restricciones · Lista 1

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

enabledBooleanoObligatorio

Indica si esta opción está habilitada.

ends_atCadena de texto nullOpcional

Activo hasta

Cadena de texto:format: "date-time"

free_shippingBooleanoOpcional

Envío gratuito

Valor predeterminado: false

idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve.

kindCadena de textoObligatorio

Variante de la estructura de datos definida por los valores admitidos.

Restricciones

enum: ["coupon", "promotion"]

marketsLista <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obligatorio

Mercados disponibles en el contexto de la tienda.

minItems: 1maxItems: 1000

minimum_quantityNúmero enteroOpcional

Número mínimo de artículos en el carrito

minimum: 1maximum: 2147483647

Valor predeterminado: 1

nameCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

minLength: 1maxLength: 160

per_customer_limitNúmero enteroOpcional

Límite de usos por cliente

minimum: -1maximum: 2147483647

Valor predeterminado: -1

percentageCadena de textoOpcional

Porcentaje

maxLength: 19

Restricciones

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Valor predeterminado: "10"

product_idsLista <Cadena de texto> Opcional

Identificadores de los productos relacionados.

maxItems: 1000

Restricciones · Lista 1

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

product_scopeCadena de textoOpcional

Productos

Restricciones

enum: ["all", "selected"]

Valor predeterminado: "all"

show_accountBooleanoOpcional

En la cuenta del cliente

Valor predeterminado: false

show_cartBooleanoOpcional

En el carrito

Valor predeterminado: false

show_productBooleanoOpcional

En las páginas de productos

Valor predeterminado: false

starts_atCadena de texto nullOpcional

Activo desde

Cadena de texto:format: "date-time"

updated_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"

usage_limitNúmero enteroOpcional

Límite de usos

minimum: -1maximum: 2147483647

Valor predeterminado: -1

used_countNúmero enteroObligatorio

Usos realizados

versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorio

Metadatos de la respuesta.

Campos · meta

ContextPageMeta

Modelo completo: ContextPageMeta

localeCadena de textoObligatorio: Idioma seleccionado para esta solicitud.
market_codeCadena de textoObligatorio: Código del mercado devuelto por el endpoint de contexto.
market_idCadena de textoObligatorio: Identificador del mercado devuelto por el endpoint de contexto.
paginationPagination Obligatorio: Metadatos de la paginación por cursor.
request_idCadena de textoObligatorio: Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.
minLength: 1maxLength: 100

ContextMeta

Modelo completo: ContextMeta

localeCadena de textoObligatorio: Idioma seleccionado para esta solicitud.
market_codeCadena de textoObligatorio: Código del mercado devuelto por el endpoint de contexto.
market_idCadena de textoObligatorio: Identificador del mercado devuelto por el endpoint de contexto.
request_idCadena de textoObligatorio: Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.
minLength: 1maxLength: 100

PageMeta

Modelo completo: PageMeta

paginationPagination Obligatorio: Metadatos de la paginación por cursor.
request_idCadena de textoObligatorio: Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.
minLength: 1maxLength: 100

RequestMeta

Modelo completo: RequestMeta

request_idCadena de textoObligatorio: Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.
minLength: 1maxLength: 100

Ejemplo de respuesta

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 puerta de enlace API
503: Servicio no disponible
504: Tiempo de espera agotado

Catálogo de errores: ErrorResponse

Cabeceras

401

WWW-AuthenticateCadena de textoOpcional: Esquema de autenticación exigido por el servidor.

405

AllowCadena de textoOpcional: Métodos HTTP admitidos por este recurso.

429, 503

Retry-AfterNúmero enteroOpcional: Espera mínima antes de reintentar, en segundos.

minimum: 0

Catálogo de errores · Más información

GET/api/v1/discounts/promotions

Ejemplos de código

Ejemplo de solicitud

cURL

PHP

Python

Ejemplo de respuesta 200

Vista general

Parámetros

Parámetros de consulta

Respuestas

Respuesta 200

Estado HTTP

GET`/api/v1/discounts/promotions`