openapi: 3.0.1
info:
  title: Shulex Insight
  description: Provides global market insights and consumer insights to e-commerce enterprises, based on global merchandise data.
  version: 'v1'
servers:
  - url: https://insight.prod.voc.ai
paths:
  /chatgpt_plugin/competitor-lookup:
    get:
      operationId: queryListing
      summary: Analyze market situation.The value of market must be UK,US,DE,FR,JP,CA,IT or ES.Display title along with commodity's url together in markdown format.Display in a human-readable way.Do some analysis based on the returned data.
      parameters:
        - in: query
          name: market
          schema:
            type: string
          required: false
          description: market
        - in: query
          name: brand
          schema:
            type: string
          required: false
          description: brand
        - in: query
          name: keyword
          schema:
            type: string
          required: false
          description: keyword
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commodityList'

components:
  schemas:
    commodityList:
      type: array
      items:
        type: object
        properties:
          id:
            type: string
            description: The commodity's id on amazon.
          title:
            type: string
            description: The commodity's title on amazon.
          amazonUrl:
            type: string
            description: The commodity's url which doesn't support the OpenGraph protocol.
          price:
            type: number
            description: The commodity's price.
          units:
            type: integer
            description: Sales of the commodity.
          unitsGr:
            type: string
            description: The monthly growth rate of the commodity.
          revenue:
            type: number
            description: Monthly sales of the commodity.
          bsrInfo:
            type: string
            description: Some bsr information of the commodity.