Esquemas de dados · Descontos

Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

Esquemas de dados

ApiResponse[CampaignData]

ApiResponse_CampaignData_ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataCampaignData Obrigatório: Conteúdo de uma resposta bem-sucedida.

Exemplo: {"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 Obrigatório: Metadados da resposta.

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

Campos adicionais: Não

ApiResponse[list[CampaignData]]

ApiResponse_list_CampaignData__ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataLista <CampaignData > Obrigatório: Conteúdo de uma resposta bem-sucedida.

Exemplo: []
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

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

Campos adicionais: Não

CampaignCreate

CampaignCreate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

audienceTextoOpcional

Clientes

Restrições

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

Predefinido: "all"

benefit_typeTextoOpcional

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

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

Predefinido: "percentage"

category_idsLista <Texto> Opcional

Identificadores das categorias relacionadas.

maxItems: 1000

Restrições · Lista 1

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

codeTexto nullOpcional

Código estável legível por programas.

Restrições · Texto 1

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

Exemplo: "LEARN10"

combine_couponsBooleanoOpcional

Combinar com outros códigos

Predefinido: false

combine_promotionsBooleanoOpcional

Permitir este código em produtos com promoções automáticas

Predefinido: false

customer_idsLista <Texto> Opcional

Informações do cliente registadas para este recurso.

maxItems: 1000

Restrições · Lista 1

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

ends_atTexto nullOpcional

Ativo até

Texto:format: "date-time"

free_shippingBooleanoOpcional

Portes grátis

Predefinido: false

marketsLista <MarketData-Input > Obrigatório

Mercados disponíveis no contexto da loja.

minItems: 1maxItems: 1000

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

minimum_quantityNúmero inteiroOpcional

Número mínimo de artigos no carrinho

minimum: 1maximum: 2147483647

Predefinido: 1

nameTextoObrigatório

Nome do recurso no contexto correspondente.

minLength: 1maxLength: 160

Exemplo: "Autumn guide offer"

per_customer_limitNúmero inteiroOpcional

Limite de utilizações por cliente

minimum: -1maximum: 2147483647

Predefinido: -1

percentageTextoOpcional

Percentagem

maxLength: 19

Restrições

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

Predefinido: "10"

product_idsLista <Texto> Opcional

Identificadores dos produtos relacionados.

maxItems: 1000

Restrições · Lista 1

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

product_scopeTextoOpcional

Produtos

Restrições

enum: ["all", "selected"]

Predefinido: "all"

show_accountBooleanoOpcional

Na conta do cliente

Predefinido: false

show_cartBooleanoOpcional

No carrinho

Predefinido: false

show_productBooleanoOpcional

Nas páginas dos produtos

Predefinido: false

starts_atTexto nullOpcional

Ativo a partir de

Texto:format: "date-time"

usage_limitNúmero inteiroOpcional

Limite de utilizações

minimum: -1maximum: 2147483647

Predefinido: -1

Campos adicionais: Não

CampaignData

CampaignData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

audienceTextoOpcional

Clientes

Restrições

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

Predefinido: "all"

benefit_typeTextoOpcional

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

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

Predefinido: "percentage"

category_idsLista <Texto> Opcional

Identificadores das categorias relacionadas.

maxItems: 1000

Restrições · Lista 1

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

codeTexto nullOpcional

Código estável legível por programas.

Restrições · Texto 1

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

combine_couponsBooleanoOpcional

Combinar com outros códigos

Predefinido: false

combine_promotionsBooleanoOpcional

Permitir este código em produtos com promoções automáticas

Predefinido: false

created_atTextoObrigatório

Momento da criação.

format: "date-time"

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

created_byCreatorData Obrigatório

Criado por

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

customer_idsLista <Texto> Opcional

Informações do cliente registadas para este recurso.

maxItems: 1000

Restrições · Lista 1

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

enabledBooleanoObrigatório

Indica se esta configuração está ativada.

Exemplo: false

ends_atTexto nullOpcional

Ativo até

Texto:format: "date-time"

free_shippingBooleanoOpcional

Portes grátis

Predefinido: false

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

Exemplo: "example-campaign"

kindTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

enum: ["coupon", "promotion"]

Exemplo: "coupon"

marketsLista <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obrigatório

Mercados disponíveis no contexto da loja.

minItems: 1maxItems: 1000

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

minimum_quantityNúmero inteiroOpcional

Número mínimo de artigos no carrinho

minimum: 1maximum: 2147483647

Predefinido: 1

nameTextoObrigatório

Nome do recurso no contexto correspondente.

minLength: 1maxLength: 160

Exemplo: "Autumn guide offer"

per_customer_limitNúmero inteiroOpcional

Limite de utilizações por cliente

minimum: -1maximum: 2147483647

Predefinido: -1

percentageTextoOpcional

Percentagem

maxLength: 19

Restrições

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

Predefinido: "10"

product_idsLista <Texto> Opcional

Identificadores dos produtos relacionados.

maxItems: 1000

Restrições · Lista 1

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

product_scopeTextoOpcional

Produtos

Restrições

enum: ["all", "selected"]

Predefinido: "all"

show_accountBooleanoOpcional

Na conta do cliente

Predefinido: false

show_cartBooleanoOpcional

No carrinho

Predefinido: false

show_productBooleanoOpcional

Nas páginas dos produtos

Predefinido: false

starts_atTexto nullOpcional

Ativo a partir de

Texto:format: "date-time"

updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"

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

usage_limitNúmero inteiroOpcional

Limite de utilizações

minimum: -1maximum: 2147483647

Predefinido: -1

used_countNúmero inteiroObrigatório

Utilizações efetuadas

Exemplo: 0

versionNúmero inteiroObrigatório

Versão do recurso utilizada para controlo de concorrência.

Exemplo: 1

Campos adicionais: Não

CampaignStatus

CampaignStatus · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

enabledBooleanoObrigatório: Indica se esta configuração está ativada.

Exemplo: false
expected_versionNúmero inteiroObrigatório: Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 9223372036854775807

Exemplo: 1

Campos adicionais: Não

CampaignUpdate

CampaignUpdate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

audienceTextoOpcional

Clientes

Restrições

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

Predefinido: "all"

benefit_typeTextoOpcional

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

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

Predefinido: "percentage"

category_idsLista <Texto> Opcional

Identificadores das categorias relacionadas.

maxItems: 1000

Restrições · Lista 1

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

codeTexto nullOpcional

Código estável legível por programas.

Restrições · Texto 1

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

Exemplo: "LEARN10"

combine_couponsBooleanoOpcional

Combinar com outros códigos

Predefinido: false

combine_promotionsBooleanoOpcional

Permitir este código em produtos com promoções automáticas

Predefinido: false

customer_idsLista <Texto> Opcional

Informações do cliente registadas para este recurso.

maxItems: 1000

Restrições · Lista 1

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

ends_atTexto nullOpcional

Ativo até

Texto:format: "date-time"

expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 9223372036854775807

Exemplo: 1

free_shippingBooleanoOpcional

Portes grátis

Predefinido: false

marketsLista <MarketData-Input > Obrigatório

Mercados disponíveis no contexto da loja.

minItems: 1maxItems: 1000

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

minimum_quantityNúmero inteiroOpcional

Número mínimo de artigos no carrinho

minimum: 1maximum: 2147483647

Predefinido: 1

nameTextoObrigatório

Nome do recurso no contexto correspondente.

minLength: 1maxLength: 160

Exemplo: "Autumn guide offer"

per_customer_limitNúmero inteiroOpcional

Limite de utilizações por cliente

minimum: -1maximum: 2147483647

Predefinido: -1

percentageTextoOpcional

Percentagem

maxLength: 19

Restrições

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

Predefinido: "10"

product_idsLista <Texto> Opcional

Identificadores dos produtos relacionados.

maxItems: 1000

Restrições · Lista 1

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

product_scopeTextoOpcional

Produtos

Restrições

enum: ["all", "selected"]

Predefinido: "all"

show_accountBooleanoOpcional

Na conta do cliente

Predefinido: false

show_cartBooleanoOpcional

No carrinho

Predefinido: false

show_productBooleanoOpcional

Nas páginas dos produtos

Predefinido: false

starts_atTexto nullOpcional

Ativo a partir de

Texto:format: "date-time"

usage_limitNúmero inteiroOpcional

Limite de utilizações

minimum: -1maximum: 2147483647

Predefinido: -1

Campos adicionais: Não

CreatorData

CreatorData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

kindTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

enum: ["admin", "api"]

Exemplo: "admin"

labelTextoObrigatório

Nome do recurso no contexto correspondente.

Exemplo: "Editorial integration"

referenceTextoObrigatório

Identificador da entidade referenciada.

Exemplo: "learn-api-key"

Campos adicionais: Não

MarketData

MarketData-Input · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

currencyTextoObrigatório

Código da moeda do valor.

Restrições

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

Exemplo: "PLN"

fixed_amountTextoOpcional

Montante do desconto

maxLength: 19

Restrições

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

Predefinido: "0"

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

Restrições

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

Exemplo: "poland"

maximum_priceTexto nullOpcional

Preço máximo do produto

Texto:maxLength: 19

Restrições · Texto 1

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

minimum_priceTexto nullOpcional

Preço mínimo do produto

Texto:maxLength: 19

Restrições · Texto 1

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

minimum_subtotalTextoOpcional

Valor mínimo do carrinho

maxLength: 19

Restrições

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

Predefinido: "0"

minor_unitsNúmero inteiroObrigatório

Número de casas decimais utilizadas pela moeda.

minimum: 0maximum: 4

Exemplo: 2

Campos adicionais: Não

MarketData

shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

currencyTextoObrigatório

Código da moeda do valor.

Restrições

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

Exemplo: "PLN"

fixed_amountTextoOpcional

Montante do desconto

maxLength: 19

Restrições

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

Predefinido: "0"

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

Restrições

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

Exemplo: "poland"

maximum_priceTexto nullOpcional

Preço máximo do produto

Texto:maxLength: 19

Restrições · Texto 1

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

minimum_priceTexto nullOpcional

Preço mínimo do produto

Texto:maxLength: 19

Restrições · Texto 1

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

minimum_subtotalTextoOpcional

Valor mínimo do carrinho

maxLength: 19

Restrições

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

Predefinido: "0"

minor_unitsNúmero inteiroObrigatório

Número de casas decimais utilizadas pela moeda.

minimum: 0maximum: 4

Exemplo: 0

Campos adicionais: Não