Consulta de anúncios destacados

A URL usada para fazer a requisição do arquivo JSON é https://apps.eupreciso.com.br/v1.0/marketplace/ads/bump, método POST. Essa requisição deve conter em seu body ad_ids em formato JSON uma lista de até 10 identificadores de anúncios.

A requisição feita para esta URL deve conter o access_token de cada anunciante nos headers, usando o método POST.

{
  "ad_ids": ["6712a764c37c38e9039093e4", "6712a868c37c38e903909a28"]
}

BODY	Valores	Obrigatório	Descrição
`ad_id`	array[string]	Sim	Lista de até 10 identificadores de anúncios. Obs: se for enviada uma lista com mais de 10 identificadores, o 11º em diante será ignorado.

Se o anunciante possui anúncios destacados, a requisição retorna um status code 200 e um JSON no corpo da resposta com a estrutura abaixo, podendo vir uma lista com até 10 itens.

Retorno de sucesso esperado

Parâmetro	Valores	Obrigatório	Descrição
`sku`	string	Sim	SKU do anúncio no integrador/anunciante.
`id`	string	Não	Identificador do anúncio no Eu Preciso.
`date`	string (ISO Datetime)	Sim	Data do bump.
`value`	integer	Não	Valor pago pelo destaque.
`days`	integer	Não	Dias contratados do destaque.
`last_bumps`	arrayOf[string (ISO Datetime)]	Não	Últimas datas que o anúncio foi ao topo.
`reason`	string	Não	Motivo do erro que ocorreu ao obter dados do anúncio específico.
`message`	string	Não	Mensagem de erro que ocorreu ao obter dados do anúncio específico.

Retorno de erro esperado

Caso ocorra algum erro ou o anunciante não possua os Recursos PRO ativo, a consulta retorna um status code > 400 e um JSON com o motivo e a mensagem do erro.

Status Code	Descrição	Motivo	Mensagem
400	Falta campo de authorization no header da requisição	BAD_REQUEST	Check the header field(s)
401	Token inválido	ACCESS_DENIED	Check the client authentication token
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	Erro interno inesperado	UNEXPECTED_INTERNAL_ERROR	Unexpected internal error. Try again later

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

Anúncio	Condição do anúncio em relação a destaque
B124	Todos os destaques aplicados e destaque ativo, ou seja, no período de dias contratados a partir da aplicação do destaque.
D1234	Anúncio com histórico de destaques aplicados, mas sem destaque ativo.
S995	Sem destaque aplicado. Retornará “Anúncio não encontrado”.
E4567	Ocorreu uma indisponibilidade no momento da consulta deste anúncio. Por favor, tente mais tarde.

Exemplos de Retorno

Consulta de 4 anúncios em situações diferentes, conforme condições abaixo:

Request

curl --location --request POST 'https://apps.eupreciso.com.br/v1.0/marketplace/ads/bump' \
--header 'Authorization: Bearer 5/4PXLrAv2gLZ6dqokH6xB' \
--header 'Content-Type: application/json' \
--data-raw '{
"ad_ids": ["6712a764c37c38e9039093e4", "6712a868c37c38e903909a28", "6712b08fc37c38e903909cbb", "6712a312c37c38e9038fd9b6"]
}'

Response

{
  "B124": [
    {
      "sku": "CAMISETA_P",
      "id": "6712a764c37c38e9039093e4",
      "date": "2023-12-01 00:00:00.00000",
      "value": 5,
      "days": 7,
      "lastBumps": [
        { "date": "2023-11-15 00:00:00.00000", "value": 5, "days": 7 },
        { "date": "2023-11-01 00:00:00.00000", "value": 5, "days": 7 }
      ]
    }
  ],
  "D1234": [
    {
      "sku": "IPH14PRO-512-SIL",
      "id": "6712a868c37c38e903909a28",
      "lastBumps": [
        { "date": "2023-11-10 00:00:00.00000", "value": 5, "days": 7 },
        { "date": "2023-11-02 00:00:00.00000", "value": 5, "days": 7 }
      ]
    }
  ],
  "S995": [
    {
      "id": "6712b08fc37c38e903909cbb",
      "reason": "NOT_FOUND",
      "message": "Ad not found."
    }
  ],
  "E4567": [
    {
      "id": "6712a312c37c38e9038fd9b6",
      "reason": "UNPROCESSABLE_AD",
      "message": "I couldn't get information for this ad. Please try again later"
    }
  ]
}

Aplicação de Destaque em Anúncios Inventário