Criar Tickets

Criar um novo ticket de atendimento

Este endpoint permite criar um novo ticket (protocolo) de atendimento

Escopo requerido

Valor	Descrição
open:tickets-seller:write	Permite a utilização das APIs de escrita/atualização.

Parâmetros da chamada

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

Chamada:

curl -X 'POST' \
  'https://api.magalu.com/seller/v0/tickets' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "shipping",
    "channel": {
        "id": "3f042852-3efc-4d47-97f8-f94989c7b0bc",
        "alias": "marketplace"
    },
    "order": {
      "id": "195a8e41-afcc-455b-907a-475137106f84",
      "code": "987654",
      "delivery": {
        "id": "195a8e41-afcc-455b-907a-475137106f84",
        "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"
          }
        ],
        "seller": {
          "id": "c85be697-7b14-4460-a5c7-3e58b4a364f9",
          "name": "Lojinha de Livros Infantis"
        }
      }
    },
    "reason": "missing_parts"
  }'

Parâmetros da Resposta

Campo	Tipo	Descrição
transaction_id	String	Um identificador exclusivo para acompanhar o status da transação.
links	List	Uma lista com o endpoint para recuperar o status da transação.

Resposta:

{
  "transaction_id": "2d97892b-50f2-4e0e-8967-3d962c29ade9",
  "links": [
    {
      "path": "/seller/v0/transactions/2d97892b-50f2-4e0e-8967-3d962c29ade9"
    }
  ]
}

Acompanhar finalização da criação da Ticket

A criação de ticket agora é um fluxo assíncrono e pode ser acompanhado a partir de transações. Consulte a documentação sobre fluxos assíncronos e transações para entender mais sobre o processo.

Códigos de retorno

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

Acompanhar finalização da criação da Ticket

A criação de ticket é um fluxo assíncrono e pode ser acompanhado a partir de transações. Consulte a documentação sobre fluxos assíncronos e transações para entender mais sobre o processo.