{"note":"OpenAPI conversion -- returning structured metadata","name":"brainbi-net","description":"brainbi","version":"unknown","base_url":"","endpoints":33,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api brainbi\n@auth ApiKey Authorization in header\n@endpoints 33\n@hint download_for_search\n@toc api(33)\n\n@endpoint GET /api/rule\n@desc This resource lists all pricing rules that are currently saved in you account\n@optional {: str}\n\n@endpoint GET /api/rule/1\n@desc This resource returns a specific rule {id}\n\n@endpoint POST /api/rule\n@desc To update a product, please use the listed attributes listed underneath\n@optional {product_id: str # The ID of the product you want this monitor to be linked to. Can be left empty if no link to a product is needed.  This needs to be the ID of brainbi and not your internal id (store_remote_id) (optional), name: str # A recognisable name., scrape_url: str # The URL of the product, type: str # Set to \"AI\" if this is ruke should be handled by our AI. Otherwise leave blank and provide the DOM-element with the scrape_selector. (optional), scrape_selector: str # The DOM-Selector for the price (you need to set this if you leave type blank).}\n\n@endpoint GET /api/rule/ruleData/1\n@desc This resource lists all data that wa saved for pricing rules\n@optional {: str}\n\n@endpoint GET /api/rule/ruleData/1/latest\n@desc This resource lists only the latest data point that wa saved for a pricing rule\n@optional {: str}\n\n@endpoint GET /api/products\n@desc This resource lists all products that are currently saved in you account\n@optional {: str}\n\n@endpoint GET /api/products/1\n@desc This resource returns a specific product {id}\n\n@endpoint GET /api/products/23767/rules\n@desc This resource returns all available rules for a product {id}\n\n@endpoint POST /api/products\n@desc To update a product, please use the listed attributes listed underneath\n@required {status: str # The status of your product as text., store_remote_id: str # Your internal ID of this product. Mostly the ID from your shop or ERP system., store_remote_variant_id: str # Your ID if there are more than one variant of the product., name: str, vendor: str, price: str # Your selling price., cost_price: str # The cost that you pay., shipping: str # Shipping cost, url: str, ean_upc: str, category_id: str, category_name: str}\n\n@endpoint GET /api/analyze/pricing\n@desc To update a product, please use the listed attributes listed underneath\n@required {status: str # The status of your product as text., store_remote_id: str # Your internal ID of this product. Mostly the ID from your shop or ERP system., store_remote_variant_id: str # Your ID if there are more than one variant of the product., name: str, vendor: str, price: str # Your selling price., cost_price: str # The cost that you pay., shipping: str # Shipping cost, url: str, ean_upc: str, category_id: str, category_name: str}\n@optional {url: str}\n\n@endpoint GET /api/analyze/pricing\n@desc To update a product, please use the listed attributes listed underneath\n@required {status: str # The status of your product as text., store_remote_id: str # Your internal ID of this product. Mostly the ID from your shop or ERP system., store_remote_variant_id: str # Your ID if there are more than one variant of the product., name: str, vendor: str, price: str # Your selling price., cost_price: str # The cost that you pay., shipping: str # Shipping cost, url: str, ean_upc: str, category_id: str, category_name: str}\n@optional {url: str}\n\n@endpoint PUT /api/products\n@desc To update a product, please use the listed attributes listed underneath\n@required {status: str # The status of your product as text., store_remote_id: str # Your internal ID of this product. Mostly the ID from your shop or ERP system., store_remote_variant_id: str # Your ID if there are more than one variant of the product., name: str, vendor: str, price: str # Your selling price., cost_price: str # The cost that you pay., shipping: str # Shipping cost, url: str, ean_upc: str, category_id: str, category_name: str}\n\n@endpoint DELETE /api/products/1137\n@desc Products\n@optional {: str}\n\n@endpoint GET /api/customers\n@desc This resource lists all cusomters that are currently saved in your account\n@optional {: str}\n\n@endpoint GET /api/customers/1\n@desc This resource returns a specific customer {id}\n\n@endpoint POST /api/customers\n@desc To update a customer, please use the listed attributes listed underneath\n@required {store_remote_id: str # This is your internal id of this order. You need to provide this, so you can later match your orders wit our analytics., status: str, currency: str, country: str, sub_total: str, shipping: str, total: str, created_at: str}\n\n@endpoint PUT /api/customers/1137\n@desc Customers\n@required {store_remote_id: str # This is your internal id of this order. You need to provide this, so you can later match your orders wit our analytics., status: str, currency: str, country: str, sub_total: str, shipping: str, total: str, created_at: str}\n\n@endpoint DELETE /api/customers/1137\n@desc Customers\n\n@endpoint GET /api/orders\n@desc This resource lists all orders that are currently saved in your account\n@optional {: str}\n\n@endpoint GET /api/orders/12\n@desc This resource returns a specific order {id}\n\n@endpoint POST /api/orders\n@desc To update a order, please use the listed attributes listed underneath\n@required {store_remote_id: str # This is your internal id of this order. You need to provide this, so you can later match your orders wit our analytics., status: str, currency: str, country: str, sub_total: str, shipping: str, total: str, created_at: str}\n\n@endpoint PUT /api/orders/1137\n@desc Orders\n@required {store_remote_id: str # This is your internal id of this order. You need to provide this, so you can later match your orders wit our analytics., status: str, currency: str, country: str, sub_total: str, shipping: str, total: str, created_at: str}\n\n@endpoint DELETE /api/orders/1137\n@desc Orders\n@optional {: str}\n\n@endpoint GET /api/orderlines\n@desc This resource lists all order lines that are currently saved in your account\n\n@endpoint GET /api/orderlines/123\n@desc This resource returns a specific order line {id}\n\n@endpoint POST /api/orderlines\n@desc To update a order line, please use the listed attributes listed underneath\n@required {store_remote_id: str # This is your internal id of this order. You need to provide this, so you can later match your orders wit our analytics., status: str, currency: str, country: str, sub_total: str, shipping: str, total: str, created_at: str}\n\n@endpoint PUT /api/orderlines/1137\n@desc OrderLines\n@required {store_remote_id: str # This is your internal id of this order. You need to provide this, so you can later match your orders wit our analytics., status: str, currency: str, country: str, sub_total: str, shipping: str, total: str, created_at: str}\n\n@endpoint DELETE /api/orderlines/1137\n@desc OrderLines\n\n@endpoint GET /api/seo/ranking/latest\n@desc This resource lists all pricing rules that are currently saved in you account\n@optional {: str}\n\n@endpoint POST /api/login\n@desc Use this endpoint to make the initial call with your email and password (same as on brainbi\n@optional {email: str # The same email you use for our platform., password: str # The password email you use for our platform.}\n\n@endpoint POST /api/register\n@desc Use this endpoint to make the initial call with your email and password (same as on brainbi\n@optional {first_name: str # required, last_name: str # required, company_name: str # required, shop_url: str # required, email: str # required, store_name: str # required, store_url: str # required, password: str # required, fromuser: str # required (always 1)}\n\n@endpoint POST /api/register_woocommerce\n@desc Use this endpoint to make the initial call with your email and password (same as on brainbi\n@optional {first_name: str # required, last_name: str # required, company_name: str # required, shop_url: str # required, email: str # required, store_name: str # required, store_url: str # required, password: str # required, fromuser: str # required (always 1), api_url: str # required, consumer_key: str # required, consumer_secret: str # required}\n\n@endpoint POST /api/logout\n@desc Once you are done, call this endpoint to lock your account!\n@optional {email: str # The same email you use for our platform.}\n\n@end\n"}