getDiscountByMarker

Obter um único desconto pelo marcador.

Descrição

Busca um desconto pelo marcador e resolve para um IDiscountsEntity.

.getDiscountByMarker(

,

);

Esquema de parâmetros

Esquema

marker(required): string
Marcador do desconto.
exemplo: "discount_storage"

langCode: string
Código do idioma. Padrão: o langCode passado para defineOneEntry ("en_US" se nenhum for passado).
exemplo: "en_US"

Exemplos

Exemplo mínimo

const response = await Discounts.getDiscountByMarker('example_discount');

Exemplo com parâmetros opcionais

const response = await Discounts.getDiscountByMarker('example_discount', 'en_US');

Exemplo de resposta

{
  "id": 1,
  "type": "DISCOUNT",
  "attributeSetId": 31,
  "conditionLogic": "AND",
  "discountValue": {
    "value": 10,
    "maxAmount": 5,
    "discountType": "FIXED_AMOUNT",
    "applicability": "TO_PRODUCT"
  },
  "exclusions": null,
  "gifts": null,
  "giftsReplaceCartItems": false,
  "userGroups": null,
  "userExclusions": null,
  "localizeInfos": {
    "title": "Example discount"
  },
  "version": 0,
  "total": "1",
  "identifier": "example_discount",
  "startDate": "2026-03-14T14:55:19.928Z",
  "endDate": "2026-07-31T13:55:24.647Z",
  "attributeValues": {
    "example_discount": {
      "type": "string",
      "value": "test value",
      "isIcon": false,
      "position": 0,
      "additionalFields": {},
      "isProductPreview": false
    }
  },
  "conditions": [],
  "bonusEvent": null,
  "position": 1
}

Esquema de resposta

Esquema: IDiscountsEntity

id: number
ID do desconto.

attributeSetId: number | null
ID do conjunto de atributos vinculado ao desconto, ou null quando nenhum conjunto está vinculado.

localizeInfos: ILocalizeInfo
Nome localizado do desconto.

version: number
Número da versão do desconto.

identifier: string
Marcador do desconto.

type: IDiscountType
O tipo do desconto.

startDate: string
A data de início do desconto.

endDate: string
Data de término do desconto.

discountValue: IDiscountValue
Valor do desconto com seu tipo e limites de valor.

discountValue.applicability: 'TO_PRODUCT' | 'TO_ORDER'
A que o desconto se aplica.
exemplo: "TO_PRODUCT"

discountValue.discountType: 'FIXED_AMOUNT' | 'PERCENT'
Como o valor do desconto é aplicado.
exemplo: "FIXED_AMOUNT"

discountValue.value: number
Valor do desconto (unidades monetárias para FIXED_AMOUNT, pontos percentuais para PERCENT).
exemplo: 10

discountValue.maxAmount: number | null
Limite do desconto absoluto aplicado, ou null quando não há limite.
exemplo: 5

conditionLogic: string
Como as condições se combinam: AND ou OR.

conditions: IDiscountCondition[]
Condições do desconto.

conditions.type: string
O tipo da condição do desconto.

conditions.value: string
O valor associado à condição do desconto.

exclusions: Record<string, unknown> | null
Exclusões do desconto.

gifts: Record<string, unknown> | null
Brindes do desconto.

giftsReplaceCartItems: boolean
Se os brindes substituem itens do carrinho.

userGroups: Record<string, unknown> | null
Grupos de usuários aos quais o desconto se aplica.

userExclusions: Record<string, unknown> | null
Usuários excluídos do desconto.

attributeValues: IAttributeValues
Valores de atributos do desconto.

attributeSetIdentifier: string
Marcador do conjunto de atributos.

bonusEvent: Record<string, unknown>
Configuração do evento de bônus.

position: number
Posição usada para ordenação.
exemplo: 1

total: number | string
Contagem interna de linhas que a API retorna por engano ("1" em um único desconto). Não dependa dela.
exemplo: "1"

distance: number
Distância do cosseno até a consulta. Retornada em todos os itens pelo endpoint de busca semântica (vetorial).
exemplo: 0.12

---