Consultar eventos¶
Listar eventos por ticket¶
Este endpoint permite recuperar todos os eventos de um determinado ticket
Escopo requerido
Valor | Descrição |
---|---|
open:ticket-events-seller:read |
Permite a utilização das APIs de leitura de eventos. |
Parâmetros da URL
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
ticket_uuid |
string | UUID do ticket ao qual o evento pertence. | Sim |
Chamada:
curl -X 'GET' \
'https://api.magalu.com/seller/v0/tickets/{ticket_uuid}/events' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <Access Token>' \
-H 'Content-Type: application/json' \
Parâmetros da resposta
Campo | Tipo | Descrição |
---|---|---|
id |
String | Chave UUID do evento. |
code |
String | Campo para livre utilização pelo sistema do seller. |
ticket_id |
Object | UUID do ticket ao qual o evento pertence. |
type |
String | Tipos de evento. Podem ser os seguintes valores: product_sent , return_info_sent , authorize_refund , product_received , exchange_product_received , refunded , added_bank_account , sla_waiting_customer_expired , rejection_reason , valid_bank_account , waiting_seller_pickup , seller_already_pickedup , waiting_pickup_schedule , sensitive_data_identified , sensitive_data_saved , return_invoice , cancel_invoice , delivery , return_invoice , withdrawn_product , waiting_picked_up , validating_return_invoice , waiting_refund_release |
created_at |
String | Data de criação. |
updated_at |
String | Data de atualização. |
created_by |
String | Usuário que criou o registro. |
updated_by |
String | Usuário que o atualizou. |
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": [
{
"id": "fb3d0cae-ef77-49ac-9516-21b764e7dc36",
"code": "codigo_opcional_definido_pelo_usuario",
"ticket_id": "58991c5b-2f63-4afe-b168-99dd720287bc",
"type": "product_sent",
"created_at": "2024-03-07T14:51:59.432Z",
"updated_at": "2024-03-07T14:51:59.432Z",
"created_by": "b339ffda-11ec-4ef7-af9c-881554aa4dc7",
"updated_by": "6e6c763c-f38f-475a-9f61-d0620f34de5e"
}
]
}
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 eventos por filtros¶
Este endpoint permite recuperar uma coleção de eventos de um determinado ticket, utilizando filtros como referência.
Escopo requerido
Valor | Descrição |
---|---|
open:ticket-events-seller:read |
Permite a utilização das APIs de leitura de eventos. |
Parâmetros da URL
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
ticket_uuid |
string | UUID do ticket ao qual o evento pertence. | Sim |
_limit |
Inteiro | Determina a quantidade de registros a serem retornados. Valor padrão 50. | Não |
type |
String | Tipos de evento. Podem ser os seguintes valores: product_sent , return_info_sent , authorize_refund , product_received , exchange_product_received , refunded , added_bank_account , sla_waiting_customer_expired , rejection_reason , valid_bank_account , waiting_seller_pickup , seller_already_pickedup , waiting_pickup_schedule , sensitive_data_identified , sensitive_data_saved , return_invoice , cancel_invoice , delivery , return_invoice , withdrawn_product , waiting_picked_up , validating_return_invoice , waiting_refund_release |
Não |
created_at_gte |
String (datetime - ISO 8601) | Filtra todos os eventos com data de criação maior ou igual. | Não |
created_at_lte |
String (datetime - ISO 8601) | Filtra todos os eventos com data de criação menor ou igual. | Não |
Chamada:
curl -X 'GET' \
'https://api.magalu.com/seller/v0/tickets/{ticket_uuid}/events?_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": [
{
"id": "fb3d0cae-ef77-49ac-9516-21b764e7dc36",
"code": "codigo_opcional_definido_pelo_usuario",
"ticket_id": "58991c5b-2f63-4afe-b168-99dd720287bc",
"type": "product_sent",
"created_at": "2024-03-07T14:51:59.432Z",
"updated_at": "2024-03-07T14:51:59.432Z",
"created_by": "b339ffda-11ec-4ef7-af9c-881554aa4dc7",
"updated_by": "6e6c763c-f38f-475a-9f61-d0620f34de5e"
}
]
}
Códigos de retorno
Código | Descrição |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |