Pular para o conteúdo principal

Deletar produtos

Este endpoint é utilizado para deletar um lote de produtos de uma vez. É ideal para sistemas que precisam remover uma grande quantidade de produtos em uma única requisição.

DELETE /v1/batch/products​

Headers​

  • 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

Corpo da Requisição​

O corpo da requisição deve ser uma lista de strings, cada uma representando o UUID de um produto a ser deletado.

Exemplo de Corpo da Requisição​

[
  "9f36a666-acd5-4987-a47f-3de247f65d82",
  "7b2e4a1b-8c3d-4e5a-9f3b-2d6a1e5b7c3d",
  "3a1e5b7c-2d6a-4e5a-9f3b-7b2e4a1b8c3d"
]

Respostas​

  • 200: Retorna sucesso da operação. A resposta incluirá detalhes sobre o processamento da lista de produtos.
  • 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" }

Exemplo de Resposta para Erro (400)​

{
  "error": "Invalid request",
  "details": "The name field is missing in one of the product items."
}

Mensagem de notificação webhook​

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

{
  "operationId": "54d6a979-5f62-4e17-9d4c-dbd9f5ede403",
  "relatedEntity": "Product",
  "eventType": 1,
  "data": {},
  "contractAccountId": "9f36a666-acd5-4987-a47f-3de247f65d82"
}
  • OperationId: Identificador único da operação.
  • RelatedEntity: Entidade relacionada ao evento (por exemplo, Category).
  • EventType: Tipo de evento (por exemplo, Category_Created).
    • Os tipos possíveis relevantes para produto são:
      • Product_Created = 1
      • Product_Updated = 2
      • Product_Deleted = 3
  • Data: Dados específicos do evento.
  • ContractAccountId: Identificador da conta do contrato.
  • Error: Detalhes do erro caso exista algum.