@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Shop
@base https://server.shop.app
@version v1.1
@endpoints 2
@toc openai(2)

@endpoint GET /openai/search
@desc Search for products
@optional {query: str # Query string to search for items., price_min: num # The minimum price to filter by., price_max: num # The maximum price to filter by., similar_to_id: str # A product ID that you want to find similar products for. (Only include one), num_results: str # How many results to return. Defaults to 5. It can be a number between 1 and 10., genders: str(male/female/unisex) # A comma-separated list of genders to filter by. Valid values are "male", "female", and "unisex"., colors: str(Beige/Black/Blue/Bronze/Brown/Clear/Gold/Gray/Green/Multicolor/Navy/Orange/Pink/Purple/Red/Rose gold/Silver/White/Yellow) # A comma-separated list of colors to filter by., sizes: str # A comma-separated list of sizes to filter by., categories: str # A comma-separated list of category IDs to filter by. A full list of categories and their IDs can be found at https://shopify.github.io/product-taxonomy/releases/latest/}
@returns(200) {results: [map]} # OK
@errors {503: Service Unavailable}

@endpoint GET /openai/details
@desc Return more details about a list of products.
@required {ids: str # A comma-separated list of product IDs}
@returns(200) {results: [map]} # OK
@errors {503: Service Unavailable}

@end