API Saída IPA - Negociações Fechadas |

Parâmetro	Descrição	Formato	Obrigatório
`search`	Texto livre para busca de negociações (ex.: nome da negociação)	`string`	Não
`page`	Número da página. O padrão se não enviado é 0	`int`	Não
`size`	Tamanho da página	`int`	Não

Campo	Descrição	Tipo
`product`	Filtro por identificadores de produto	`array de string`
`store`	Filtro por identificadores de loja	`array de string`
`cluster`	Filtro por nome de cluster	`array de string`
`supplier`	Filtro por fornecedor	`array de string`
`owner`	Filtro por responsável pela negociação	`array de string`

Campo	Descrição	Tipo
`id`	Identificador único da negociação (use no endpoint de detalhes)	`string (UUID)`
`name`	Nome da negociação	`string`
`supplierId`	Identificador do fornecedor	`int`
`supplier`	Nome do fornecedor	`string`
`stores`	Lojas contempladas pela negociação	`array de string`
`clusters`	Clusters de lojas contemplados pela negociação	`array de string`
`startDate`	Data de início da vigência	`date (yyyy-MM-dd)`
`endDate`	Data de fim da vigência	`date (yyyy-MM-dd)`
`lastEditedDate`	Data da última edição da negociação	`date (yyyy-MM-dd)`
`owner`	Responsável pela negociação	`string`
`status`	Status da negociação. Este endpoint retorna somente `CLOSED`	`string (ONGOING, CLOSED)`
`totalProducts`	Quantidade de produtos na negociação	`int`
`visionSaved`	Grão em que a negociação foi gravada	`string (STORE, CLUSTER, NETWORK)`

Parâmetro	Descrição	Formato	Obrigatório
`ipaNegotiationId`	Identificador da negociação (campo `id` retornado pelo endpoint de listagem)	`UUID`	Sim
`page`	Número da página. O padrão se não enviado é 0	`int`	Não
`size`	Tamanho da página. O padrão se não enviado é 20	`int`	Não

Campo	Descrição	Tipo
`productsToBePricedId`	Identificador único do item na negociação	`string (UUID)`
`productId`	Identificador do produto	`string`
`productFamilyId`	Identificador da família do produto	`string`
`description`	Descrição do produto	`string`
`store`	Nome da loja	`string`
`storeId`	Identificador da loja	`string`
`cluster`	Cluster de lojas do item (objeto com `clusterId`, `clusterName`, `clusterItemsCount`)	`objeto`
`objectiveMargin`	Margem objetiva vigente (%)	`decimal`
`cost`	Custo vigente	`decimal`
`pmz`	Preço de margem zero com o custo vigente	`decimal`
`newCost`	Custo negociado	`decimal`
`newObjectiveMargin`	Nova margem objetiva (%)	`decimal`
`PMZNewCost`	Preço de margem zero com o custo negociado	`decimal`
`newPrice`	Novo preço de venda calculado	`decimal`
`newPriceCompetitors`	Preço dos concorrentes usado como referência para o novo preço	`decimal`
`newPriceMargin`	Margem do novo preço (%)	`decimal`
`retailPrice`	Preço de venda vigente	`decimal`
`marginRetailPrice`	Margem do preço vigente (%)	`decimal`
`competitivenessRetailPrice`	Competitividade do preço vigente (%)	`decimal`
`competitorsPrice`	Preço dos concorrentes	`decimal`
`marginCompetitorsPrice`	Margem sobre o preço dos concorrentes (%)	`decimal`
`bestIdealPrice`	Melhor preço ideal calculado	`decimal`
`bestIdealPricePMZ`	Preço de margem zero do melhor preço ideal	`decimal`
`salesTaxPercentage`	Percentual de impostos de venda (%)	`decimal`
`expensesPercent`	Percentual de despesas (%)	`decimal`
`competitivenessIndicator`	Indicador de competitividade	`string`
`purchaseTaxPercentage`	Percentual de impostos de compra (%)	`decimal`
`entryCost`	Custo de entrada	`decimal`
`isEdited`	Indica se o item foi editado manualmente na negociação	`boolean`
`costIndicator`	Indicador de qualidade do custo negociado	`string (VERY_BAD, BAD, REGULAR, GOOD, VERY_GOOD)`
`visionSaved`	Grão em que o item foi gravado	`string (STORE, CLUSTER, NETWORK)`
`negotiationSupplierDatapointStatus`	Status do item na negociação com o fornecedor	`string (APPROVED, DECLINED)`
`gtin`	Código GTIN do produto	`string`
`stock`	Estoque do produto na loja (objeto com `quantity`, `coverageDays`, `lastUpdated`)	`objeto`
`competitorStore`	Loja concorrente de referência	`string`

¶ API Saída IPA - Negociações Fechadas

¶ Listar negociações fechadas

¶ URL

¶ Requisição

¶ Parâmetros (query string)

¶ Corpo da requisição

¶ Cabeçalhos

¶ Exemplo

¶ Resposta

¶ JSON

¶ Descrição dos campos da resposta

¶ Detalhar itens de uma negociação

¶ URL

¶ Requisição

¶ Parâmetros (query string)

¶ Cabeçalhos

¶ Exemplo

¶ Resposta

¶ JSON

¶ Descrição dos campos da resposta

¶ Observações