API atual/Referência completa/Canais de venda

Anúncios

Lista os anúncios de um canal, enfileira a publicação de produtos e pausa um anúncio.

Listar anúncios

Devolve as listings do seller no canal, da atualizada há menos tempo para a mais antiga. Sem conexão ou sem anúncios a lista vem vazia, sem erro.

GET/api/v1/vendor/channels/{channel}/listingsSeller

Listar anúncios

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

channelstringobrigatório

mercadolivreamazonshopee

Canal de venda.

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/channels/mercadolivre/listings" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Anúncios

json

{
  "items": [
    {
      "id": "e1d2c3b4-a5f6-4789-8abc-def012345678",
      "connection_id": "b4f1c2a0-7d11-4e32-9a5b-0c1d2e3f4a5b",
      "product_id": "b02afb3d-4218-40ef-a72f-47beede28d46",
      "product_name": "Cafeteira Elétrica Lumina 900W",
      "status": "pending"
    }
  ]
}

Campos da resposta

itemsobject[]

As listings.

iduuid

Id da listing (UUID).

connection_iduuid

Conexão (UUID).

product_iduuid

Produto (UUID).

product_namestring

Nome do produto.

external_idstring

Id do anúncio no marketplace. Ausente enquanto não confirmado.

external_category_idstring

Categoria do marketplace usada na publicação.

statusstring

pendingpublishederrorpausedclosed

Estado do anúncio.

last_errorstring

Último erro de sincronização. Ausente quando não há.

last_synced_atstring

Última sincronização, RFC 3339 em UTC. Ausente se nunca sincronizou.

Erros

