Obter uma publicação

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

Realiza a busca de publicações

---

Path Params

id string required

ID da publicação.

---

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

Exemplo de resposta em JSON

{
  "product_id": "64f1b3d4e5d987654321cdef",
  "advertisement_id": "64f1c4e6e5d567890abcd111",
  "publishment_url": "https://example.com/product/64f1b3d4e5d987654321cdef",
  "status": "PUBLISHED",
  "tracking": [
    {
      "status": "PENDING",
      "message": "Publishment request created.",
      "created_at": "2025-08-25T09:00:00Z",
      "data": ["initial payload", "waiting for approval"]
    },
    {
      "status": "IN_PROGRESS",
      "message": "Publishment is being processed.",
      "created_at": "2025-08-25T09:15:00Z",
      "data": []
    },
    {
      "status": "PUBLISHED",
      "message": "Publishment successfully completed.",
      "created_at": "2025-08-25T09:30:00Z",
      "data": ["external_id: 123456", "channel: Marketplace"]
    }
  ],
  "product_snapshot": {
    "code": "PRD-001",
    "name": {
      "pt": "Tênis Esportivo",
      "en": "Running Shoes"
    },
    "price": 199.90,
    "enabled": true
  },
  "published_payload": {
    "channel": "Marketplace",
    "payload": {
      "sku": "SKU123",
      "price": 199.90,
      "currency": "BRL"
    }
  },
  "created_by_name": "Mateus Martins"
}

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