A entidade Campos Extras do Pedido permite criar campos personalizados que serão exibidos nos pedidos do Mercos. Eles são ideais para registrar informações relevantes para a empresa ou para o integrador, por exemplo: Data de Entrega, Tipo de Frete, Código Interno, entre outros.
Esses campos possibilitam uma maior flexibilidade no preenchimento e na captura de dados operacionais.
Os campos extras podem ser dos seguintes tipos:
"0"Texto livre"1"Data"2"Numérico"3"Hora"4"Lista (simples ou múltipla)
Estrutura da Resposta (GET)
| Campo | Tipo | Descrição |
|---|---|---|
| id | Integer | Identificador único do campo extra. |
| tipo | String | Tipo do campo: "0" Texto livre, "1" Data, "2" Numérico, "3" Hora, "4" Lista. |
| nome | String: 50 | Nome do campo extra. |
| obrigatorio | Boolean | Indica se o preenchimento do campo é obrigatório. |
| casas_decimais | Integer | Quantidade de casas decimais (0 a 5, apenas para campos numéricos). |
| formato | String | Formatação: "0" Sem formatação, "1" R$ (monetário), "2" % |
| exibir_para_cliente | Boolean | Indica se o campo será visível para o cliente. |
| lista_multipla | Boolean | Indica se permite múltipla seleção (para tipo lista). |
| itens | List: 100 | Lista de itens disponíveis. |
| ultima_alteracao | DateTime | Data e hora da última modificação. |
| excluido | Boolean | Indica se o campo extra foi excluído. |
Estrutura dos Itens (para campos do tipo Lista)
| Campo | Tipo | Descrição |
|---|---|---|
| id | Integer | Identificador único do item. |
| campo_custom_id | Integer | ID do campo extra ao qual este item pertence. |
| ordem | Integer | Ordem de exibição do item na lista. |
| valor | String: 100 | Valor do item exibido no campo. |
| selecionado | Boolean | Define se o item vem pré-selecionado. |
| ultima_alteracao | DateTime | Data e hora da última modificação do item. |
| excluido | Boolean | Indica se o item foi excluído. |
Observações importantes sobre os itens de lista
- O cadastro dos itens respeita a ordem em que são enviados para gerar o retorno com os respectivos
ids.- O número máximo de itens que podem ser cadastrados por campo do tipo lista é 100.
- Durante a alteração, caso um item não contenha
id, será considerado um novo item.- Quando um
idfor informado, o sistema fará a atualização do item correspondente.- A ordem de envio dos itens também será respeitada no retorno após a alteração.
Parâmetros de Envio (POST / PUT)
| Campo | Tipo | Descrição |
|---|---|---|
| tipo (obrigatório) | String | Tipo do campo: "0" Texto livre, "1" Data, "2" Numérico, "3" Hora, "4" Lista. |
| nome (obrigatório) | String: 50 | Nome do campo extra. |
| obrigatório | Boolean | Indica se o campo é de preenchimento obrigatório. |
| casas_decimais | Integer | Quantidade de casas decimais (aplicável apenas para campos numéricos, de 0 a 5). |
| formato | String | Formatação do valor numérico: "0" Sem formatação, "1" R$ (monetário), "2" %. |
| exibir_para_cliente | Boolean | Indica se o valor será visível para o cliente na visualização do pedido. |
| excluido | Boolean | Define se o campo deve ser marcado como excluído. |
| lista_multipla | Boolean | Indica se o campo do tipo lista permite múltiplas seleções. |
| itens | List: 100 | Lista de itens para campos do tipo lista. Cada item deve seguir a estrutura descrita acima. |