getDiscountByMarker

Obtendo um único objeto de desconto pelo seu identificador textual (marcador).

Descrição

Este método recupera um único objeto de desconto pelo seu identificador textual (marcador). Ele retorna uma Promise que resolve para um objeto IDiscountsEntity.

Descontos.getDiscountByMarker(

marcador*, langCode

);

Esquema de parâmetros

Esquema

marcador(obrigatório): string
Identificador textual do objeto de armazenamento de desconto
exemplo: "discount_storage"

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

Exemplos

Exemplo mínimo

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

Exemplo com atributos

const response = await Discounts.getDiscountByMarker('summer_sale', '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
O identificador único do desconto.

attributeSetId: number
O identificador do desconto.

localizeInfos: ILocalizeInfo
O nome do desconto.

version: number
A versão do desconto.

identifier: string
O identificador do desconto.

type: IDiscountType
O tipo do desconto.

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

endDate: string
A data de término do desconto.

discountValue: IDiscountValue
O valor do desconto, incluindo seu tipo e limites de quantia.

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

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

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

discountValue.maxAmount: number
Limite opcional sobre o desconto absoluto aplicado.
exemplo: 5

conditionLogic: string
A lógica do desconto. Os valores possíveis são "AND" | "OR".

conditions: IDiscountCondition[]
As condições do desconto.

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

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

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

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

giftsReplaceCartItems: boolean
Se os presentes substituem os itens do carrinho.

userGroups: Record<string, unknown> | null
Os grupos de usuários do desconto.

userExclusions: Record<string, unknown> | null
As exclusões de usuários do desconto.

attributeValues: IAttributeValues
Os valores dos atributos do desconto.

attributeSetIdentifier: string
O identificador do conjunto de atributos.

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

position: number
Número da posição para ordenação.
exemplo: 1

total: number | string
Contagem total de entradas relacionadas.
exemplo: "1"

---