Esquemas de datos · Descuentos

dataCampaignData Obligatorio

Contenido de una respuesta correcta.

Ejemplo: {"created_at":"2026-10-07T10:00:00Z","created_by":{"kind":"admin","label":"Editorial integration","reference":"learn-api-key"},"enabled":false,"id":"example-campaign","kind":"coupon","markets":[{"currency":"PLN","market_id":"poland","minor_units":0}],"name":"Autumn guide offer","updated_at":"2026-10-07T10:00:00Z","used_count":0,"version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatorio

Metadatos de la respuesta.

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

Campos adicionales: No

dataLista <CampaignData > Obligatorio

Contenido de una respuesta correcta.

Ejemplo: []

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatorio

Metadatos de la respuesta.

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

Campos adicionales: No

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}$"

Ejemplo: "LEARN10"

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

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}$"

ends_atCadena de texto | nullOpcional

Activo hasta

Cadena de texto:format: "date-time"

free_shippingBooleanoOpcional

Envío gratuito

Valor predeterminado: false

marketsLista <MarketData-Input > Obligatorio

Mercados disponibles en el contexto de la tienda.

minItems: 1maxItems: 1000

Ejemplo: [{"currency":"PLN","market_id":"poland","minor_units":2}]

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

Ejemplo: "Autumn guide offer"

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"

usage_limitNúmero enteroOpcional

Límite de usos

minimum: -1maximum: 2147483647

Valor predeterminado: -1

Campos adicionales: No

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"

Ejemplo: "2026-10-07T10:00:00Z"

created_byCreatorData Obligatorio

Creado por

Ejemplo: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}

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.

Ejemplo: false

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.

Ejemplo: "example-campaign"

kindCadena de textoObligatorio

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

Restricciones

enum

["coupon", "promotion"]

Ejemplo: "coupon"

marketsLista <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obligatorio

Mercados disponibles en el contexto de la tienda.

minItems: 1maxItems: 1000

Ejemplo: [{"currency":"PLN","market_id":"poland","minor_units":0}]

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

Ejemplo: "Autumn guide offer"

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"

Ejemplo: "2026-10-07T10:00:00Z"

usage_limitNúmero enteroOpcional

Límite de usos

minimum: -1maximum: 2147483647

Valor predeterminado: -1

used_countNúmero enteroObligatorio

Usos realizados

Ejemplo: 0

versionNúmero enteroObligatorio

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

Ejemplo: 1

Campos adicionales: No

enabledBooleanoObligatorio

Indica si esta opción está habilitada.

Ejemplo: false

expected_versionNúmero enteroObligatorio

Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 1maximum: 9223372036854775807

Ejemplo: 1

Campos adicionales: No

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}$"

Ejemplo: "LEARN10"

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

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}$"

ends_atCadena de texto | nullOpcional

Activo hasta

Cadena de texto:format: "date-time"

expected_versionNúmero enteroObligatorio

Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 1maximum: 9223372036854775807

Ejemplo: 1

free_shippingBooleanoOpcional

Envío gratuito

Valor predeterminado: false

marketsLista <MarketData-Input > Obligatorio

Mercados disponibles en el contexto de la tienda.

minItems: 1maxItems: 1000

Ejemplo: [{"currency":"PLN","market_id":"poland","minor_units":2}]

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

Ejemplo: "Autumn guide offer"

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"

usage_limitNúmero enteroOpcional

Límite de usos

minimum: -1maximum: 2147483647

Valor predeterminado: -1

Campos adicionales: No

kindCadena de textoObligatorio

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

Restricciones

enum

["admin", "api"]

Ejemplo: "admin"

labelCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

Ejemplo: "Editorial integration"

referenceCadena de textoObligatorio

Identificador de la entidad referenciada.

Ejemplo: "learn-api-key"

Campos adicionales: No

currencyCadena de textoObligatorio

Código de la moneda del importe.

Restricciones

pattern

"^[A-Z]{3}$"

Ejemplo: "PLN"

fixed_amountCadena de textoOpcional

Monto del descuento

maxLength: 19

Restricciones

pattern

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

Valor predeterminado: "0"

market_idCadena de textoObligatorio

Identificador del mercado devuelto por el endpoint de contexto.

Restricciones

pattern

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

Ejemplo: "poland"

maximum_priceCadena de texto | nullOpcional

Precio máximo del producto

Cadena de texto:maxLength: 19

Restricciones · Cadena de texto 1

pattern

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

minimum_priceCadena de texto | nullOpcional

Precio mínimo del producto

Cadena de texto:maxLength: 19

Restricciones · Cadena de texto 1

pattern

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

minimum_subtotalCadena de textoOpcional

Valor mínimo del carrito

maxLength: 19

Restricciones

pattern

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

Valor predeterminado: "0"

minor_unitsNúmero enteroObligatorio

Número de decimales utilizados por la moneda.

minimum: 0maximum: 4

Ejemplo: 2

Campos adicionales: No

currencyCadena de textoObligatorio

Código de la moneda del importe.

Restricciones

pattern

"^[A-Z]{3}$"

Ejemplo: "PLN"

fixed_amountCadena de textoOpcional

Monto del descuento

maxLength: 19

Restricciones

pattern

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

Valor predeterminado: "0"

market_idCadena de textoObligatorio

Identificador del mercado devuelto por el endpoint de contexto.

Restricciones

pattern

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

Ejemplo: "poland"

maximum_priceCadena de texto | nullOpcional

Precio máximo del producto

Cadena de texto:maxLength: 19

Restricciones · Cadena de texto 1

pattern

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

minimum_priceCadena de texto | nullOpcional

Precio mínimo del producto

Cadena de texto:maxLength: 19

Restricciones · Cadena de texto 1

pattern

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

minimum_subtotalCadena de textoOpcional

Valor mínimo del carrito

maxLength: 19

Restricciones

pattern

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

Valor predeterminado: "0"

minor_unitsNúmero enteroObligatorio

Número de decimales utilizados por la moneda.

minimum: 0maximum: 4

Ejemplo: 0

Campos adicionales: No