Ir para o conteúdo

Consultar tickets

Recuperar tickets por ID

Este endpoint permite que o vendedor (seller) recupere um ticket utilizando o id como referência.

Atenção: ao efetuar consultas, o limite máximo de tempo dos registros retornados em uma consulta será dos últimos 3 anos a partir da data atual. Exemplo: se hoje for 03/02/2025, os dados pesquisáveis serão até 03/02/2022. Podem, no entanto, ocorrer outras limitações de quantidade de registros retornáveis ou de quantidade de dias disponíveis, mediante o total do histórico armazenado na plataforma com relação à outros sistemas integrados com a Open API.

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
id string Chave para identificaçāo do ticket. Sim

Chamada:

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

Campo Tipo Descrição
type String Tipos de ticket. ENUM: cancellation,payment, shipping
channel String Canal ao qual pertence o pedido.
channel.id String Identificador único do canal.
channel.alias String Alias do canal.
order String Detalhamento dos itens para os quais o protocolo está sendo aberto.
order.id String Identificador único do pedido na plataforma.
order.code String Código do pedido.
order.delivery Object Detalhamento dos itens que farão parte da solicitação.
order.delivery.id String Identificador único na plataforma.
order.delivery.seller String Informações do seller que fez a venda.
order.delivery.items List Itens que compõe o chamado.
order.delivery.seller.id String Tenant id do Seller no Id Magalu.
order.delivery.seller.name String Nome do Seller ou da Loja.
order.delivery.items.id String Identificador único na plataforma.
order.delivery.items.sku String Identificador do SKU no sistema.
order.delivery.items.external_sku String Identificador do SKU no sistema externo (integradora ou seller).
order.delivery.items.name String Nome do produto.
order.delivery.items.description String Descrição do produto.
order.delivery.items.image String Imagem principal do produto.
order.delivery.items.quantity String Quantidade de itens atrelados ao protocolo.
reason String Código que representa o motivo da abertura do ticket. Podem ser os seguintes valores: shipping_delay, price_discrepancy, incorrect_product, missing_damaged_parts, duplicated_order, payment_issue, quality_concern, change_of_mind, unavailability, customer_error, unexpected_circumstances, shipping_address_issues, shipping_delay, price_discrepancy, incorrect_product, missing_damaged_parts, duplicated_order, payment_issue, quality_concern, change_of_mind, unavailability, customer_error, unexpected_circumstances, shipping_address_issues, general, payment_authorization_failure, payment_discrepancy.

Resposta:

{
    "created_at": "2024-08-07T13:42:45",
    "updated_at": "2024-08-07T13:42:46",
    "id": "80b31c59-6d31-4d93-982a-7a6f51e335f5",
    "code": "f148ae87-0ce9-435b-94a4-6aa572f0569a",
    "type": "payment",
    "channel": {
        "id": "3f042852-3efc-4d47-97f8-f94989c7b0bc",
        "alias": "marketplace"
    },
    "order": {
        "id": "bcc662e8-527b-410f-87a5-bbc8f5e623da",
        "code": "1281270182459143",
        "delivery": {
            "id": "96061b77-b065-4cd8-9e41-b097bf95c173",
            "seller": {
                "id": "c85be697-7b14-4460-a5c7-3e58b4a364f9",
                "name": "SellerName"
            },
            "items": [
                {
                  "description": "Livro infantil a Bela e a Fera com encartes em 3D.",
                  "external_sku": "livro-seller-01",
                  "id": "63c54b4a-ea19-4c52-90a8-bd38cd1a3157",
                  "image": "https://imagem.do.livro/foto.jpg",
                  "name": "A Bela e a Fera em 3D",
                  "quantity": 1,
                  "sku": "livro-01"
                }
      ]
        }
    },
    "status": "waiting",
    "closed": false,
    "reason": null,
    "protocol": "202301000001123",
    "due_date": "2024-08-09T13:42:46",
    "origin": "customer"
}

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 tickets por filtros

Este endpoint permite recuperar uma coleção de tickets 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
status String Status do ticket. Podem ser os seguintes valores: waiting_seller, waiting_customer, waiting_marketplace, waiting_return_info, waiting_item_return, waiting_rating, waiting_banking_account, waiting_customer_complement, waiting_rating_complement, waiting_customer_close_ticket, refund_authorized, validating_bank_account, refund_denied, waiting_seller_pickup, seller_already_pickedup, waiting_picked_up, closed, waiting_partner_receive_collected_product, reversal_made, waiting_pickup, waiting_checklist, waiting_pickup_schedule, waiting_to_complete_the_checklist, failed_to_identify_reverse, validating_return_invoice, valid_return_invoice, waiting_refund_release, waiting_confirmation_collection_schedule, failed_collection_schedule. Não
channel__id String Identificador UUID do canal. Não
channel__alias String O alias do canal. Não
reason String Código que representa o motivo da abertura do ticket. Podem ser os seguintes valores: shipping_delay, price_discrepancy, incorrect_product, missing_damaged_parts, duplicated_order, payment_issue, quality_concern, change_of_mind, unavailability, customer_error, unexpected_circumstances, shipping_address_issues, shipping_delay, price_discrepancy, incorrect_product, missing_damaged_parts, duplicated_order, payment_issue, quality_concern, change_of_mind, unavailability, customer_error, unexpected_circumstances, shipping_address_issues, general, payment_authorization_failure, payment_discrepancy. Não
ticket_id String Identificador UUID do ticket. Não
order__code String Código do pedido. Não
order__id String Identificador UUID do pedido. Não
protocol String Protocolo do tícket. Não
created_at_gte String (datetime - ISO 8601) Filtra todos os tickets com data de criação maior ou igual. Não
created_at_lte String (datetime - ISO 8601) Filtra todos os tickets com data de criação menor ou igual. Não

Chamada:

curl -X 'GET' \
  'https://api.magalu.com/seller/v0/tickets?_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-08-07T13:42:45",
            "updated_at": "2024-08-07T13:42:46",
            "id": "80b31c59-6d31-4d93-982a-7a6f51e335f5",
            "code": "f148ae87-0ce9-435b-94a4-6aa572f0569a",
            "type": "cancellation",
            "channel": {
                "id": "3f042852-3efc-4d47-97f8-f94989c7b0bc",
                "alias": "marketplace"
            },
            "order": {
                "id": "bcc662e8-527b-410f-87a5-bbc8f5e623da",
                "code": "1281270182459143",
                "delivery": {
                    "id": "96061b77-b065-4cd8-9e41-b097bf95c173",
                    "seller": {
                        "id": "c85be697-7b14-4460-a5c7-3e58b4a364f9",
                        "name": "SellerName"
                    },
                    "items": [
                        {
                          "description": "Livro infantil a Bela e a Fera com encartes em 3D.",
                          "external_sku": "livro-seller-01",
                          "id": "63c54b4a-ea19-4c52-90a8-bd38cd1a3157",
                          "image": "https://imagem.do.livro/foto.jpg",
                          "name": "A Bela e a Fera em 3D",
                          "quantity": 1,
                          "sku": "livro-01"
                        }
                    ]
                }
            },
            "status": "waiting",
            "closed": "payment_issue",
            "reason": "payment_issue",
            "protocol": "2024080713422397",
            "due_date": "2024-08-09T13:42:46",
            "origin": "channel"
    }
  ]
}

Códigos de retorno

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