Consulta do status de Anúncios Publicados

Esta API permite consultar o status atual de um anúncio publicado na OLX. Qual a vantagem?

Requisição de Status

O cliente deve enviar uma requisição GET, informando o list_id no caminho da URL e deve conter o token de cada anunciante no header como: Authorization: Bearer <token>.

Exemplo de chamada para a URL https://apps.olx.com.br/autoupload/ads/{list_id}:

Header

O access_token é necessário para autenticação e pode ser obtido conforme descrito na documentação de Autenticação na API OLX.

Parâmetro	Tipo	Obrigatório	Descrição
access_token	string	Sim	Chave de acesso do anunciante.

Parâmetros de URL

Parâmetro	Tipo	Obrigatório	Descrição
list_id1	integer	Sim	ID do anúncio na OLX.

¹ O list_id só é retornado quando o anúncio ja subiu pelo menos 1 vez na Plataforma da OLX. E pode ser recuperado das seguintes formas:

• Pela Listagem de Publicação que retorna todos os list_id ja inseridos na conta do cliente.
• Ao fazer uma importação pela API, ao Consulta de status da Importação temos o retorno do list_id quando a importação retornar com status done e com o status de cada anúncio está como accepted conforme no Retorno Esperado

curl --location --request GET 'https://apps.olx.com.br/autoupload/ads/1310831' \
--header 'authorization: Bearer access_token'

Retorno Esperado

O formato do retorno de nosso servidor será do tipo JSON, que contém a seguinte estrutura:

Parâmetro	Valores	Descrição
status	pending, deleted, accepted, refused	Retorna o status dos anúncios. pending: o anúncio será processado. deleted: o anúncio foi removido accepted: o anúncio foi ativado. Caso a operação seja de deleção, significa que o anúncio foi deletado. refused: o anúncio não foi ativado
message	Exemplos: REFUSED_GENERIC	Mensagens de aviso sobre erros ocorridos
url	string	Url do anúncio gerada Olx1
last_update	timestamp	Timestamp (UTC) no formato ISO indicando a última atualização concluída feita no anúncio 2
list_id	string	Retorna o id do seu anúncio, caso o mesmo tenha sido aprovado
id	Regular expression: [A-Za-z0-9_{}-]{1,19}	Identificador do anúncio definido pelo usuário

¹ Para um anúncio novo, a url é gerada porém pode levar alguns minutos para aparecer no site.

² Este timestamp é atualizado quando todas as etapas de importação ou edição forem concluídas. Enquanto houver alguma ação em execução, esse timestamp será correspondente da última atualização finalizada.

Códigos e motivos de erros da requisição retornados

Status Code	Nome	Descrição	Mensagem
200	OK	Sucesso	Dados referentes ao anúncio
400	Bad Request	Falta campo de authorization no header da requisição	{ "reason": "BAD_REQUEST", "message": "Check the header field(s)." }
401	Unauthorized	Token inválido	{ "reason": "ACCESS_DENIED", "message": "Check the client authentication token." }
404	Not Found	NOT FOUND
429	Rate Limit configurado quando o cliente fizer mais requisições por segundo do que deveria	RATE_LIMIT	You have exceeded the X requests in X seconds limit!
500	Internal Server Error	Erro interno inesperado	{ "reason": "UNEXPECTED_INTERNAL_ERROR", "message": "Unexpected internal error. Try again later." }

Exemplos de retorno:

Exemplo de retorno:

Anúncio Pendente

{
    "status": "pending",
    "message": [],
    "url": "https://www.olx.com.br/vi/1234.htm",
    "last_update": "2024-07-05T11:08:27.843403",
    "list_id": "1234",
    "id": 9999
}

Anúncio Removido

{
    "status": "deleted",
    "message": [],
    "url": "https://www.olx.com.br/vi/1234.htm",
    "last_update": "2024-07-05T11:08:27.843403",
    "list_id": "1234",
    "id": 9999
}

Anúncio Aceito

{
    "status": "accepted",
    "message": [],
    "url": "https://www.olx.com.br/vi/1234.htm",
    "last_update": "2024-07-05T11:08:27.843403",
    "list_id": "1234",
    "id": 9999
}

Anúncio Recusado

{
    "status": "refused",
    "message": [
        {
            "error": "REFUSED_GENERIC"
        }
    ],
    "url": "https://www.olx.com.br/vi/1234.htm",
    "last_update": "2024-07-05T11:08:27.843403",
    "list_id": "1234",
    "id": 9999
}