Pular para o conteúdo principal

Excluir categorias e seus relacionamentos

Este endpoint é utilizado para excluir um lote de categorias de uma vez. Esse processo é ideal para sistemas que precisam remover uma lista de categorias e suas sub-categorias.

DELETE /v1/batch/categories​

  • Authorization: Basic Auth contendo a chave pública e secreta disponibilizadas para o cliente.
    • Exemplo: Basic <base64-encoded-credentials>
  • x-contractAccountId: Identificador da conta do contrato do cliente.
    • Exemplo: x-contractAccountId: 9f36a666-acd5-4987-a47f-3de247f65d82

Exemplo de Autorização​

Para gerar o valor de Authorization, você precisa codificar suas credenciais (public_key:secret_key) em base64. Por exemplo, se sua chave pública for public_key e sua chave secreta for secret_key, você deve codificar public_key:secret_key em base64.

echo -n 'public_key:secret_key' | base64

Corpo da Requisição​

O corpo da requisição deve ser uma lista (array) de referências externas que serão utilizados para localizar cada categoria.

Exemplo de Corpo da Requisição​

[
  "cat-1",
  "cat-2",
  "cat-3"
]

Respostas​

  • 200: Retorna sucesso da operação. A resposta incluirá detalhes sobre o processamento.
  • 400: Retorna erro de requisição inválida. Isso geralmente ocorre devido a dados de entrada mal formatados ou faltando.
  • 500: Retorna erro interno do servidor. Indica problemas no processamento da requisição no servidor.

Exemplo de Resposta para Sucesso (200)​

{ "operationId": "402fe685-2060-432b-ac57-223eb2e680f3" }

Mensagem de notificação webhook​

Quando a operação é processada, uma mensagem é enviada para os endpoints de notificação registrados pelo webhook. A mensagem contém o ID, o status da operação e detalhes do retorno.

{
  "operationId": "54d6a979-5f62-4e17-9d4c-dbd9f5ede403",
  "relatedEntity": "Category",
  "eventType": 12,
  "data": {
    "externalReference": "cat-1",
    "name": "Alimentos",
    "title": "Alimentos",
    "description": "Categoria de alimentos"
  },
  "contractAccountId": "9f36a666-acd5-4987-a47f-3de247f65d82"
}
  • OperationId: Identificador único da operação.
  • RelatedEntity: Entidade relacionada ao evento (Category).
  • EventType: Tipo de evento.
    • Os tipos possíveis relevantes para categoria são:
      • Category_Created = 10
      • Category_Updated = 11
      • Category_Deleted = 12
      • Category_CreationFailed = 103
      • Category_UpdateFailed = 113
      • Category_DeletionFailed = 123
  • Data: Dados específicos do evento.
  • ContractAccountId: Identificador da conta do contrato.
  • Error: Detalhes do erro caso exista algum.