YAyampi
Marketing - Brindes

Listar todos os Brindes de uma loja

Changed on

Retorna a lista de Brindes cadastrado

get/{alias}/pricing/freebies

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/pricing/freebies
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

Query parameters

includestring[]

Incluir relacionamentos adicionais

[
  "?include=resource"
]
expiredinteger

Indica se a regra está expirada (ativa=1 ou inativa=0).

activeinteger

Status da regra (ativa=1 ou inativa=0).

rulesstring[]

Tipo de regra aplicada.

Filtros de regras promocionais

Response

Lista de Brindes retornada com sucesso

Example response

{
  "data": [
    {
      "id": 3976,
      "active": true,
      "store_id": 176851,
      "name": "Teste docs",
      "start_at": "2025-09-16",
      "expires_at": "2025-09-16",
      "resource_id": 9791068,
      "resource_type": "product",
      "rule": "always",
      "created_at": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "updated_at": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      }
    }
  ]
}

Changes

  • bbafb577e11cRevision changes
    • info

      added the enum value promocode to the property rules/items/ of the query request parameter filters