Skip to content

armgit / Orkas

Public Imported from GitHub
0

Orkas is an open-source (MIT), local-first AI team for your desktop: a Commander turns your goal into to-dos and coordinates 16 built-in specialist agents plus Claude Code, Codex, OpenCode, OpenClaw and Hermes, with projects, scheduled automations and connectors. Free app for macOS & Windows; built-in models or your own keys.

18.4 KB
Raw Blame
'use strict';
// Generated by scripts/generate-base-shop-api-contracts.cjs; do not edit.
module.exports={"methods":{"base.categories":{"path":"/categories","method":"GET","scope":"read_items","risk":"R","description":"Read all shop categories.","input_schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/categories/"},"base.categories.add":{"path":"/categories/add","method":"POST","scope":"write_items","risk":"H","description":"Create a category under an optional parent number. No automatic retry; inspect the shop after an uncertain response.","input_schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":65536,"description":"Category name."},"list_order":{"type":"integer","minimum":0,"maximum":9007199254740991},"parent_number":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["name"],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/categories/add"},"base.categories.delete":{"path":"/categories/delete","method":"POST","scope":"write_items","risk":"D","description":"Delete a category. No automatic retry; inspect the shop after an uncertain response.","input_schema":{"type":"object","properties":{"category_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."}},"required":["category_id"],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/categories/delete"},"base.categories.edit":{"path":"/categories/edit","method":"POST","scope":"write_items","risk":"H","description":"Update a category name or position. No automatic retry; inspect the shop after an uncertain response.","input_schema":{"type":"object","properties":{"category_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."},"name":{"type":"string","minLength":1,"maxLength":65536,"description":"Category name."},"list_order":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["category_id"],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/categories/edit"},"base.delivery_companies":{"path":"/delivery_companies","method":"GET","scope":"なし","risk":"R","description":"Read supported delivery companies.","input_schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/delivery_companies/"},"base.item_categories.add":{"path":"/item_categories/add","method":"POST","scope":"write_items","risk":"H","description":"Add a product category assignment. No automatic retry; inspect the shop after an uncertain response.","input_schema":{"type":"object","properties":{"item_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."},"category_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."}},"required":["item_id"],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/item_categories/add"},"base.item_categories.delete":{"path":"/item_categories/delete","method":"POST","scope":"write_items","risk":"D","description":"Delete a product category assignment. No automatic retry; inspect the shop after an uncertain response.","input_schema":{"type":"object","properties":{"item_category_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."}},"required":["item_category_id"],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/item_categories/delete"},"base.item_categories.detail":{"path":"/item_categories/detail/:item_id","method":"GET","scope":"read_items","risk":"R","description":"Read category assignments for a product.","input_schema":{"type":"object","properties":{"item_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."}},"required":["item_id"],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/item_categories/detail"},"base.items":{"path":"/items","method":"GET","scope":"read_items","risk":"R","description":"Read one page of products with visibility, image and category filters.","input_schema":{"type":"object","properties":{"visible":{"enum":[0,1]},"order":{"enum":["list_order","created","modified"]},"sort":{"enum":["asc","desc"]},"limit":{"type":"integer","minimum":1,"maximum":100,"default":20},"offset":{"type":"integer","minimum":0,"maximum":9007199254740991,"default":0},"max_image_no":{"type":"integer","minimum":1,"maximum":20},"image_size":{"type":"string","minLength":0,"maxLength":65536,"description":"Comma-separated image sizes.","pattern":"^(origin|76|146|300|500|640|sp_480|sp_640)(,(origin|76|146|300|500|640|sp_480|sp_640))*$"},"category_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."}},"required":[],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/items/"},"base.items.add":{"path":"/items/add","method":"POST","scope":"write_items","risk":"H","description":"Create a product with ordered variations. Daily creation limit: 1000. Never automatically retry an uncertain creation. No automatic retry; inspect the shop after an uncertain response.","input_schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":65536,"description":"Product title; the API rejects four-byte Unicode characters."},"detail":{"type":"string","minLength":0,"maxLength":65536,"description":"Product description; the API rejects four-byte Unicode characters."},"price":{"type":"integer","minimum":0,"maximum":9007199254740991},"item_tax_type":{"enum":[1,2]},"stock":{"type":"integer","minimum":0,"maximum":9007199254740991},"visible":{"enum":[0,1]},"identifier":{"type":"string","minLength":0,"maxLength":65536,"description":"Merchant product code; ASCII and full-width spaces are not supported.","pattern":"^[^ \\u3000]*$"},"list_order":{"type":"integer","minimum":0,"maximum":9007199254740991},"variation":{"type":"array","items":{"type":"string","minLength":0,"maxLength":65536,"description":"Variation value in corresponding array order."},"minItems":1,"maxItems":10,"description":"Host high-impact/destructive operation limit: 10 variation entries per call."},"variation_stock":{"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991},"minItems":1,"maxItems":10,"description":"Host high-impact/destructive operation limit: 10 variation entries per call."},"variation_identifier":{"type":"array","items":{"type":"string","minLength":0,"maxLength":65536,"description":"Variation value in corresponding array order."},"minItems":1,"maxItems":10,"description":"Host high-impact/destructive operation limit: 10 variation entries per call."},"barcode":{"type":"array","items":{"type":"string","minLength":0,"maxLength":65536,"description":"Variation value in corresponding array order."},"minItems":1,"maxItems":10,"description":"Host high-impact/destructive operation limit: 10 variation entries per call."}},"required":["title","price","stock"],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/items/add"},"base.items.add_image":{"path":"/items/add_image","method":"POST","scope":"write_items","risk":"H","description":"Attach a product image from its public URL; image transformations are asynchronous. No automatic retry; inspect the shop after an uncertain response.","input_schema":{"type":"object","properties":{"item_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."},"image_no":{"type":"integer","minimum":1,"maximum":20},"image_url":{"type":"string","minLength":1,"maxLength":8192,"description":"Public jpg/png/gif URL, image at most 4 MB. Resized images are generated asynchronously.","pattern":"^https?://"}},"required":["item_id","image_no","image_url"],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/items/add_image"},"base.items.delete":{"path":"/items/delete","method":"POST","scope":"write_items","risk":"D","description":"Delete a product. No automatic retry; inspect the shop after an uncertain response.","input_schema":{"type":"object","properties":{"item_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."}},"required":["item_id"],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/items/delete"},"base.items.delete_image":{"path":"/items/delete_image","method":"POST","scope":"write_items","risk":"D","description":"Delete one product image. No automatic retry; inspect the shop after an uncertain response.","input_schema":{"type":"object","properties":{"item_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."},"image_no":{"type":"integer","minimum":1,"maximum":20}},"required":["item_id","image_no"],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/items/delete_image"},"base.items.delete_variation":{"path":"/items/delete_variation","method":"POST","scope":"write_items","risk":"D","description":"Delete one product variation. No automatic retry; inspect the shop after an uncertain response.","input_schema":{"type":"object","properties":{"item_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."},"variation_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."}},"required":["item_id","variation_id"],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/items/delete_variation"},"base.items.detail":{"path":"/items/detail/:item_id","method":"GET","scope":"read_items","risk":"R","description":"Read a product with variations and options.","input_schema":{"type":"object","properties":{"item_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."}},"required":["item_id"],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/items/detail"},"base.items.edit":{"path":"/items/edit","method":"POST","scope":"write_items","risk":"H","description":"Update a product. Empty variation IDs add variations; omitted variations are retained. All existing IDs reorder variations; a partial list does not. No automatic retry; inspect the shop after an uncertain response.","input_schema":{"type":"object","properties":{"item_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."},"title":{"type":"string","minLength":1,"maxLength":65536,"description":"Product title; the API rejects four-byte Unicode characters."},"detail":{"type":"string","minLength":0,"maxLength":65536,"description":"Product description; the API rejects four-byte Unicode characters."},"price":{"type":"integer","minimum":0,"maximum":9007199254740991},"item_tax_type":{"enum":[1,2]},"stock":{"type":"integer","minimum":0,"maximum":9007199254740991},"visible":{"enum":[0,1]},"list_order":{"type":"integer","minimum":0,"maximum":9007199254740991},"identifier":{"type":"string","minLength":0,"maxLength":65536,"description":"Merchant product code; ASCII and full-width spaces are not supported.","pattern":"^[^ \\u3000]*$"},"variation_id":{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."},{"const":""}]},"minItems":1,"maxItems":10,"description":"Host high-impact/destructive operation limit: 10 variation entries per call."},"variation":{"type":"array","items":{"type":"string","minLength":0,"maxLength":65536,"description":"Variation value in corresponding array order."},"minItems":1,"maxItems":10,"description":"Host high-impact/destructive operation limit: 10 variation entries per call."},"variation_stock":{"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991},"minItems":1,"maxItems":10,"description":"Host high-impact/destructive operation limit: 10 variation entries per call."},"variation_identifier":{"type":"array","items":{"type":"string","minLength":0,"maxLength":65536,"description":"Variation value in corresponding array order."},"minItems":1,"maxItems":10,"description":"Host high-impact/destructive operation limit: 10 variation entries per call."},"barcode":{"type":"array","items":{"type":"string","minLength":0,"maxLength":65536,"description":"Variation value in corresponding array order."},"minItems":1,"maxItems":10,"description":"Host high-impact/destructive operation limit: 10 variation entries per call."}},"required":["item_id"],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/items/edit"},"base.items.edit_stock":{"path":"/items/edit_stock","method":"POST","scope":"write_items","risk":"H","description":"Replace product or variation stock after checking current variations. No automatic retry; inspect the shop after an uncertain response.","input_schema":{"type":"object","properties":{"item_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."},"stock":{"type":"integer","minimum":0,"maximum":9007199254740991},"variation_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"string","minLength":1,"maxLength":128,"pattern":"^[1-9][0-9]*$"}],"description":"Exact positive identifier; use a decimal string for integers larger than JavaScript safe range."},"variation_stock":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["item_id"],"additionalProperties":false,"oneOf":[{"required":["stock"],"not":{"anyOf":[{"required":["variation_id"]},{"required":["variation_stock"]}]}},{"required":["variation_id","variation_stock"],"not":{"required":["stock"]}}]},"source_url":"https://docs.thebase.in/api/items/edit_stock"},"base.items.search":{"path":"/items/search","method":"GET","scope":"read_items","risk":"R","description":"Search products in this shop; index updates can take up to one hour.","input_schema":{"type":"object","properties":{"q":{"type":"string","minLength":1,"maxLength":65536,"description":"Search this shop; space-separated keywords. Search indexing can lag by up to one hour."},"fields":{"type":"string","minLength":0,"maxLength":65536,"description":"Comma-separated search fields.","pattern":"^(title|detail|categories|shop_name)(,(title|detail|categories|shop_name))*$"},"order":{"enum":["list_order","modified"]},"sort":{"enum":["asc","desc"]},"limit":{"type":"integer","minimum":1,"maximum":100,"default":10},"offset":{"type":"integer","minimum":0,"maximum":10000}},"required":["q"],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/items/search"},"base.orders":{"path":"/orders","method":"GET","scope":"read_orders","risk":"R","description":"Read one page of orders including buyer and payment business fields.","input_schema":{"type":"object","properties":{"start_ordered":{"type":"string","minLength":0,"maxLength":65536,"description":"Inclusive order start date or local date-time.","pattern":"^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}:\\d{2})?$"},"end_ordered":{"type":"string","minLength":0,"maxLength":65536,"description":"Inclusive order end date or local date-time.","pattern":"^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}:\\d{2})?$"},"limit":{"type":"integer","minimum":1,"maximum":100,"default":20},"offset":{"type":"integer","minimum":0,"maximum":9007199254740991,"default":0}},"required":[],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/orders/"},"base.orders.detail":{"path":"/orders/detail/:unique_key","method":"GET","scope":"read_orders","risk":"R","description":"Read one complete order with buyer contact, shipping, payment and item details.","input_schema":{"type":"object","properties":{"unique_key":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_-]+$"}},"required":["unique_key"],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/orders/detail"},"base.users.me":{"path":"/users/me","method":"GET","scope":"read_users (メールアドレスも取得したい場合はread_users_mail)","risk":"R","description":"Read the connected BASE shop profile.","input_schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"source_url":"https://docs.thebase.in/api/users/me"}}};