Status	Quando	Corpo de exemplo
410	A loja usa o Hub de Marketplaces próprio e este recurso foi movido para lá.	`{"error":"crs_markethub_only","moved_to":"markethub"}`
500	Falha ao listar.	`{"error":"failed to list listings"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Publicar produtos

Cria (ou reinicia) uma listing pending para cada produto informado e enfileira a publicação. Se o produto já tem listing neste canal, ela volta para pending e a categoria é atualizada.

POST/api/v1/vendor/channels/{channel}/listingsSeller

Publicar produtos

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Content-Typestringobrigatório

application/json.

Parâmetros de caminho

channelstringobrigatório

mercadolivreamazonshopee

Canal de venda.

Corpo da requisição

product_idsuuid[]obrigatório

Produtos a publicar. Só os produtos do seller (e não apagados) são considerados.

external_category_idstring

Id da categoria no marketplace. Se omitido, mantém a categoria já usada.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/channels/mercadolivre/listings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"product_ids": ["b02afb3d-4218-40ef-a72f-47beede28d46"], "external_category_id": "MLB1055"}'

Resposta

200Publicação enfileirada

json

{
  "queued": 1
}

Campos da resposta

queuedinteger

Quantos produtos foram enfileirados. Ids que não são do seller, ou de produtos apagados, não contam e não geram erro.

Erros

Status	Quando	Corpo de exemplo
400	Corpo que não é JSON, ou o seller não tem conexão com o canal.	`{"error":"failed to publish","detail":"channel not connected"}`
410	A loja usa o Hub de Marketplaces próprio e este recurso foi movido para lá.	`{"error":"crs_markethub_only","moved_to":"markethub"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Pausar anúncio

Marca a listing como paused na hora e enfileira a pausa no marketplace.

POST/api/v1/vendor/channels/listings/{id}/pauseSeller

Pausar anúncio

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id da listing (UUID).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/channels/listings/e1d2c3b4-a5f6-4789-8abc-def012345678/pause" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Pausado

json

{
  "paused": true
}

Erros

Status	Quando	Corpo de exemplo
400	Listing inexistente ou de outro seller.	`{"error":"failed to pause listing","detail":"listing not found"}`
410	A loja usa o Hub de Marketplaces próprio e este recurso foi movido para lá.	`{"error":"crs_markethub_only","moved_to":"markethub"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Veja também

API atual/Referência completa/Canais de venda

Anúncios

Lista os anúncios de um canal, enfileira a publicação de produtos e pausa um anúncio.

Listar anúncios

Devolve as listings do seller no canal, da atualizada há menos tempo para a mais antiga. Sem conexão ou sem anúncios a lista vem vazia, sem erro.

GET/api/v1/vendor/channels/{channel}/listingsSeller

Listar anúncios

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

channelstringobrigatório

mercadolivreamazonshopee

Canal de venda.

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/channels/mercadolivre/listings" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Anúncios

json

{
  "items": [
    {
      "id": "e1d2c3b4-a5f6-4789-8abc-def012345678",
      "connection_id": "b4f1c2a0-7d11-4e32-9a5b-0c1d2e3f4a5b",
      "product_id": "b02afb3d-4218-40ef-a72f-47beede28d46",
      "product_name": "Cafeteira Elétrica Lumina 900W",
      "status": "pending"
    }
  ]
}

Campos da resposta

itemsobject[]

As listings.

iduuid

Id da listing (UUID).

connection_iduuid

Conexão (UUID).

product_iduuid

Produto (UUID).

product_namestring

Nome do produto.

external_idstring

Id do anúncio no marketplace. Ausente enquanto não confirmado.

external_category_idstring

Categoria do marketplace usada na publicação.

statusstring

pendingpublishederrorpausedclosed

Estado do anúncio.

last_errorstring

Último erro de sincronização. Ausente quando não há.

last_synced_atstring

Última sincronização, RFC 3339 em UTC. Ausente se nunca sincronizou.

Erros

Status	Quando	Corpo de exemplo
410	A loja usa o Hub de Marketplaces próprio e este recurso foi movido para lá.	`{"error":"crs_markethub_only","moved_to":"markethub"}`
500	Falha ao listar.	`{"error":"failed to list listings"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Publicar produtos

Cria (ou reinicia) uma listing pending para cada produto informado e enfileira a publicação. Se o produto já tem listing neste canal, ela volta para pending e a categoria é atualizada.

POST/api/v1/vendor/channels/{channel}/listingsSeller

Publicar produtos

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Content-Typestringobrigatório

application/json.

Parâmetros de caminho

channelstringobrigatório

mercadolivreamazonshopee

Canal de venda.

Corpo da requisição

product_idsuuid[]obrigatório

Produtos a publicar. Só os produtos do seller (e não apagados) são considerados.

external_category_idstring

Id da categoria no marketplace. Se omitido, mantém a categoria já usada.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/channels/mercadolivre/listings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"product_ids": ["b02afb3d-4218-40ef-a72f-47beede28d46"], "external_category_id": "MLB1055"}'

Resposta

200Publicação enfileirada

json

{
  "queued": 1
}

Campos da resposta

queuedinteger

Quantos produtos foram enfileirados. Ids que não são do seller, ou de produtos apagados, não contam e não geram erro.

Erros

Status	Quando	Corpo de exemplo
400	Corpo que não é JSON, ou o seller não tem conexão com o canal.	`{"error":"failed to publish","detail":"channel not connected"}`
410	A loja usa o Hub de Marketplaces próprio e este recurso foi movido para lá.	`{"error":"crs_markethub_only","moved_to":"markethub"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Pausar anúncio

Marca a listing como paused na hora e enfileira a pausa no marketplace.

POST/api/v1/vendor/channels/listings/{id}/pauseSeller

Pausar anúncio

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id da listing (UUID).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/channels/listings/e1d2c3b4-a5f6-4789-8abc-def012345678/pause" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Pausado

json

{
  "paused": true
}

Erros

Status	Quando	Corpo de exemplo
400	Listing inexistente ou de outro seller.	`{"error":"failed to pause listing","detail":"listing not found"}`
410	A loja usa o Hub de Marketplaces próprio e este recurso foi movido para lá.	`{"error":"crs_markethub_only","moved_to":"markethub"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`