{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Rocket Search"
  },
  "servers": [
    {
      "url": "https://api.rocketsearch.ru/rocketsearch/v5/partner/"
    }
  ],
  "tags": [
    {
      "name": "SERP and preview",
      "x-displayName": "Поисковая выдача и предпросмотр"
    },
    {
      "name": "Search interaction",
      "x-displayName": "Взаимодействие с поиском"
    }
  ],
  "paths": {
    "/{partnerId}/phrase/{phrase}/page/": {
      "post": {
        "tags": [
          "SERP and preview"
        ],
        "summary": "Получение поисковой выдачи",
        "description": "Данный метод позволяет получить поисковую выдачу интернет-магазина через Rocket Search",
        "operationId": "post_{partnerId}phrase{phrase}page",
        "responses": {
          "200": {
            "description": "Successful response"
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "partnerId",
            "schema": {
              "type": "string",
              "default": "59908d02c7d013ce40de715a"
            },
            "required": true,
            "description": "Идентификатор интернет-магазина"
          },
          {
            "in": "path",
            "name": "phrase",
            "schema": {
              "type": "string",
              "default": "Телевизор"
            },
            "required": true,
            "description": "Поисковая фраза с использованием URL-encoding"
          },
          {
            "in": "query",
            "name": "apiKey",
            "schema": {
              "type": "string",
              "default": "5b333f5697a528b0184b6017"
            },
            "description": "Ключ авторизации",
            "required": true
          },
          {
            "in": "query",
            "name": "page",
            "schema": {
              "type": "number",
              "default": "1"
            },
            "description": "Номер страницы начиная с 1",
            "required": true
          },
          {
            "in": "query",
            "name": "pageSize",
            "schema": {
              "type": "number",
              "default": "50"
            },
            "description": "Количество товаров на одной странице",
            "required": true
          },
          {
            "in": "query",
            "name": "lang",
            "schema": {
              "type": "string",
              "default": "ru"
            },
            "required": true,
            "description": "Язык магазина"
          },
          {
            "in": "query",
            "name": "stockId",
            "schema": {
              "type": "string",
              "default": "Москва"
            },
            "description": "Идентификатор склада, который выбран у пользователя"
          },
          {
            "in": "query",
            "name": "sorting",
            "schema": {
              "type": "string",
              "default": "price_asc"
            },
            "description": "Вариант сортировки"
          },
          {
            "in": "query",
            "name": "linkName",
            "schema": {
              "type": "string",
              "default": "session"
            },
            "description": "Указатель на название сессии посетителя",
            "required": true
          },
          {
            "in": "query",
            "name": "linkValue",
            "schema": {
              "type": "string",
              "default": "a83642d5-da3b-4831-beed-e4bc182fec17"
            },
            "description": "Указатель на идентификатор сессии посетителя",
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "filters": {
                    "type": "string",
                    "default": "[]",
                    "description": "Массив объектов, где каждый объект - тип фильтра",
                    "format": "json"
                  }
                },
                "type": "object"
              }
            }
          }
        },
        "servers": [
          {
            "url": "https://api.rocketsearch.ru/rocketsearch/v5/partner/"
          }
        ]
      }
    },
    "/{partnerId}/phrase/{phrase}/preview/": {
      "get": {
        "tags": [
          "SERP and preview"
        ],
        "summary": "Предпросмотр поиска",
        "description": "Данный метод позволяет получить выдачу для показа предпросмотра поиска через Rocket Search",
        "operationId": "get_{partnerId}phrase{phrase}preview",
        "responses": {
          "200": {
            "description": ""
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "partnerId",
            "schema": {
              "type": "string",
              "default": "59908d02c7d013ce40de715a"
            },
            "required": true,
            "description": "Идентификатор интернет-магазина"
          },
          {
            "in": "path",
            "name": "phrase",
            "schema": {
              "type": "string",
              "default": "Телевизор"
            },
            "required": true,
            "description": "Поисковая фраза с использованием URL-encoding"
          },
          {
            "in": "query",
            "name": "apiKey",
            "schema": {
              "type": "string",
              "default": "5b333f5697a528b0184b6017"
            },
            "description": "Ключ авторизации",
            "required": true
          },
          {
            "in": "query",
            "name": "lang",
            "schema": {
              "type": "string",
              "default": "ru"
            },
            "description": "Язык магазина",
            "required": true
          },
          {
            "in": "query",
            "name": "stockId",
            "schema": {
              "type": "string",
              "default": "Москва"
            },
            "description": "Идентификатор склада, который выбран у пользователя"
          },
          {
            "in": "query",
            "name": "linkName",
            "schema": {
              "type": "string",
              "default": "session"
            },
            "required": true,
            "description": "Указатель на название сессии посетителя"
          },
          {
            "in": "query",
            "name": "linkValue",
            "schema": {
              "type": "string",
              "default": "a83642d5-da3b-4831-beed-e4bc182fec17"
            },
            "description": "Указатель на идентификатор сессии посетителя",
            "required": true
          }
        ],
        "servers": [
          {
            "url": "https://api.rocketsearch.ru/rocketsearch/v5/partner/"
          }
        ]
      }
    },
    "/smartSearch/productClicked": {
      "post": {
        "tags": [
          "Search interaction"
        ],
        "summary": "Клик по товару",
        "description": "Событие клика на товар в поисковой выдаче.",
        "operationId": "post_smartSearchproductClicked",
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "parameters": [
          {
            "in": "query",
            "name": "apiKey",
            "schema": {
              "type": "string",
              "default": "5b333f5697a528b0184b6017"
            },
            "required": true,
            "description": "Ключ авторизации"
          },
          {
            "in": "query",
            "name": "partnerId",
            "schema": {
              "type": "string",
              "default": "59908d02c7d013ce40de715a"
            },
            "required": true,
            "description": "Идентификатор интернет-магазина"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "contentId": {
                    "type": "string",
                    "description": "Идентификатор полученного контента через поисковую выдачу",
                    "default": "bb428f48-4470-4723-a3d1-d826238fd9e3"
                  },
                  "productId": {
                    "type": "integer",
                    "description": "Идентификатор товара (число / строка)",
                    "default": "453"
                  },
                  "link": {
                    "type": "object",
                    "description": "Указатель на посетителя - пара, состоящая из произвольных строки-ключа и строки-значения (например, ключ — \"сессия пользователя\", значение — \"идентификатор сессии\")",
                    "required": [
                      "name",
                      "value"
                    ],
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Название идентификатора посетителя",
                        "default": "session"
                      },
                      "value": {
                        "type": "string",
                        "description": "Значение идентификатора посетителя",
                        "default": "1b111eb597a528b654db611e"
                      }
                    },
                    "default": {
                      "name": "session",
                      "value": "1b111eb597a528b654db611e"
                    }
                  },
                  "timestamp": {
                    "type": "string",
                    "description": "Метка времени вызова",
                    "default": "2025-01-15T15:53:00+00:00"
                  }
                },
                "type": "object",
                "required": [
                  "contentId",
                  "productId",
                  "link",
                  "timestamp"
                ]
              }
            }
          }
        },
        "servers": [
          {
            "url": "https://apptracking.retailrocket.ru/2.0/"
          }
        ]
      }
    },
    "/smartSearch/contentViewed": {
      "post": {
        "tags": [
          "Search interaction"
        ],
        "x-internal": true,
        "summary": "Просмотр товара",
        "description": "Событие показа товаров в поисковой выдаче.",
        "operationId": "post_smartSearchcontentViewed",
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "parameters": [
          {
            "in": "query",
            "name": "apiKey",
            "schema": {
              "type": "string",
              "default": "5b333f5697a528b0184b6017"
            },
            "description": "Ключ авторизации",
            "required": true
          },
          {
            "in": "query",
            "name": "partnerId",
            "schema": {
              "type": "string",
              "default": "59908d02c7d013ce40de715a"
            },
            "description": "Идентификатор интернет-магазина",
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "contentId": {
                    "type": "string",
                    "description": "Идентификатор полученного контента через поисковую выдачу",
                    "default": "bb428f48-4470-4723-a3d1-d826238fd9e3"
                  },
                  "viewedProducts": {
                    "type": "array",
                    "description": "Массив показанных товаров",
                    "items": {
                      "properties": {
                        "productId": {
                          "type": "integer",
                          "description": "Идентификатор товара (число / строка)",
                          "default": "345"
                        },
                        "row": {
                          "type": "integer",
                          "description": "Номер строки показанного товара",
                          "default": "1"
                        },
                        "column": {
                          "type": "integer",
                          "description": "Номер столбца показанного товара",
                          "default": "2"
                        }
                      },
                      "type": "object",
                      "required": [
                        "productId",
                        "row",
                        "column"
                      ]
                    }
                  },
                  "link": {
                    "type": "object",
                    "description": "Указатель на посетителя - пара, состоящая из произвольных строки-ключа и строки-значения (например, ключ — \"сессия пользователя\", значение — \"идентификатор сессии\")",
                    "required": [
                      "name",
                      "value"
                    ],
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Название идентификатора посетителя",
                        "default": "session"
                      },
                      "value": {
                        "type": "string",
                        "description": "Значение идентификатора посетителя",
                        "default": "1b111eb597a528b654db611e"
                      }
                    },
                    "default": {
                      "name": "session",
                      "value": "1b111eb597a528b654db611e"
                    }
                  },
                  "timestamp": {
                    "type": "string",
                    "description": "Метка времени вызова",
                    "default": "2025-01-15T15:53:00+00:00"
                  }
                },
                "type": "object",
                "required": [
                  "contentId",
                  "viewedProducts",
                  "link",
                  "timestamp"
                ]
              }
            }
          }
        },
        "servers": [
          {
            "url": "https://apptracking.retailrocket.ru/2.0/"
          }
        ]
      }
    },
    "/smartSearch/redirected": {
      "post": {
        "tags": [
          "Search interaction"
        ],
        "summary": "Событие перехода",
        "x-internal": true,
        "description": "Событие произвольного перехода.",
        "operationId": "post_smartSearchredirected",
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "parameters": [
          {
            "in": "query",
            "name": "apiKey",
            "schema": {
              "type": "string",
              "default": "5b333f5697a528b0184b6017"
            },
            "description": "Ключ авторизации",
            "required": true
          },
          {
            "in": "query",
            "name": "partnerId",
            "schema": {
              "type": "string",
              "default": "59908d02c7d013ce40de715a"
            },
            "required": true,
            "description": "Идентификатор интернет-магазина"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "contentId": {
                    "type": "string",
                    "description": "Идентификатор полученного контента через поисковую выдачу",
                    "default": "bb428f48-4470-4723-a3d1-d826238fd9e3"
                  },
                  "redirectPhrase": {
                    "type": "string",
                    "default": "Сапоги",
                    "description": "Фраза, которую в поиске ввел пользователь"
                  },
                  "link": {
                    "type": "object",
                    "description": "Указатель на посетителя - пара, состоящая из произвольных строки-ключа и строки-значения (например, ключ — \"сессия пользователя\", значение — \"идентификатор сессии\")",
                    "required": [
                      "name",
                      "value"
                    ],
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Название идентификатора посетителя",
                        "default": "session"
                      },
                      "value": {
                        "type": "string",
                        "description": "Значение идентификатора посетителя",
                        "default": "1b111eb597a528b654db611e"
                      }
                    },
                    "default": {
                      "name": "session",
                      "value": "1b111eb597a528b654db611e"
                    }
                  },
                  "timestamp": {
                    "type": "string",
                    "default": "2025-01-15T15:53:00+00:00",
                    "description": "Метка времени вызова"
                  }
                },
                "type": "object",
                "required": [
                  "contentId",
                  "redirectPhrase",
                  "link",
                  "timestamp"
                ]
              }
            }
          }
        },
        "servers": [
          {
            "url": "https://apptracking.retailrocket.ru/2.0/"
          }
        ]
      }
    },
    "/smartSearch/categoryRedirected": {
      "post": {
        "tags": [
          "Search interaction"
        ],
        "summary": "Переход в товарную категорию",
        "description": "События перехода в товарную категорию.",
        "operationId": "post_smartSearchcategoryRedirected",
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "parameters": [
          {
            "in": "query",
            "name": "apiKey",
            "schema": {
              "type": "string",
              "default": "5b333f5697a528b0184b6017"
            },
            "description": "Ключ авторизации",
            "required": true
          },
          {
            "in": "query",
            "name": "partnerId",
            "schema": {
              "type": "string",
              "default": "59908d02c7d013ce40de715a"
            },
            "description": "",
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "contentId": {
                    "type": "string",
                    "description": "Идентификатор полученного контента через поисковую выдачу",
                    "default": "bb428f48-4470-4723-a3d1-d826238fd9e3"
                  },
                  "redirectPhrase": {
                    "type": "string",
                    "description": "Фраза, которую в поиске ввел пользователь",
                    "default": "Сапоги"
                  },
                  "redirectCategory": {
                    "type": "object",
                    "properties": {
                      "categoryPath": {
                        "type": "string",
                        "description": "Путь категории",
                        "default": "Женщины/Обувь/Сапоги"
                      },
                      "categoryId": {
                        "type": "integer",
                        "description": "Идентификатор категории",
                        "default": "45"
                      }
                    },
                    "description": "Категория, на которую был перенаправлен пользователь. Обязателен один из параметров, в зависимости от типа интеграции."
                  },
                  "link": {
                    "type": "object",
                    "description": "Указатель на посетителя - пара, состоящая из произвольных строки-ключа и строки-значения (например, ключ — \"сессия пользователя\", значение — \"идентификатор сессии\")",
                    "required": [
                      "name",
                      "value"
                    ],
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Название идентификатора посетителя",
                        "default": "session"
                      },
                      "value": {
                        "type": "string",
                        "description": "Значение идентификатора посетителя",
                        "default": "1b111eb597a528b654db611e"
                      }
                    },
                    "default": {
                      "name": "session",
                      "value": "1b111eb597a528b654db611e"
                    }
                  },
                  "timestamp": {
                    "type": "string",
                    "default": "2025-01-15T15:53:00+00:00",
                    "description": "Метка времени вызова"
                  }
                },
                "type": "object",
                "required": [
                  "contentId",
                  "redirectPhrase",
                  "redirectCategory",
                  "link",
                  "timestamp"
                ]
              }
            }
          }
        },
        "servers": [
          {
            "url": "https://apptracking.retailrocket.ru/2.0/"
          }
        ]
      }
    },
    "/smartSearch/suggestionClicked": {
      "post": {
        "tags": [
          "Search interaction"
        ],
        "summary": "Клик в подсказку в предпросмотре",
        "description": "Событие клика в подсказку для поисковой фразы.",
        "operationId": "post_smartSearchsuggestionClicked",
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "parameters": [
          {
            "in": "query",
            "name": "apiKey",
            "schema": {
              "type": "string",
              "default": "5b333f5697a528b0184b6017"
            },
            "description": "Ключ авторизации",
            "required": true
          },
          {
            "in": "query",
            "name": "partnerId",
            "schema": {
              "type": "string",
              "default": "59908d02c7d013ce40de715a"
            },
            "required": true,
            "description": "Идентификатор интернет-магазина"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "contentId": {
                    "type": "string",
                    "description": "Идентификатор полученного контента через поисковую выдачу",
                    "default": "bb428f48-4470-4723-a3d1-d826238fd9e3"
                  },
                  "suggestionPhrase": {
                    "type": "string",
                    "description": "Фраза, которую ввел пользователь в предпросмотре",
                    "default": "Обувь для женщин"
                  },
                  "link": {
                    "type": "object",
                    "description": "Указатель на посетителя - пара, состоящая из произвольных строки-ключа и строки-значения (например, ключ — \"сессия пользователя\", значение — \"идентификатор сессии\")",
                    "required": [
                      "name",
                      "value"
                    ],
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Название идентификатора посетителя",
                        "default": "session"
                      },
                      "value": {
                        "type": "string",
                        "description": "Значение идентификатора посетителя",
                        "default": "1b111eb597a528b654db611e"
                      }
                    },
                    "default": {
                      "name": "session",
                      "value": "1b111eb597a528b654db611e"
                    }
                  },
                  "timestamp": {
                    "type": "string",
                    "description": "Метка времени вызова",
                    "default": "2025-01-15T15:53:00+00:00"
                  }
                },
                "type": "object",
                "required": [
                  "contentId",
                  "suggestionPhrase",
                  "link",
                  "timestamp"
                ]
              }
            }
          }
        },
        "servers": [
          {
            "url": "https://apptracking.retailrocket.ru/2.0/"
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {}
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}