Consultar Perguntas/Respostas

Recuperar perguntas por ID

Este endpoint permite que o vendedor (seller) recupere uma pergunta/resposta utilizando o id como referência.

Escopo requerido

Valor	Descrição
services:questions-seller:read	Permite a utilização das APIs de escrita/atualização.

Parâmetros da URL

Campo	Tipo	Descrição	Obrigatorio
id	string	Chave para identificaçāo da Pergunta	Sim

Chamada:

curl -X 'GET' \
  'https://services.magalu.com/v0/questions/{id}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \

Resposta:

{
  "id": "630e3bbc950b052e8724491a",
  "status": "NEW",
  "subject": {
    "id": "id-001",
    "type": "offer",
    "extra": {
      "name": "Camiseta",
      "description": "Camiseta gola v na cor verde",
      "url_img": "https://www.magazineluiza.com/camiseta-gola-v_imagem.jpg",
      "url": "https://www.magazineluiza.com/camiseta-gola-v"
    },
    "custom_fields": [
      {
        "name": "Cor",
        "value": "Verde"
      }
    ],
    "identifiers": [
      {
        "name": "openapi",
        "value": "a11d50a5-31c1-4e9d-bbe3-27a59f944508",
        "reference": "  "
      }
    ]
  },
  "question": {
    "message": "Quais as outras cores?",
    "when_at": "2023-06-27T18:56:28.445Z",
    "owner": {
      "name": "Fluano da Silva (cliente)",
      "external_id": "cli-001"
    },
    "product": {
      "sku": "sku-123",
      "description": "description - 01"
    }
  },
  "answer": {
    "message": "Temos em três  cores azul, amarelo e vermelho.",
    "external_id": "resposta-01",
    "owner": {
      "name": "Joseph Climber",
      "external_id": "j.climber"
    },
    "moderation": {
      "status": "NOT_MODERATED",
      "when_at": "2023-06-27T18:56:28.445Z",
      "block_rules": []
    }
  }
}

Códigos de retorno

Código	Descrição
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Recuperar perguntas por filtros

Este endpoint permite recuperar uma coleção de perguntas/respostas utilizando filtros como referência.

Escopo requerido

Valor	Descrição
services:questions-seller:read	Permite a utilização das APIs de escrita/atualização.

Parâmetros da URL

Campo	Tipo	Descrição	Obrigatorio
_limit	inteiro	Determina a quantidade de registros a serem retornados. Valor padrão 10.	Não
_offset	inteiro	Posição de registro de referência, a partir dele serão retornados os próximos N registros. Valor padrão 0.	Não
status	string	Status da mensagem, pode ser o seguintes valores: WAITING_RESPONSE, REJECTED_RESPONSE, APPROVED.	Não
answer.external_id	String	Identificador do sistema externo que correlaciona com a resposta	Não
answer.owner.external_id	String	Identificador do sistema externo do autor da resposta	Não

Chamada:

curl -X 'GET' \
  'https://services.magalu.com/v0/questions' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \

Resposta:

{
  "meta": {
    "page": {
      "limit": 20,
      "offset": 150,
      "max_limit": 100
    },
    "links": {
      "previous": "?_offset=130&_limit=20",
      "next": "?_offset=170&_limit=20",
      "self": "?_offset=150&_limit=20"
    }
  },
  "results": [
    {
      "id": "630e3bbc950b052e8724491a",
      "status": "NEW",
      "subject": {
        "id": "id-001",
        "type": "offer",
        "extra": {
          "name": "Camiseta",
          "description": "Camiseta gola v na cor verde",
          "url_img": "https://www.magazineluiza.com/camiseta-gola-v_imagem.jpg",
          "url": "https://www.magazineluiza.com/camiseta-gola-v"
        },
        "custom_fields": [
          {
            "name": "Cor",
            "value": "Verde"
          }
        ],
        "identifiers": [
          {
            "name": "openapi",
            "value": "a11d50a5-31c1-4e9d-bbe3-27a59f944508",
            "reference": "https://api-internal.magalu.com/v0/portfolios/skus/a11d50a5-31c1-4e9d-bbe3-27a59f944508"
          }
        ]
      },
      "question": {
        "message": "Quais as outras cores?",
        "when_at": "2023-06-27T18:56:28.445Z",
        "owner": {
          "name": "Fluano da Silva (cliente)",
          "external_id": "cli-001"
        },
        "product": {
          "sku": "sku-123",
          "description": "description - 01"
        }
      },
      "answer": {
        "message": "Temos em três  cores azul, amarelo e vermelho.",
        "external_id": "resposta-01",
        "owner": {
          "name": "Joseph Climber",
          "external_id": "j.climber"
        },
        "moderation": {
          "status": "NOT_MODERATED",
          "when_at": "2023-06-27T18:56:28.445Z",
          "block_rules": []
        }
      }
    }
  ]
}

Códigos de retorno

Código	Descrição
200	OK
400	Bad Request
401	Unauthorized
500	Internal Server Error