Ir para o conteúdo

Consultar códigos das reversas

Listar códigos das reversas por ticket

Este endpoint permite recuperar todos os códigos das reversas de um determinado ticket

Escopo requerido

Valor Descrição
open:ticket-returns-seller:read Permite a utilização das APIs de leitura.

Parâmetros da URL

Campo Tipo Descrição Obrigatório
ticket_uuid string UUID do ticket ao qual o código reversa, pertence. Sim

Chamada:

curl -X 'GET' \
  'https://api.magalu.com/seller/v0/tickets/{ticket_uuid}/returns' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \
Parâmetros da resposta

Campo Tipo Descrição
created_at String Data de criação.
updated_at String Data de atualização.
id String UUID do ticket ao qual o evento pertence.
ticket_id Object Identificador UUID do ticket.
reverse_code String Código de remessa reversa.

Resposta:

{
  "meta": {
    "page": {
      "limit": 1,
      "offset": 1,
      "count": 1,
      "max_limit": 10
    },
    "links": {
      "previous": "?_offset=0&_limit=1",
      "self": "?_offset=1&_limit=1",
      "next": "?_offset=2&_limit=1"
    }
  },
  "results": [
    {
      "created_at": "2024-11-22T10:42:45",
      "updated_at": "2024-11-22T10:42:45",
      "id": "80b31c59-6d31-4d93-982a-7a6f51e335f5",
      "ticket_id": "f148ae87-0ce9-435b-94a4-6aa572f0569a",
      "reverse_code": "63c54b4a-ea19-4c52-90a8-bd38cd1a3157"
    }
  ]
}

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 códigos de reversas por filtros

Este endpoint permite recuperar uma coleção de códigos de reversas utilizando filtros como referência.

Escopo requerido

Valor Descrição
open:tickets-seller:read Permite a utilização das APIs de leitura.

Parâmetros da URL

Campo Tipo Descrição Obrigatório
_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
_limit Inteiro Determina a quantidade de registros a serem retornados. Valor padrão 10. Não
reverse_code String Identificador UUID do código de reversa. Não
created_at_gte String (datetime - ISO 8601) Filtra todos os códigos de reversas com data de criação maior ou igual. Não
created_at_lte String (datetime - ISO 8601) Filtra todos os códigos de reversas com data de criação menor ou igual. Não

Chamada:

curl -X 'GET' \
  'https://api.magalu.com/seller/v0/tickets/{ticket_uuid}/returns?_limit=1' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \

Resposta:

{
  "meta": {
    "page": {
      "limit": 1,
      "offset": 1,
      "count": 1,
      "max_limit": 10
    },
    "links": {
      "previous": "?_offset=0&_limit=1",
      "self": "?_offset=1&_limit=1",
      "next": "?_offset=2&_limit=1"
    }
  },
  "results": [
    {
      "created_at": "2024-11-22T10:42:45",
      "updated_at": "2024-11-22T10:42:45",
      "id": "80b31c59-6d31-4d93-982a-7a6f51e335f5",
      "ticket_id": "f148ae87-0ce9-435b-94a4-6aa572f0569a",
      "reverse_code": "63c54b4a-ea19-4c52-90a8-bd38cd1a3157"
    }
  ]
}

Códigos de retorno

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

Buscar códigos de reversas por ID

Este endpoint permite recuperar um código de reversa de um determinado ticket, utilizando o id do código de reversa e o id do ticket, como referência.

Escopo requerido

Valor Descrição
open:ticket-messages-seller:read Permite a utilização das APIs de leitura.

Parâmetros da URL

Campo Tipo Descrição Obrigatório
ticket_uuid string Identificador UUID do ticket. Sim
return_uuid string Identificador UUID do código da reversa. Sim

Chamada:

curl -X 'GET' \
  'https://api.magalu.com/seller/v0/tickets/{ticket_uuid}/returns/{return_uuid}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \

Resposta:

{
    "created_at": "2024-11-22T10:42:45",
    "updated_at": "2024-11-22T10:42:45",
    "id": "80b31c59-6d31-4d93-982a-7a6f51e335f5",
    "ticket_id": "f148ae87-0ce9-435b-94a4-6aa572f0569a",
    "reverse_code": "63c54b4a-ea19-4c52-90a8-bd38cd1a3157"
}

Códigos de retorno

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