getAllDiscounts

Obtendo todos os objetos de desconto.

Descrição

Este método recupera objetos de desconto com paginação e um filtro de tipo opcional. Ele retorna uma Promise que resolve para um objeto IDiscountsResponse contendo itens e contagem total.

Descontos.getAllDiscounts(

langCode, offset, limit, type

);

Esquema de parâmetros

Esquema

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

offset: number
Parâmetro opcional para paginação. Padrão: 0
exemplo: 0

limit: number
Parâmetro opcional para paginação. Padrão: 30
exemplo: 30

type: IDiscountType
Parâmetro opcional para filtrar descontos por tipo

Por padrão, você pode recuperar 10 objetos. Isso se deve ao limite de registro nas configurações de permissões do módulo.
Para que a paginação funcione corretamente, você precisa configurar as Permissões do módulo de acordo com suas necessidades na seção correspondente.

Exemplos

Exemplo mínimo

const response = await Discounts.getAllDiscounts();

Exemplo com atributos

const response = await Discounts.getAllDiscounts('en_US', 0, 30);

Exemplo de resposta

{
  "items": [
    {
      "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,
      "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
    },
    {
      "id": 2,
      "type": "PERSONAL_DISCOUNT",
      "attributeSetId": null,
      "conditionLogic": "AND",
      "discountValue": {
        "value": 15,
        "maxAmount": null,
        "discountType": "FIXED_AMOUNT",
        "applicability": "TO_ORDER"
      },
      "exclusions": null,
      "gifts": null,
      "giftsReplaceCartItems": false,
      "userGroups": null,
      "userExclusions": null,
      "localizeInfos": {
        "title": "Personal discount"
      },
      "version": 2,
      "identifier": "personal_discount",
      "startDate": "2026-04-21T18:26:19.815Z",
      "endDate": "2028-03-21T19:26:24.741Z",
      "attributeValues": {},
      "conditions": [],
      "bonusEvent": null,
      "position": 2
    }
  ],
  "total": 2
}

Esquema de resposta

Esquema: IDiscountEntity[]

items: IDiscountsEntity[]
Array de entidades de desconto.

items.id: number
O identificador único do desconto.

items.attributeSetId: number
O identificador do desconto.

items.localizeInfos: ILocalizeInfo
O nome do desconto.

items.version: number
A versão do desconto.

items.identifier: string
O identificador do desconto.

items.type: IDiscountType
O tipo do desconto.

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

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

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

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

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

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

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

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

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

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

items.attributeValues: IAttributeValues
Os valores dos atributos do desconto.

items.attributeSetIdentifier: string
O identificador do conjunto de atributos.

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

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

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

total: number
Número total de descontos.

---