Skip to main content

Extra Fields

O campo extra_fields é utilizado para armazenar informações personalizadas que complementam a estrutura padrão de um processo ou de um pedido (order), dependendo da operação.

Ele permite que a Flowls modele campos específicos para cada cliente ou operação, com base nas regras de negócio acordadas no projeto de integração.

Conceito​

  • extra_fields é um campo do tipo objeto JSON, incluído dentro do params de criação ou edição de um processo ou pedido.
  • A estrutura dos campos é definida pela Flowls — seguindo as instruções do cliente.
  • Esse campo é utilizado em operações que exigem dados adicionais, como programação de embarque, cotações de frete, datas operacionais ou observações internas.

Onde usar​

Você pode encontrar o campo extra_fields em:

  • /orders → em casos onde dados operacionais do pedido precisam ser complementados
  • /processes → como parte do corpo de criação ou atualização de um processo logístico

ℹ️ A estrutura completa de extra_fields esperada para sua operação pode ser consultada diretamente na documentação da plataforma:

🔗 https://www.flowls.app/integrations/docs

Exemplo simplificado​

"extra_fields": {
  "partner_shipment_number": "ABC-1234",
  "delay_reason": [
    "Aguardando documentação",
    "Problema no booking"
  ],
  "internal_responsible_expo": {
    "name": "João Silva",
    "email": "joao@empresa.com"
  }
}

Validação e suporte​

A Flowls pode aplicar validações específicas nos campos de extra_fields, de acordo com o seu projeto de integração.