{"openapi":"3.1.0","info":{"title":"Merchant store api","version":"0.2.2"},"servers":[{"url":"/merchant"}],"paths":{"/v1/health":{"get":{"summary":"Health Check","description":"Checks the health of a project.\n\nIt returns 200 if the project is healthy.","operationId":"health_check_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/public-probe":{"get":{"summary":"Public Probe","description":"Used for public health probes.","operationId":"public_probe_v1_public_probe_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/products/reset-collection":{"delete":{"tags":["Product"],"summary":"Deletes All Products From Collection","description":"Deletes all products from the Weaviate product.","operationId":"Deletes_all_products_from_collection_v1_products_reset_collection_delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"dry_run","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Dry Run"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/products/collection-exists":{"get":{"tags":["Product"],"summary":"Check If Product Collection Exists.","description":"Returns true if product collection exists else return false","operationId":"Check_if_product_collection_exists__v1_products_collection_exists_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/products/collection":{"post":{"tags":["Product"],"summary":"Create Product Collection","description":"Creates product collection/schema in Weaviate database","operationId":"Create_Product_Collection_v1_products_collection_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"delete_existing_collection","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Delete Existing Collection"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Product"],"summary":"Delete Product Collection","description":"Delete product collection","operationId":"Delete_Product_Collection_v1_products_collection_delete","security":[{"APIKeyHeader":[]}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Delete Product Collection V1 Products Collection Delete"}}}}}}},"/v1/products/by-internal-id/{internal_id}":{"delete":{"tags":["Product"],"summary":"Delete Product By Internal Id","description":"Delete product by internal_id","operationId":"Delete_Product_by_internal_id_v1_products_by_internal_id__internal_id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"internal_id","in":"path","required":true,"schema":{"type":"integer","title":"Internal Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Delete Product By Internal Id V1 Products By Internal Id  Internal Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/products/item-group/{item_group_id}":{"delete":{"tags":["Product"],"summary":"Delete Product By Item Group Id","description":"Delete product by item_group_id","operationId":"delete_product_by_item_group_id","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"item_group_id","in":"path","required":true,"schema":{"type":"string","title":"Item Group Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Delete Product By Item Group Id"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/products":{"get":{"tags":["Product"],"summary":"Get All Products","description":"Returns All Products. If collection has a large number of products, response may take long time","operationId":"Get_All_Products_v1_products_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Product"},"type":"array","title":"Response Get All Products V1 Products Get"}}}}},"security":[{"APIKeyHeader":[]}]},"post":{"tags":["Product"],"summary":"Import Multiple Products","description":"Import multiple products. If a product already exist, it is update. Otherwise new product is created","operationId":"Import_Multiple_Products_v1_products_post","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Product"},"type":"array","title":"Products"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{},"type":"array","title":"Response Import Multiple Products V1 Products Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/products/{sku}":{"get":{"tags":["Product"],"summary":"Get Product By Sku","description":"Get Product by SKU","operationId":"Get_product_by_SKU_v1_products__sku__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"sku","in":"path","required":true,"schema":{"type":"string","title":"Sku"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Product"],"summary":"Create Product By Sku","description":"Create Product by SKU","operationId":"Create_Product_by_SKU_v1_products__sku__post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"sku","in":"path","required":true,"schema":{"type":"string","title":"Sku"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Product"],"summary":"Update Product By Sku","description":"Update Product By SKU","operationId":"Update_Product_by_SKU_v1_products__sku__put","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"sku","in":"path","required":true,"schema":{"type":"string","title":"Sku"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Product"],"summary":"Delete Product By Sku","description":"Delete product by SKU","operationId":"Delete_Product_by_SKU_v1_products__sku__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"sku","in":"path","required":true,"schema":{"type":"string","title":"Sku"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Delete Product By Sku V1 Products  Sku  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/faqs/reset-collection":{"delete":{"tags":["Faq"],"summary":"Deletes All Faq From Collection","description":"Deletes all FAQ from collection.","operationId":"Deletes_all_FAQ_from_collection_v1_faqs_reset_collection_delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"dry_run","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Dry Run"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/faqs/collection-exists":{"get":{"tags":["Faq"],"summary":"Check If Faq Collection Exists.","description":"Returns true if FAQ collection exists else return false","operationId":"Check_if_FAQ_collection_exists__v1_faqs_collection_exists_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/faqs/collection":{"post":{"tags":["Faq"],"summary":"Create Faq Collection","description":"Creates FAQ collection/schema in Weaviate database","operationId":"Create_FAQ_Collection_v1_faqs_collection_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"delete_existing_collection","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Delete Existing Collection"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Faq"],"summary":"Delete Faq Collection","description":"Delete FAQ collection","operationId":"Delete_FAQ_Collection_v1_faqs_collection_delete","security":[{"APIKeyHeader":[]}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Delete Faq Collection V1 Faqs Collection Delete"}}}}}}},"/v1/faqs/by-internal-id/{internal_id}":{"delete":{"tags":["Faq"],"summary":"Delete Faq By Internal Id","description":"Delete FAQ by internal_id","operationId":"Delete_FAQ_by_internal_id_v1_faqs_by_internal_id__internal_id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"internal_id","in":"path","required":true,"schema":{"type":"integer","title":"Internal Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Delete Faq By Internal Id V1 Faqs By Internal Id  Internal Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/faqs":{"get":{"tags":["Faq"],"summary":"Get All Faqs","description":"Returns All FAQs. If collection has a large number of FAQs\n                response may take long time","operationId":"Get_All_FAQs_v1_faqs_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Faq"},"type":"array","title":"Response Get All Faqs V1 Faqs Get"}}}}},"security":[{"APIKeyHeader":[]}]},"post":{"tags":["Faq"],"summary":"Import Multiple Faqs","description":"Import multiple FAQs. If a FAQ same question already exist, it is updated. Otherwise new FAQ is created","operationId":"Import_Multiple_FAQs_v1_faqs_post","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Faq"},"type":"array","title":"Faqs"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Faq"},"type":"array","title":"Response Import Multiple Faqs V1 Faqs Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/faqs/{question}":{"get":{"tags":["Faq"],"summary":"Get Faq By Question","description":"Get FAQ by question","operationId":"Get_FAQ_by_question_v1_faqs__question__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"question","in":"path","required":true,"schema":{"type":"string","title":"Question"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Faq"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Faq"],"summary":"Create Faq By Question","description":"Create FAQ by question","operationId":"Create_FAQ_by_question_v1_faqs__question__post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"question","in":"path","required":true,"schema":{"type":"string","title":"Question"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Faq"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Faq"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Faq"],"summary":"Update Faq By Question","description":"Update FAQ By question","operationId":"Update_FAQ_by_question_v1_faqs__question__put","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"question","in":"path","required":true,"schema":{"type":"string","title":"Question"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Faq"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Faq"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Faq"],"summary":"Delete Faq By Question","description":"Delete FAQ by question","operationId":"Delete_FAQ_by_question_v1_faqs__question__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"question","in":"path","required":true,"schema":{"type":"string","title":"Question"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Delete Faq By Question V1 Faqs  Question  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Faq":{"properties":{"uuid":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Uuid"},"question":{"type":"string","title":"Question"},"answer":{"type":"string","title":"Answer"},"text":{"type":"string","title":"Text"},"internal_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Internal Id","default":0}},"type":"object","required":["question","answer","text"],"title":"Faq"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Product":{"properties":{"uuid":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Uuid"},"sku":{"type":"string","title":"Sku"},"sku_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku Id"},"product_category":{"type":"string","title":"Product Category","default":""},"product_category_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Category Path"},"internal_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Internal Id","default":0},"availability":{"$ref":"#/components/schemas/ProductAvailability"},"price":{"type":"number","title":"Price","default":0},"sale_price":{"type":"number","title":"Sale Price","default":0},"currency":{"type":"string","title":"Currency"},"item_group_id":{"type":"string","title":"Item Group Id","default":""},"rrp":{"type":"number","title":"Rrp","default":0},"product_status":{"type":"string","title":"Product Status","default":""},"title":{"type":"string","title":"Title","default":""},"description":{"type":"string","title":"Description","default":""},"gender":{"type":"string","title":"Gender","default":""},"image_link":{"type":"string","title":"Image Link","default":""},"material":{"type":"string","title":"Material","default":""},"pattern":{"type":"string","title":"Pattern","default":""},"product_weight":{"type":"number","title":"Product Weight","default":0},"size":{"type":"string","title":"Size","default":""},"color":{"type":"string","title":"Color","default":""},"occasion":{"type":"string","title":"Occasion","default":""},"style":{"type":"string","title":"Style","default":""},"special_offer":{"type":"string","title":"Special Offer","default":""},"collection":{"type":"string","title":"Collection","default":""},"system_link":{"type":"string","title":"System Link","default":""},"link":{"type":"string","title":"Link","default":""},"brand":{"type":"string","title":"Brand","default":""},"model":{"type":"string","title":"Model","default":""},"gtin":{"type":"string","title":"Gtin","default":""},"condition":{"type":"string","title":"Condition","default":""},"adult":{"type":"string","title":"Adult","default":""},"summary_review":{"type":"string","title":"Summary Review","default":""},"average_rating":{"type":"number","title":"Average Rating","default":0}},"type":"object","required":["sku","availability","currency"],"title":"Product"},"ProductAvailability":{"type":"string","enum":["in_stock","out_of_stock"],"title":"ProductAvailability"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key"}}}}