Pular para o conteúdo principal

Lista as parametrizações da integração

GET 
/company/integration/:idcompanyintegration/parameter

Devolve o catálogo de parametrizações do tipo da integração cruzado com os valores já gravados pela empresa — é o que a tela usa para montar o formulário de configuração, agrupado por TypeCompanyParametersGroup.

Detalhes do retorno:

  • Só vêm parametrizações com Type diferente de hidden, ordenadas por ParameterOrder.
  • Para Type list/multi_list, o campo List traz as opções disponíveis (itens de tabelas-tipo, planos de contas, contas bancárias, status, etc., conforme a Key).
  • Para Type string_copy/url_get, o campo Value pode ser calculado (ex.: URL de webhook/leilão de frete personalizada para a empresa, com tokens embutidos), em vez do valor cru gravado.

Modo alternativo — quando Type=ImportOffer, o endpoint não retorna parametrizações: devolve o último job de importação de anúncios da integração com o progresso (QuantityProcessed, QuantityPending, QuantityTotal).

Request​

Responses​

No modo padrão: lista de parametrizações da integração. Array vazio quando não há registros.

Com Type=ImportOffer os itens têm forma completamente diferente — são registros do último job de importação de anúncios da integração (identificador e tipo do job, datas de início e término, arquivo e o Login do usuário que disparou), acrescidos de QuantityProcessed (linhas já processadas), QuantityPending (linhas ainda na fila) e QuantityTotal (soma das duas). Também devolve array vazio quando não há registro.

Última atualização em