{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Synonym API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
      "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Synonym",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a Synonym Rule.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/search/synonyms/:synonymId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "trackingId",
                "value": "acmecorporation_ca",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              },
              {
                "name": "synonymId",
                "value": "58bb4b98-1daa-4767-8c15-90a0ea67645c",
                "type": "path",
                "description": "A UUID identifying the synonym rule."
              }
            ]
          },
          "docs": "Retrieves a synonym rule.</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Edit Synonym Rule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/search/synonyms/:synonymId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "trackingId",
                "value": "acmecorporation_ca",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              },
              {
                "name": "synonymId",
                "value": "58bb4b98-1daa-4767-8c15-90a0ea67645c",
                "type": "path",
                "description": "A UUID identifying the synonym rule."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a synonym rule.</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{trackingId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Delete Synonym Rule.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/search/synonyms/:synonymId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "trackingId",
                "value": "acmecorporation_ca",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              },
              {
                "name": "synonymId",
                "value": "58bb4b98-1daa-4767-8c15-90a0ea67645c",
                "type": "path",
                "description": "A UUID identifying the synonym rule."
              }
            ]
          },
          "docs": "Deletes a synonym rule.</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{trackingId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "List Synonym Rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/search/synonyms",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "trackingId",
                "value": "acmecorporation_ca",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              },
              {
                "name": "language",
                "value": "en",
                "type": "query",
                "description": "An ISO 639-1 language code."
              },
              {
                "name": "country",
                "value": "US",
                "type": "query",
                "description": "An ISO 3166-1 alpha-2 country code."
              },
              {
                "name": "currency",
                "value": "USD",
                "type": "query",
                "description": "An ISO 4217 currency code."
              },
              {
                "name": "query",
                "value": "mens shoes",
                "type": "query",
                "description": "Filter on search term (query expression) when requesting rules."
              },
              {
                "name": "action",
                "value": "one-way",
                "type": "query",
                "description": "The synonym rule type. Possible values are: one-way, two-way, and one-way-reverse."
              },
              {
                "name": "sort",
                "value": "query.asc",
                "type": "query",
                "description": "property.direction to sort by."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based index number of the page of rules to retrieve.</br>**Minimum:** `0`</br>**Default:** `0`"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of rules to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:** `10`"
              }
            ]
          },
          "docs": "List synonym rules.</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create a Synonym Rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/search/synonyms",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "trackingId",
                "value": "acmecorporation_ca",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Persists a synonym rule.</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{trackingId}\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}