Obter todas as publicações

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

Realiza a busca de publicações


Request

paginação / link de referência
Entenda como aplicar paginação e ordenação na sua listagem
Entenda como aplicar filtros na sua listagem
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 ID do produto relacionado — relacionado a ProductModule (ref: code). required false
advertisement_id ObjectId ID do anúncio relacionado — relacionado a AdvertisementsModule (ref: _id). required false
publishment_url string URL da publicação do produto. not required false
status enum(PublishmentStatusEnum) Status atual da publicação.
Possíveis valores:
FAILED = 'failed',
PUBLISHED = 'published',
PUBLISHING = 'publishing',
READY_TO_PUBLISH = 'ready_to_publish'
required false
tracking
array(Object) Lista de eventos de rastreamento da publicação. required false
product_snapshot object Snapshot do produto no momento da publicação. required false
published_payload object Payload publicado na plataforma externa. not required false
created_by_name string Nome do usuário que criou a publicação. not required false

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

Copyright © 2025 kruzer | All Rights Reserved