Buscar todos anúncios

GET https://.account-name.krzlabs.io/api/v1/advertisements

Realiza a busca de todos os anuncios.

---

Request

paginação / link de referência

Entenda como aplicar paginação e ordenação na sua listagem

filtros / link de referência

Entenda como aplicar filtros na sua listagem

expansão / link de referência

Entenda como expandir entidades relacionadas nos documentos da listagem

---

Responses

Resposta de sucesso

200

Successfully retrieved API registry entry.

Field	Type	Description	optional	Searchable
product_id	ObjectId	Todos os produtos na base do PIM contêm um identificador global, o seu ID.	required	false
channel_id	ObjectId	Todos os canais na base do PIM contêm um identificador global, o seu ID.	required	false
last_publishment_id	ObjectId	Identificador global da última publicação.	not required	false
status	enum	Status do anúncio	required	false
mapped_attributes	Object	Objeto que contém todos os atributos que estão mapeados para o canal.	not required	false

Exemplo de resposta em JSON

{
   "page": 1,
    "skip": 0,
    "limit": 10,
    "sort": {
        "campo": "asc"
    },
    "pages": 5,
    "total": 50,
    "next": true,
    "previous": "2",
    "nextUrl": "https://api.exemplo.com?page=2",
    "previousUrl": false,
    "filters": {
        "status": "ativo"
    },
    "data": [{
          "product_id": "64f1b3d4e5d987654321cdef",
          "channel_id": "64f1c4e6e5d567890abcd123",
          "last_publishment_id": "64f1d5f8e5d135790abcdef1",
          "status": "ready",
          "mapped_attributes": {
            "color": "blue",
            "size": "M",
            "warranty": 12
          }
    }]
}

Resposta de erro

400

Bad Request

Field	Type	Description
code	Number	Código da resposta http
kind	String	Tipo de mensagem
name	String	Nome da exceção lançada pela plataforma
title	String	Titulo do erro lançado pela plataforma
message	String	Mensagem indicando o probloma ocorrido
solution	String	Mensagem indicando uma possível solução para o problema