---
title: "Compare"
method: POST
path: "/api/v2/compare"
tags: ["CompareV2"]
---

# Compare

`POST /api/v2/compare`

## Request

- Base URL: `https://indexing-dev.hawksearch.net`
- URL: `https://indexing-dev.hawksearch.net/api/v2/compare`
- Auth: none declared
- TypeScript: <https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi/docs/api/v2/compare/post.ts> (a function with typed inputs; its response is checked against the schema)

The compare method is to be called when users willing to compare one or more items.

## Request body

- CompareRequest
  - `ClientGuid` string
  - `Ids` string[]: A list of product's ids
  - `FieldOverride` string[]: An array of field names that Elastic Search will return in a response
  - `IndexName` string: Search a given index

## Response `200`

OK

- object

---

[API](https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi.md) - [All operations](https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi/llms.txt) - [OpenAPI document](https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi/revisions/24cba7bf3468?raw)