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 IDiscountEntity.

Descontos.getDiscountByMarker(

marker*, langCode

);

Esquema de parâmetros

Esquema

marker(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": [],
  "position": 1
}

Esquema de resposta

Esquema: IDiscountsEntity

id: number
O identificador único do desconto.

attributeSetId: number
O identificador do desconto.

localizeInfos: object
O nome do desconto.

version: number
A versão do desconto.

identifier: string
O identificador do desconto.

type: string
O tipo de desconto.

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

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

discountValue: Record<string, unknown>
O valor do desconto.

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: object
As exclusões do desconto.

gifts: object
Os presentes do desconto.

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

userGroups: object
Os grupos de usuários do desconto.

userExclusions: object
As exclusões de usuários do desconto.

attributeValues: object
Os valores dos atributos do desconto.

attributeSetIdentifier: string
O identificador do conjunto de atributos.

---