Servidor MCP
Obriym CRM
com.obriym-crm/mcp
Qué hace este MCP
Manages CRM records, sales pipelines, activities, orders, products, inventory, and marketplace catalog operations.
Capacidades
Herramientas
52
herramientas
add_order_item
Add order item
Add a line item to an existing order by its externalId. Recomputes the order total. Use list_orders or create_order for the order externalId, and search_products to quote a real product. The result echoes the operating workspace.
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['productName', 'quantity', 'unitPrice', 'externalId'], 'properties': {'sku': {'type': 'string', 'maxLength': 120, 'description': 'Product SKU snapshot (from search_products). Optional.'}, 'discount': {'type': 'number', 'default': 0, 'maximum': 100, 'minimum': 0, 'description': 'Percentage discount on this line (0-100). Default 0.'}, 'quantity': {'type': 'integer', 'maximum': 9007199254740991, 'description': 'Quantity ordered (integer, at least 1).', 'exclusiveMinimum': 0}, 'unitPrice': {'anyOf': [{'type': 'string', 'pattern': '^\\d+(\\.\\d{1,2})?$'}, {'type': 'number', 'minimum': 0}], 'description': 'Price per unit in the order currency, as a decimal (e.g. 199.99). Snapshotted onto the line.'}, 'externalId': {'type': 'string', 'minLength': 1, 'description': 'The order externalId returned by list_orders or create_order.'}, 'productName': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': "Line item name, snapshotted onto the order. Use search_products to quote a real catalog product's name. Required."}}, 'additionalProperties': False}
adjust_stock
Adjust stock
Move a product stock by a relative delta (negative to write off, positive to add) with a reason, and record it in the stock history. This is the correct tool for a correction, a write-off or damage â it never sets an absolute number, so an order committing at the same moment is not overwritten. The reason decides the direction: write_off, damage and return_to_supplier must carry a negative delta, opening_balance a positive one, while correction and other accept either; a delta that contradicts its reason is rejected. Any other word is your own vocabulary and is accepted in either direction. The product must already track inventory; a product that does not returns a conflict rather than having tracking switched on for it. Pass a stable externalId to make a retry idempotent. The new stock is pushed to every connected sales channel. The result echoes the operating workspace.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['delta', 'productId', 'reason'], 'properties': {'note': {'type': 'string', 'maxLength': 1000, 'minLength': 1}, 'delta': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, 'reason': {'type': 'string', 'maxLength': 120, 'minLength': 1}, 'metadata': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}, 'productId': {'type': 'string', 'minLength': 1}, 'externalId': {'type': 'string', 'maxLength': 160, 'minLength': 1}}, 'additionalProperties': False}
assign_lead
Assign lead
Assign a lead to a workspace member by user id, or pass assignedTo=null to unassign. Use search_leads to find the lead id and get_workspace_info to confirm the operating workspace. The result echoes the operating workspace.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['assignedTo', 'id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The lead id returned by search_leads.'}, 'assignedTo': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}], 'description': 'User id of the workspace member to assign the lead to. Pass null to unassign.'}}, 'additionalProperties': False}
check_channel_readiness
Check channel readiness
Check locally which products a marketplace will refuse and why â missing price, unusable price, blank name, unmapped category â grouped by what fixes them, without calling the marketplace. The response separates `blocked` (these products do NOT go out) from `warnings` (these DO go out, but probably will not be published as the merchant expects: a price in a currency the platform does not name, no words of their own in a language the channel reads, a placeholder description, characteristics the marketplace does not recognise). Available for prom and rozetka; other platforms report their connection state through get_marketplace instead. This never publishes anything: it reports what would happen.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['platform'], 'properties': {'platform': {'type': 'string', 'minLength': 1, 'description': 'The marketplace slug returned by list_marketplaces (prom, rozetka, olx, amazon, ebay, shopify, woocommerce).'}}}
complete_activity
Complete activity
Mark an activity (task, call, or meeting) as completed by its id. Use list_activities first to find the activity id. The result echoes the operating workspace.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The activity id returned by list_activities.'}}}
configure_pipeline
Configure pipeline stage
Update an existing pipeline stage's name, default probability, or WIP limit. Provide the stage id (from list_pipeline_stages) and the fields to change. Stage order and terminal behavior are fixed. The result echoes the operating workspace.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id', 'patch'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The pipeline stage id returned by list_pipeline_stages.'}, 'patch': {'type': 'object', 'required': ['defaultProbability', 'name'], 'properties': {'name': {'type': 'string', 'maxLength': 120, 'minLength': 1, 'description': 'Display name of the pipeline stage.'}, 'wipLimit': {'anyOf': [{'type': 'integer', 'maximum': 999, 'minimum': 1}, {'type': 'null'}], 'description': 'Work-in-progress limit (max deals allowed in the stage). Null or omit for no limit.'}, 'defaultProbability': {'type': 'integer', 'maximum': 100, 'minimum': 0, 'description': 'Default win probability for deals in this stage, 0-100.'}}, 'description': 'Pipeline stage fields to update: name, default probability, WIP limit or position.', 'additionalProperties': False}}}
convert_lead
Convert lead
Convert a lead into a contact, company, and/or deal (select at least one via the input flags). Sets the lead status to converted. Use search_leads first to find the lead id. The result echoes the operating workspace.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id', 'input'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The lead id returned by search_leads.'}, 'input': {'type': 'object', 'properties': {'dealTitle': {'type': 'string', 'maxLength': 255, 'description': 'Title for the created deal. Required when createDeal is true.'}, 'createDeal': {'type': 'boolean', 'default': False, 'description': 'Create an open pipeline deal from the lead. Default false.'}, 'dealAmount': {'type': 'string', 'pattern': '^\\d+(\\.\\d{1,2})?$', 'description': 'Deal amount, as a decimal string. Used when createDeal is true.'}, 'companyName': {'type': 'string', 'maxLength': 255, 'description': 'Name for the company to create. Required when createCompany is true.'}, 'createCompany': {'type': 'boolean', 'default': False, 'description': 'Create (or link) a company from the lead. Default false.'}, 'createContact': {'type': 'boolean', 'default': False, 'description': 'Create (or link) a contact from the lead. Default false.'}, 'contactLastName': {'type': 'string', 'maxLength': 120, 'description': 'Last name for the contact to create. Optional.'}, 'contactFirstName': {'type': 'string', 'maxLength': 120, 'description': 'First name for the contact to create. Required when createContact is true.'}, 'dealNextActionDate': {'type': 'string', 'format': 'date-time', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$', 'description': 'ISO 8601 next-action date for the created deal. Used when createDeal is true.'}, 'dealNextActionNote': {'type': 'string', 'maxLength': 500, 'description': 'Next-action note for the created deal. Used when createDeal is true.'}}, 'description': 'Conversion options that decide whether to create/link contact, company and deal records.', 'additionalProperties': False}}}
create_activity
Create activity
Create an activity (task, call, meeting, email, or note). Must link to at least one lead, contact, company, or deal â use search_leads/search_contacts/search_companies/search_deals to get the entity id. The result echoes the operating workspace.
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['title', 'type'], 'properties': {'type': {'enum': ['task', 'call', 'meeting', 'email', 'note'], 'type': 'string', 'description': 'Activity type. One of: task, call, meeting, email, note.'}, 'title': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'Short title of the activity. Required.'}, 'dealId': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}], 'description': 'Deal id to link the activity to (from search_deals). Link at least one entity.'}, 'leadId': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}], 'description': 'Lead id to link the activity to (from search_leads). Link at least one entity.'}, 'dueDate': {'anyOf': [{'type': 'string', 'format': 'date-time', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$'}, {'type': 'null'}], 'description': 'Due date/time, ISO 8601. Optional.'}, 'priority': {'enum': ['low', 'medium', 'high'], 'type': 'string', 'description': 'Priority. Optional. One of: low, medium, high.'}, 'companyId': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}], 'description': 'Company id to link the activity to (from search_companies). Link at least one entity.'}, 'contactId': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}], 'description': 'Contact id to link the activity to (from search_contacts). Link at least one entity.'}, 'assignedTo': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}], 'description': 'User id of the workspace member to assign the activity to; null/omit for unassigned.'}, 'description': {'anyOf': [{'type': 'string', 'maxLength': 5000, 'description': 'Detailed description or notes. Optional.'}, {'type': 'null'}], 'description': 'Detailed description or notes. Optional.'}, 'recurrenceRule': {'anyOf': [{'enum': ['daily', 'weekly', 'monthly'], 'type': 'string', 'description': 'Recurrence rule: daily, weekly, or monthly. Optional (one-off if omitted).'}, {'type': 'null'}], 'description': 'Recurrence rule: daily, weekly, or monthly. Optional (one-off if omitted).'}, 'recurrenceEndsAt': {'anyOf': [{'type': 'string', 'format': 'date-time', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$'}, {'type': 'null'}], 'description': 'When recurrence stops, ISO 8601. Optional; only meaningful with recurrenceRule.'}}, 'additionalProperties': False}
create_company
Create company
Create a company (B2B account). The company name must be unique in the workspace. Enforces the workspace plan limit; the result echoes the operating workspace. Use search_companies first to avoid creating a duplicate.
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['name'], 'properties': {'name': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'The company name. Required and unique within the workspace.'}, 'size': {'enum': ['solo', 'small', 'medium', 'large', 'enterprise'], 'type': 'string', 'description': 'Company size band. Optional. One of: solo, small, medium, large, enterprise.'}, 'status': {'enum': ['prospect', 'active', 'inactive'], 'type': 'string', 'description': 'Relationship status. Optional. One of: prospect, active, inactive.'}, 'ownerId': {'anyOf': [{'type': 'string', 'description': 'User id of the workspace member who owns this company. Optional.'}, {'type': 'null'}], 'description': 'User id of the workspace member who owns this company. Optional.'}, 'website': {'anyOf': [{'type': 'string', 'format': 'uri', 'maxLength': 255, 'description': 'The company website URL. Optional.'}, {'type': 'null'}], 'description': 'The company website URL. Optional.'}, 'industry': {'anyOf': [{'type': 'string', 'maxLength': 120, 'description': "The company's industry. Optional."}, {'type': 'null'}], 'description': "The company's industry. Optional."}}, 'additionalProperties': False}
create_contact
Create contact
Create a contact (person). Use search_companies for the companyId to link an employer. Enforces the workspace plan limit and validates the company/owner links; the result echoes the operating workspace.
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['firstName'], 'properties': {'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80}, 'default': [], 'description': 'Tags for segmentation. Optional.'}, 'email': {'anyOf': [{'type': 'string', 'format': 'email', 'pattern': "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", 'maxLength': 255, 'description': "The contact's email address. Optional."}, {'type': 'null'}], 'description': "The contact's email address. Optional."}, 'phone': {'anyOf': [{'type': 'string', 'maxLength': 50, 'description': "The contact's phone number. Optional."}, {'type': 'null'}], 'description': "The contact's phone number. Optional."}, 'ownerId': {'anyOf': [{'type': 'string', 'description': 'User id of the workspace member who owns this contact. Optional.'}, {'type': 'null'}], 'description': 'User id of the workspace member who owns this contact. Optional.'}, 'jobTitle': {'anyOf': [{'type': 'string', 'maxLength': 160, 'description': "The contact's job title. Optional."}, {'type': 'null'}], 'description': "The contact's job title. Optional."}, 'lastName': {'anyOf': [{'type': 'string', 'maxLength': 120, 'description': "The contact's last name. Optional."}, {'type': 'null'}], 'description': "The contact's last name. Optional."}, 'companyId': {'anyOf': [{'type': 'string', 'description': 'Company id to link this contact to (from search_companies). Optional.'}, {'type': 'null'}], 'description': 'Company id to link this contact to (from search_companies). Optional.'}, 'firstName': {'type': 'string', 'maxLength': 120, 'minLength': 1, 'description': "The contact's first name. Required."}}, 'additionalProperties': False}
create_deal
Create deal
Create a pipeline deal. Requires a stageId, title, and next-action note. Use list_pipeline_stages for the stageId, and search_companies/search_contacts to link a company or contact. Enforces the workspace plan limit; the result echoes the operating workspace.
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['nextActionDate', 'nextActionNote', 'stageId', 'title'], 'properties': {'notes': {'anyOf': [{'type': 'string', 'maxLength': 5000, 'description': 'Free-text notes on the deal. Optional.'}, {'type': 'null'}], 'description': 'Free-text notes on the deal. Optional.'}, 'title': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'Deal title. Required.'}, 'amount': {'type': 'string', 'pattern': '^\\d+(\\.\\d{1,2})?$', 'description': 'Deal value as a decimal string, e.g. 1500.00. Optional.'}, 'ownerId': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}], 'description': 'User id of the workspace member to own the deal; null/omit for none.'}, 'stageId': {'type': 'string', 'description': 'Pipeline stage id for the deal (from list_pipeline_stages). Required.'}, 'companyId': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}], 'description': 'Company id to link the deal to (from search_companies); null/omit for none.'}, 'contactId': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}], 'description': 'Contact id to link the deal to (from search_contacts); null/omit for none.'}, 'lostReason': {'anyOf': [{'type': 'string', 'maxLength': 500, 'description': 'Reason the deal was lost. Required only when moving to a Closed-lost stage.'}, {'type': 'null'}], 'description': 'Reason the deal was lost. Optional (required only for Closed-lost stages).'}, 'probability': {'type': 'integer', 'maximum': 100, 'minimum': 0, 'description': 'Win probability percent, 0-100. Optional (defaults from the stage).'}, 'nextActionDate': {'type': 'string', 'format': 'date-time', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$', 'description': 'Next-action date, ISO 8601. Required.'}, 'nextActionNote': {'type': 'string', 'maxLength': 500, 'minLength': 1, 'description': 'What the next action on this deal is. Required.'}, 'expectedCloseDate': {'anyOf': [{'type': 'string', 'format': 'date-time', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$'}, {'type': 'null'}], 'description': 'Expected close date, ISO 8601. Optional.'}}, 'additionalProperties': False}
create_lead
Create lead
Create a lead. Idempotent by externalId (re-sending the same externalId returns the existing lead). Requires an email or phone. Enforces the workspace plan limit; the result echoes the workspace it landed in. Use update_lead to change it afterward.
Idempotente
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['externalId', 'name'], 'properties': {'name': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': "The lead's full name or label. Required."}, 'email': {'type': 'string', 'format': 'email', 'pattern': "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", 'maxLength': 255, 'description': "The lead's email. Provide email or phone (at least one)."}, 'notes': {'type': 'string', 'maxLength': 2000, 'description': 'Free-text notes about the lead. Optional.'}, 'phone': {'type': 'string', 'maxLength': 50, 'description': "The lead's phone number. Provide email or phone (at least one)."}, 'source': {'type': 'string', 'const': 'website', 'default': 'website', 'description': 'Lead source; fixed to "website" for MCP-created leads.'}, 'externalId': {'type': 'string', 'maxLength': 160, 'minLength': 1, 'description': "A stable unique id for this lead in your system â\x80\x94 the idempotency key. Re-sending the same externalId returns the existing lead instead of creating a duplicate (e.g. 'mcp-<uuid>')."}, 'companyName': {'type': 'string', 'maxLength': 255, 'description': "The lead's company name, if known. Optional."}}, 'additionalProperties': False}
create_order
Create order
Create an order with line items. Idempotent by externalId â use a stable unique id such as 'mcp-<uuid>' (re-sending returns the existing order). Enforces the workspace plan limit; the result echoes the operating workspace. Items snapshot productName/sku/unitPrice; use search_products first to quote real products.
Idempotente
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['externalId', 'items'], 'properties': {'items': {'type': 'array', 'items': {'type': 'object', 'required': ['productName', 'quantity', 'unitPrice'], 'properties': {'sku': {'type': 'string', 'maxLength': 120, 'description': 'Product SKU snapshot (from search_products). Optional.'}, 'discount': {'type': 'number', 'default': 0, 'maximum': 100, 'minimum': 0, 'description': 'Percentage discount on this line (0-100). Default 0.'}, 'quantity': {'type': 'integer', 'maximum': 9007199254740991, 'description': 'Quantity ordered (integer, at least 1).', 'exclusiveMinimum': 0}, 'unitPrice': {'anyOf': [{'type': 'string', 'pattern': '^\\d+(\\.\\d{1,2})?$'}, {'type': 'number', 'minimum': 0}], 'description': 'Price per unit in the order currency, as a decimal (e.g. 199.99). Snapshotted onto the line.'}, 'productName': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': "Line item name, snapshotted onto the order. Use search_products to quote a real catalog product's name. Required."}}, 'additionalProperties': False}, 'maxItems': 100, 'minItems': 1, 'description': 'Order line items (1-100). Each snapshots productName/sku/unitPrice.'}, 'notes': {'type': 'string', 'maxLength': 5000, 'description': 'Internal note stored on the order. For a delivery instruction from the buyer use delivery.comment instead.'}, 'currency': {'type': 'string', 'default': 'UAH', 'pattern': '^[A-Z]{3}$', 'maxLength': 3, 'minLength': 3, 'description': 'ISO 4217 currency code for the order (uppercase, e.g. UAH). Default UAH.'}, 'customer': {'type': 'object', 'properties': {'email': {'type': 'string', 'format': 'email', 'pattern': "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", 'maxLength': 255}, 'phone': {'type': 'string', 'maxLength': 50, 'minLength': 1}, 'lastName': {'type': 'string', 'maxLength': 120, 'minLength': 1}, 'firstName': {'type': 'string', 'maxLength': 120, 'minLength': 1}, 'externalId': {'type': 'string', 'maxLength': 160, 'minLength': 1}, 'shippingAddress': {'type': 'object', 'required': ['city', 'country', 'line1'], 'properties': {'city': {'type': 'string', 'maxLength': 120, 'minLength': 1}, 'line1': {'type': 'string', 'maxLength': 255, 'minLength': 1}, 'line2': {'type': 'string', 'maxLength': 255, 'minLength': 1}, 'region': {'type': 'string', 'maxLength': 120, 'minLength': 1}, 'country': {'type': 'string', 'maxLength': 2, 'minLength': 2}, 'postalCode': {'type': 'string', 'maxLength': 32, 'minLength': 1}}, 'additionalProperties': False}}, 'description': 'Optional buyer snapshot (name/email/phone, or a storefront customer externalId). Omit for an anonymous order.', 'additionalProperties': False}, 'delivery': {'type': 'object', 'properties': {'cod': {'type': 'boolean', 'description': 'True when the buyer pays on delivery (cash on delivery).'}, 'flat': {'type': 'string', 'maxLength': 35, 'description': 'Apartment or office number for courier delivery.'}, 'phone': {'type': 'string', 'maxLength': 50, 'description': "Recipient phone, when it differs from the buyer's own contact phone."}, 'branch': {'type': 'string', 'maxLength': 200, 'description': 'Branch or parcel locker as the buyer named it, e.g. "вÑ\x96ддÑ\x96леннÑ\x8f â\x84\x965" or "поÑ\x88Ñ\x82омаÑ\x82 12345". Free text: the CRM resolves it against the live branch list of the carrier when creating a waybill.'}, 'method': {'enum': ['branch', 'courier', 'pickup'], 'type': 'string', 'description': 'How the parcel reaches the buyer: "branch" (carrier office/locker), "courier" (to the address) or "pickup" (buyer collects from you).'}, 'carrier': {'type': 'string', 'maxLength': 120, 'description': 'Carrier slug the buyer chose, from GET /capabilities (e.g. "nova_poshta", "ukrposhta", "pickup"). This is a preference, not a dispatch â\x80\x94 the shipment endpoint still records what actually ships.'}, 'cityRef': {'type': 'string', 'maxLength': 64, 'description': "The carrier's own identifier for the destination city, as returned by GET /api/v1/carriers/{carrier}/cities. Required alongside branchRef or streetRef for a waybill to be created from the order alone."}, 'comment': {'type': 'string', 'maxLength': 1000, 'description': 'Delivery note from the buyer, e.g. "дзвониÑ\x82и пÑ\x96Ñ\x81лÑ\x8f 18:00". Not the order notes.'}, 'building': {'type': 'string', 'maxLength': 35, 'description': 'House number for courier delivery, structured rather than inside the address line because carriers validate it on its own (Nova Poshta accepts up to 11 characters matching digits plus an optional Cyrillic letter or block, e.g. "12Ð\x91" or "12/4").'}, 'branchRef': {'type': 'string', 'maxLength': 64, 'description': "The carrier's own identifier for the branch or parcel locker, as returned by GET /api/v1/carriers/{carrier}/warehouses. The same value the shipment-label endpoint calls warehouseRef. Sent, this removes all guessing; omitted, the CRM falls back to matching `branch` as text."}, 'streetRef': {'type': 'string', 'maxLength': 64, 'description': "The carrier's own identifier for the street, as returned by GET /api/v1/carriers/{carrier}/streets. Courier delivery only; pair it with `building`."}, 'recipientName': {'type': 'string', 'maxLength': 200, 'description': 'Who receives the parcel, when that is not the buyer (a gift, an office).'}}, 'description': "How the buyer asked to receive the order: carrier, branch/courier/pickup, branch text, recipient, cash-on-delivery and a delivery note. This is the buyer's choice at checkout â\x80\x94 it does not dispatch anything. Record what actually ships with POST /orders/{externalId}/shipments.", 'additionalProperties': False}, 'promoCode': {'type': 'string', 'maxLength': 64, 'description': "The promo code the storefront applied to this order, recorded as-is. The CRM never validates or computes it â\x80\x94 the cart owns that â\x80\x94 but storing it is what makes 'did that campaign pay for itself?' answerable later."}, 'externalId': {'type': 'string', 'maxLength': 160, 'minLength': 1, 'description': "A stable unique id for this order in your system â\x80\x94 the idempotency key. Re-sending the same externalId returns the existing order instead of creating a duplicate (e.g. 'mcp-<uuid>')."}, 'discountAmount': {'type': 'number', 'minimum': 0, 'description': 'Money taken off by the promo code, in the order currency. A sum, not a percent: a percent at order level is ambiguous (before or after line discounts, with shipping or without). Does NOT change total â\x80\x94 send the total the buyer actually paid.'}}, 'additionalProperties': False}
create_product
Create product
Create a catalog product. Defaults to draft status â publish it by sending status 'active' once it is complete. Use list_categories, list_brands and list_warehouses for the ids; SKU is generated when omitted and must be unique in the workspace. Set trackInventory with an opening stock to start counting units, which is recorded as the first movement in the product stock history. If the target warehouse is set to list new products on the marketplaces, this product joins those channels. When productGroupId names an existing product model, the product joins that model as a new article and takes the model's shared content (name, description, category, brand, characteristics, translations) instead of the values sent. Enforces the workspace plan limit; the result echoes the operating workspace.
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['name'], 'properties': {'ean': {'anyOf': [{'type': 'string', 'pattern': '^[0-9]{8,14}$'}, {'type': 'null'}], 'example': '4006381333931', 'description': 'GTIN/EAN-8/12/13/14 barcode. Presence-and-shape validation only, no checksum.'}, 'sku': {'anyOf': [{'type': 'string', 'maxLength': 120, 'minLength': 1}, {'type': 'null'}]}, 'name': {'type': 'string', 'maxLength': 255, 'minLength': 1}, 'size': {'anyOf': [{'type': 'string', 'maxLength': 60, 'minLength': 1}, {'type': 'null'}]}, 'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'default': []}, 'type': {'enum': ['simple', 'bundle'], 'type': 'string', 'default': 'simple'}, 'unit': {'anyOf': [{'type': 'string', 'maxLength': 40, 'minLength': 1}, {'type': 'null'}]}, 'color': {'anyOf': [{'type': 'string', 'maxLength': 80, 'minLength': 1}, {'type': 'null'}]}, 'depth': {'anyOf': [{'anyOf': [{'type': 'number'}, {'type': 'string', 'minLength': 1}]}, {'type': 'null'}]}, 'price': {'anyOf': [{'anyOf': [{'type': 'number'}, {'type': 'string', 'minLength': 1}]}, {'type': 'null'}]}, 'stock': {'anyOf': [{'type': 'integer', 'maximum': 9007199254740991, 'minimum': 0}, {'type': 'null'}]}, 'width': {'anyOf': [{'anyOf': [{'type': 'number'}, {'type': 'string', 'minLength': 1}]}, {'type': 'null'}]}, 'gender': {'anyOf': [{'enum': ['male', 'female', 'unisex'], 'type': 'string'}, {'type': 'null'}]}, 'height': {'anyOf': [{'anyOf': [{'type': 'number'}, {'type': 'string', 'minLength': 1}]}, {'type': 'null'}]}, 'images': {'type': 'array', 'items': {'type': 'object', 'required': ['url'], 'properties': {'url': {'type': 'string', 'format': 'uri'}, 'name': {'type': 'string', 'maxLength': 255, 'minLength': 1}, 'size': {'type': 'integer', 'maximum': 9007199254740991, 'exclusiveMinimum': 0}, 'pathname': {'type': 'string', 'minLength': 1}, 'uploadedAt': {'type': 'string', 'format': 'date-time', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$'}, 'contentType': {'enum': ['image/jpeg', 'image/png', 'image/webp'], 'type': 'string'}}, 'additionalProperties': False}, 'maxItems': 10}, 'status': {'enum': ['draft', 'active', 'archived'], 'type': 'string', 'default': 'draft'}, 'videos': {'type': 'array', 'items': {'type': 'object', 'required': ['url'], 'properties': {'url': {'type': 'string', 'format': 'uri'}}}, 'default': [], 'example': [{'url': 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'}], 'maxItems': 5, 'description': 'Video links for the product page (YouTube, Vimeo or a direct file), https only, at most 5. Links, not uploads. On update, sending the field replaces the whole list.'}, 'weight': {'anyOf': [{'anyOf': [{'type': 'number'}, {'type': 'string', 'minLength': 1}]}, {'type': 'null'}]}, 'brandId': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}]}, 'pattern': {'anyOf': [{'type': 'string', 'maxLength': 80, 'minLength': 1}, {'type': 'null'}]}, 'ageGroup': {'anyOf': [{'enum': ['newborn', 'infant', 'toddler', 'kids', 'adult'], 'type': 'string'}, {'type': 'null'}]}, 'material': {'anyOf': [{'type': 'string', 'maxLength': 120, 'minLength': 1}, {'type': 'null'}]}, 'sizeType': {'anyOf': [{'type': 'string', 'maxLength': 40, 'minLength': 1}, {'type': 'null'}]}, 'condition': {'anyOf': [{'enum': ['new', 'used', 'refurbished'], 'type': 'string'}, {'type': 'null'}]}, 'costPrice': {'anyOf': [{'anyOf': [{'type': 'number'}, {'type': 'string', 'minLength': 1}]}, {'type': 'null'}]}, 'categoryId': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}]}, 'sizeSystem': {'anyOf': [{'enum': ['AU', 'BR', 'CN', 'DE', 'EU', 'FR', 'IT', 'JP', 'MEX', 'UK', 'US'], 'type': 'string'}, {'type': 'null'}]}, 'supplierId': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}]}, 'weightUnit': {'anyOf': [{'enum': ['kg', 'g', 'lb', 'oz'], 'type': 'string'}, {'type': 'null'}]}, 'bundleItems': {'type': 'array', 'items': {'type': 'object', 'required': ['productId', 'quantity'], 'properties': {'quantity': {'type': 'integer', 'maximum': 9007199254740991, 'exclusiveMinimum': 0}, 'productId': {'type': 'string', 'maxLength': 160, 'minLength': 1}}, 'additionalProperties': False}, 'default': []}, 'description': {'anyOf': [{'type': 'string', 'maxLength': 2000}, {'type': 'null'}]}, 'warehouseId': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}]}, 'costCurrency': {'anyOf': [{'type': 'string', 'pattern': '^[A-Z]{3}$'}, {'type': 'null'}]}, 'dimensionUnit': {'anyOf': [{'enum': ['cm', 'mm', 'in'], 'type': 'string'}, {'type': 'null'}]}, 'compareAtPrice': {'anyOf': [{'anyOf': [{'type': 'number'}, {'type': 'string', 'minLength': 1}]}, {'type': 'null'}]}, 'productGroupId': {'anyOf': [{'type': 'string', 'maxLength': 120, 'minLength': 1}, {'type': 'null'}]}, 'trackInventory': {'type': 'boolean', 'default': False}}, 'additionalProperties': False}
get_activity
Get activity
Fetch one CRM activity in the selected workspace by activity id, including type, due date, completion state, assignee and linked entity. Use list_activities first when you only know the related lead/deal/contact.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The activity id returned by list_activities.'}}}
get_company
Get company
Fetch one CRM company in the selected workspace by company id, including status, industry, owner and contact links when present. Use search_companies first when you only know the company name.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The company id returned by search_companies.'}}}
get_contact
Get contact
Fetch one CRM contact in the selected workspace by contact id, including company, owner, tags and communication fields when present. Use search_contacts first when you only know a name, email or phone.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The contact id returned by search_contacts.'}}}
get_customer
Get customer
Fetch one CRM customer summary in the selected workspace by company id, including health, lifetime value and won-deal metrics. Use list_customers first when you only know the company name.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['companyId'], 'properties': {'companyId': {'type': 'string', 'minLength': 1, 'description': 'The company/customer id returned by list_customers.'}}}
get_dashboard_overview
Get dashboard overview
Return the operational 'what needs attention today' snapshot for this workspace: active/qualified/stale lead counts, pipeline value, weighted forecast and overdue activities. Takes no arguments. Use get_report for period trend analytics instead.
Solo lectura
Esquema de entrada
{'type': 'object', 'properties': {}}
get_deal
Get deal
Fetch one pipeline deal in the selected workspace by deal id, including stage, value, probability and linked company/contact data when present. Use search_deals first when you only know the title or related customer.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The deal id returned by search_deals.'}}}
get_lead
Get lead
Fetch one CRM lead in the selected workspace by lead id, including status, source, assignee, tags, custom fields, score, notes and next action. Use search_leads first when you only know a name, email, phone or company.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The lead id returned by search_leads.'}}}
get_marketplace
Get marketplace
Fetch one connected marketplace in detail: every adapter on it with its setup state, last poll, last poll error, last catalog-sync outcome and last product import, plus the channel sales, leads and product counts. Use list_marketplaces first to see which platforms are connected. Use list_channel_products for the products on the channel and check_channel_readiness for what would be refused.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['platform'], 'properties': {'platform': {'type': 'string', 'minLength': 1, 'description': 'The marketplace slug returned by list_marketplaces (prom, rozetka, olx, amazon, ebay, shopify, woocommerce).'}}}
get_order
Get order
Fetch full order detail in the selected workspace by externalId, including line items, payments, shipments and returns. Use list_orders first when you only know the customer or date.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['externalId'], 'properties': {'externalId': {'type': 'string', 'minLength': 1, 'description': 'The order externalId returned by list_orders.'}}}
get_product
Get product
Fetch one catalog product in the selected workspace by product id or SKU â returned in any status (draft, active, or archived; check the status field), including price, stock, category and brand fields. Provide exactly one known identifier; use search_products first when unsure (search covers active products only).
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The product id returned by search_products.'}, 'sku': {'type': 'string', 'minLength': 1, 'description': 'The product SKU returned by search_products.'}}}
get_report
Get report
Return one aggregated analytics report over a period for this workspace, selected by the report parameter: lead_source_conversion, pipeline_velocity, team_performance, or revenue_trend. Each returns aggregated rows (no per-record data); days tunes the look-back for conversion/team reports and months the span for revenue_trend. Use get_dashboard_overview for today's operational snapshot instead.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['report'], 'properties': {'days': {'anyOf': [{'type': 'number', 'const': 30}, {'type': 'number', 'const': 90}, {'type': 'number', 'const': 365}], 'description': 'Look-back window for conversion/team reports (default 90/30).'}, 'months': {'type': 'integer', 'maximum': 24, 'minimum': 1, 'description': 'Number of months for the revenue-trend report (default 6).'}, 'report': {'enum': ['lead_source_conversion', 'pipeline_velocity', 'team_performance', 'revenue_trend', 'product_sales', 'stock_valuation'], 'type': 'string', 'description': 'Which analytics report to return. lead_source_conversion: leads and conversion rate per source (uses days). pipeline_velocity: average time deals spend in each stage. team_performance: revenue and activity per member (uses days). revenue_trend: won revenue by month (uses months). product_sales: units, revenue and gross margin per brand, category and SKU, plus a trend (uses days). stock_valuation: units on hand and their value at weighted-average cost, per warehouse and per cost currency â\x80\x94 currencies are reported separately and never added together (takes no period).'}}}
get_workspace_info
Get workspace info
Show which account and workspace this connection operates: signed-in name/email (OAuth only), workspace name, plan, connection type, and granted scopes. Call this when the user asks 'which account or workspace am I connected to?'. Sign-in connections can use list_workspaces and select_workspace to see or change the bound workspace.
Solo lectura
Esquema de entrada
{'type': 'object', 'properties': {}}
list_activities
List activities
List this workspace's activities (tasks, calls, meetings, emails, notes), filtered by type/assignee/overdue/completion/linked-entity and paginated. Returns summary rows (id, type, title, priority, dueDate, completed, assignee, linked lead/contact/company/deal, isOverdue) plus pagination { page, perPage, total }. Use get_activity to fetch one activity's full detail by id.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'q': {'type': 'string', 'maxLength': 255, 'description': 'Free-text search over the activity title. Omit for no text filter.'}, 'page': {'type': 'integer', 'default': 1, 'maximum': 9007199254740991, 'description': '1-based page number of results to return. Default 1.', 'exclusiveMinimum': 0}, 'type': {'enum': ['task', 'call', 'meeting', 'email', 'note'], 'type': 'string', 'description': 'Filter by activity type. Omit for any. Allowed: task, call, meeting, email, note.'}, 'dealId': {'type': 'string', 'description': 'Filter to activities linked to this deal id (from search_deals).'}, 'leadId': {'type': 'string', 'description': 'Filter to activities linked to this lead id (from search_leads).'}, 'overdue': {'enum': ['true', 'false'], 'type': 'string', 'description': 'Set "true" to return only overdue activities (past due date, not completed).'}, 'perPage': {'type': 'integer', 'default': 20, 'maximum': 100, 'minimum': 1, 'description': 'Number of activities per page (1-100). Default 20.'}, 'companyId': {'type': 'string', 'description': 'Filter to activities linked to this company id (from search_companies).'}, 'completed': {'enum': ['true', 'false'], 'type': 'string', 'description': 'Filter by completion: "true" only completed, "false" only open. Omit for both.'}, 'contactId': {'type': 'string', 'description': 'Filter to activities linked to this contact id (from search_contacts).'}, 'assignedTo': {'type': 'string', 'maxLength': 160, 'minLength': 1, 'description': "Filter to activities assigned to this workspace member's user id."}}, 'additionalProperties': False}
list_brands
List brands
List this workspace catalog brands with id, name, description and website. Use a brand id here as the brandId for create_product/update_product, or as the search_products brand filter.
Solo lectura
Esquema de entrada
{'type': 'object', 'properties': {}}
list_categories
List categories
List this workspace catalog categories as a flat array, each with id, name, slug and parentId (null for a root category). Categories are workspace-global, not per warehouse. Use a category id here as the categoryId for create_product/update_product, or as the search_products category filter.
Solo lectura
Esquema de entrada
{'type': 'object', 'properties': {}}
list_channel_products
List channel products
List the products that are on one marketplace, with each listing external id, what the marketplace last reported about it (`presence`, valid only when `observedAt` is set â null `observedAt` means the marketplace has never been asked about that listing, not that it is absent; Prom is reconciled every 15 minutes, other channels only when a sync or publish runs), whether the workspace paused syncing it, its price and stock. Also returns the honest totals over the whole channel and the ACTIVE products that have no listing there at all (the 'did not match by SKU' list), which is usually the answer when a push updated fewer products than expected. Use check_channel_readiness for why a product would be refused.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['platform'], 'properties': {'platform': {'type': 'string', 'minLength': 1, 'description': 'The marketplace slug returned by list_marketplaces (prom, rozetka, olx, amazon, ebay, shopify, woocommerce).'}}}
list_customers
List customers
List CRM customers (companies with a won deal or delivered order), filtered by health/lifetime-value/won-deal count, sorted and paginated. Returns summary rows (companyId, name, health, lifetimeValue, wonDeals, lastActivity, owner) plus pagination { page, perPage, total }. Use get_customer to fetch one customer's detail by company id.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'q': {'type': 'string', 'maxLength': 255, 'description': 'Free-text search over the customer company name. Omit for no text filter.'}, 'ltv': {'enum': ['lt10k', '10k50k', 'gt50k'], 'type': 'string', 'description': 'Filter by lifetime-value bucket. Omit for any. Allowed: lt10k, 10k50k, gt50k.'}, 'page': {'type': 'integer', 'default': 1, 'maximum': 9007199254740991, 'description': '1-based page number of results to return. Default 1.', 'exclusiveMinimum': 0}, 'health': {'enum': ['healthy', 'at_risk', 'churned'], 'type': 'string', 'description': 'Filter by customer health. Omit for any. Allowed: healthy, at_risk, churned.'}, 'ownerId': {'type': 'string', 'maxLength': 160, 'minLength': 1, 'description': "Filter to customers owned by this workspace member's user id."}, 'perPage': {'type': 'integer', 'default': 25, 'maximum': 100, 'minimum': 1, 'description': 'Number of customers per page (1-100). Default 25.'}, 'sortDir': {'enum': ['asc', 'desc'], 'type': 'string', 'default': 'desc', 'description': 'Sort direction by lifetime value. Default desc (highest first).'}, 'wonDealsMin': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': 1, 'description': 'Only customers with at least this many won deals.'}}, 'additionalProperties': False}
list_lead_sources
List lead sources
List this workspace's lead sources (built-in plus custom), with each source's key, label and active state. Pass includeInactive to also return archived sources. Use set_lead_sources to add or archive a source; use a source key here as the source filter for search_leads.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'includeInactive': {'type': 'boolean', 'description': 'Set true to include archived/inactive lead sources.'}}}
list_marketplaces
List marketplaces
List every marketplace connected to this workspace with its setup state, health, last activity, any current sync error, orders revenue per currency, leads, product counts on the channel and how many imported products are waiting to be reviewed. Answers 'which channels do I sell on and is anything broken'. Takes no arguments. Use get_marketplace for one channel in detail, list_channel_products for what is on it, and check_channel_readiness for what it will refuse.
Solo lectura
Esquema de entrada
{'type': 'object', 'properties': {}}
list_orders
List orders
List this workspace's orders, filtered by status/customer/created-date and paginated. Returns summary rows (externalId, status, currency, totalAmount, itemCount, timestamps) plus pagination { page, perPage, total }, newest first. Use get_order to fetch one order's full detail (line items, payments, shipments, returns) by externalId.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'to': {'type': 'string', 'format': 'date-time', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$', 'description': 'Only orders created at or before this ISO 8601 timestamp (e.g. 2026-02-28T23:59:59Z).'}, 'from': {'type': 'string', 'format': 'date-time', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$', 'description': 'Only orders created at or after this ISO 8601 timestamp (e.g. 2026-01-31T00:00:00Z).'}, 'page': {'type': 'integer', 'default': 1, 'maximum': 9007199254740991, 'minimum': 1, 'description': '1-based page number of results to return. Default 1.'}, 'status': {'enum': ['pending', 'confirmed', 'processing', 'shipped', 'delivered', 'cancelled', 'refunded'], 'type': 'string', 'description': 'Filter by order status. Omit to return every status. Allowed: pending, confirmed, processing, shipped, delivered, cancelled, refunded.'}, 'perPage': {'type': 'integer', 'default': 20, 'maximum': 100, 'minimum': 1, 'description': 'Number of results per page (1-100). Default 20.'}, 'customerExternalId': {'type': 'string', 'maxLength': 160, 'minLength': 1, 'description': "Filter to one storefront customer by their externalId (the id from the source system). Omit to list all customers' orders."}}}
list_pipeline_stages
List pipeline stages
List this workspace's pipeline stages in order, with each stage's id, name, kind, default probability, WIP limit and position. Use configure_pipeline to change a stage, and the stage id here as the stageId for create_deal / transition_deal.
Solo lectura
Esquema de entrada
{'type': 'object', 'properties': {}}
list_warehouses
List warehouses
List this workspace warehouses with id, name, address and phone. A product lives in at most one warehouse, and the warehouse decides the inventory-tracking default and which sales channels new products are listed on. Use a warehouse id here as the warehouseId for create_product.
Solo lectura
Esquema de entrada
{'type': 'object', 'properties': {}}
list_workspaces
List workspaces
List every workspace the connected user belongs to (id, name, role) and mark which one this connection currently operates. OAuth sign-in connections only. Use select_workspace to switch.
Solo lectura
Esquema de entrada
{'type': 'object', 'properties': {}}
remove_order_item
Remove order item
Remove a line item from an order. Recomputes the order total. Use get_order to find the order's externalId and the item's itemId. The result echoes the operating workspace.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['externalId', 'itemId'], 'properties': {'itemId': {'type': 'string', 'minLength': 1, 'description': 'The order item id returned by get_order.'}, 'externalId': {'type': 'string', 'minLength': 1, 'description': 'The order externalId returned by list_orders or create_order.'}}}
search_companies
Search companies
List and search this workspace's companies, filtered by industry/status/owner, sorted and paginated. Returns summary rows (id, name, industry, size, status, owner, contactCount) plus pagination { page, perPage, total }. Use get_company to fetch one company's full detail by id.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'q': {'type': 'string', 'maxLength': 255, 'description': 'Free-text search over the company name. Omit for no text filter.'}, 'page': {'type': 'integer', 'default': 1, 'maximum': 9007199254740991, 'description': '1-based page number of results to return. Default 1.', 'exclusiveMinimum': 0}, 'status': {'enum': ['prospect', 'active', 'inactive'], 'type': 'string', 'description': 'Filter by relationship status. Omit for any. Allowed: prospect, active, inactive.'}, 'ownerId': {'type': 'string', 'maxLength': 160, 'minLength': 1, 'description': "Filter to companies owned by this workspace member's user id."}, 'perPage': {'type': 'integer', 'default': 25, 'maximum': 100, 'minimum': 1, 'description': 'Number of companies per page (1-100). Default 25.'}, 'sortDir': {'enum': ['asc', 'desc'], 'type': 'string', 'default': 'asc', 'description': 'Sort direction by name. Default asc.'}, 'industry': {'type': 'string', 'maxLength': 120, 'minLength': 1, 'description': 'Filter to companies in this industry. Omit for any industry.'}}, 'additionalProperties': False}
search_contacts
Search contacts
List and search this workspace's contacts, filtered by company/owner/tag, sorted and paginated. Returns summary rows (id, firstName, lastName, email, phone, jobTitle, company, owner, tags) plus pagination { page, perPage, total }. Use get_contact to fetch one contact's full detail by id.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'q': {'type': 'string', 'maxLength': 255, 'description': 'Free-text search over name, email and company. Omit for no text filter.'}, 'tag': {'type': 'string', 'maxLength': 80, 'minLength': 1, 'description': 'Filter to contacts carrying this tag. Omit for any tag.'}, 'page': {'type': 'integer', 'default': 1, 'maximum': 9007199254740991, 'description': '1-based page number of results to return. Default 1.', 'exclusiveMinimum': 0}, 'sortBy': {'enum': ['name', 'email', 'createdAt'], 'type': 'string', 'default': 'name', 'description': 'Field to sort by. Default name. Allowed: name, email, createdAt.'}, 'ownerId': {'type': 'string', 'maxLength': 160, 'minLength': 1, 'description': "Filter to contacts owned by this workspace member's user id."}, 'perPage': {'type': 'integer', 'default': 25, 'maximum': 100, 'minimum': 1, 'description': 'Number of contacts per page (1-100). Default 25.'}, 'sortDir': {'enum': ['asc', 'desc'], 'type': 'string', 'default': 'asc', 'description': 'Sort direction. Default asc.'}, 'companyId': {'type': 'string', 'maxLength': 160, 'minLength': 1, 'description': 'Filter to contacts at this company id (from search_companies).'}}, 'additionalProperties': False}
search_deals
Search deals
List and search pipeline deals, filtered by stage/owner/company/contact/stale and paginated. Returns summary rows (id, title, stage, amount, probability, owner, company, contact, next-action, isStale) plus pagination { page, perPage, total }. Use get_deal to fetch one deal's full detail by id.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'q': {'type': 'string', 'maxLength': 255, 'description': 'Free-text search over the deal title. Omit for no text filter.'}, 'page': {'type': 'integer', 'default': 1, 'maximum': 9007199254740991, 'description': '1-based page number of results to return. Default 1.', 'exclusiveMinimum': 0}, 'stale': {'enum': ['true', 'false'], 'type': 'string', 'description': 'Set "true" to return only stale deals (past their next-action date or long untouched).'}, 'ownerId': {'type': 'string', 'maxLength': 160, 'minLength': 1, 'description': "Filter to deals owned by this workspace member's user id."}, 'perPage': {'type': 'integer', 'default': 25, 'maximum': 100, 'minimum': 1, 'description': 'Number of deals per page (1-100). Default 25.'}, 'stageId': {'type': 'string', 'maxLength': 160, 'minLength': 1, 'description': 'Filter to deals in this pipeline stage id (from list_pipeline_stages).'}, 'companyId': {'type': 'string', 'maxLength': 160, 'minLength': 1, 'description': 'Filter to deals linked to this company id (from search_companies).'}, 'contactId': {'type': 'string', 'maxLength': 160, 'minLength': 1, 'description': 'Filter to deals linked to this contact id (from search_contacts).'}}, 'additionalProperties': False}
search_leads
Search leads
List and search this workspace's leads, filtered by text/status/source/created-date/stale and paginated. Returns summary rows (id, name, contact, company, status, source, assignee, tags, next-action, isStale, timestamps) plus pagination { page, perPage, total }, newest first. Use get_lead to fetch notes, position and score for one lead by id.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'q': {'type': 'string', 'maxLength': 255, 'description': 'Free-text search over lead name, email, phone, or company. Omit for no text filter.'}, 'to': {'type': 'string', 'format': 'date-time', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$', 'description': 'Only leads created at or before this ISO 8601 timestamp (e.g. 2026-02-28T23:59:59Z).'}, 'from': {'type': 'string', 'format': 'date-time', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$', 'description': 'Only leads created at or after this ISO 8601 timestamp (e.g. 2026-01-31T00:00:00Z).'}, 'page': {'type': 'integer', 'default': 1, 'maximum': 9007199254740991, 'minimum': 1, 'description': '1-based page number of results to return. Default 1.'}, 'stale': {'anyOf': [{'type': 'boolean'}, {'enum': ['true', 'false'], 'type': 'string'}], 'description': 'Set true to return only stale leads: not unqualified/converted and either past their next-action date or untouched for more than 7 days.'}, 'source': {'type': 'string', 'maxLength': 80, 'description': "Filter by lead source key (e.g. website, referral, telegram). Use list_lead_sources to see the workspace's keys. Omit for all sources."}, 'status': {'enum': ['new', 'contacted', 'qualified', 'unqualified', 'converted'], 'type': 'string', 'description': 'Filter by lead status. Omit to return every status. Allowed: new, contacted, qualified, unqualified, converted.'}, 'perPage': {'type': 'integer', 'default': 20, 'maximum': 100, 'minimum': 1, 'description': 'Number of results per page (1-100). Default 20.'}}}
search_products
Search products
List and search active catalog products, filtered by category/brand/collection/model (productGroupId â the other colours and sizes of one model)/size/color/price/stock/tag/type, sorted by name, price, newest or popularity (units sold in the last 90 days), and paginated. Returns summary rows (id, name, sku, type, price, currency, unit, stock, category, brand) plus pagination { page, perPage, total }. Use get_product to fetch one product's full detail by id or SKU.
Solo lectura
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'q': {'type': 'string', 'default': '', 'maxLength': 200, 'description': 'Free-text search over product name and SKU. Empty for no text filter.'}, 'tag': {'type': 'string', 'default': '', 'maxLength': 100, 'description': 'Filter to products carrying this tag. Empty means any tag.'}, 'page': {'type': 'integer', 'default': 1, 'maximum': 9007199254740991, 'minimum': 1, 'description': '1-based page number of results to return. Default 1.'}, 'size': {'type': 'string', 'default': '', 'maxLength': 60, 'description': "Filter to products whose size equals this value, ignoring letter case (the product's own size field). Empty means any size."}, 'sort': {'enum': ['', 'name_asc', 'name_desc', 'price_asc', 'price_desc', 'newest', 'popular'], 'type': 'string', 'default': '', 'description': 'Sort order. Empty sorts by name. Allowed: name_asc, name_desc, price_asc, price_desc, newest, popular â\x80\x94 popular ranks by units sold in confirmed, processing, shipped or delivered orders over the last 90 days. Ties break by name.'}, 'type': {'enum': ['', 'simple', 'bundle'], 'type': 'string', 'default': '', 'description': 'Filter by product type. Empty for any; "simple" or "bundle".'}, 'color': {'type': 'string', 'default': '', 'maxLength': 80, 'description': "Filter to products whose color equals this value, ignoring letter case (the product's own color field, not a free-form attribute). Empty means any color."}, 'status': {'enum': ['', 'draft', 'active', 'archived', 'any'], 'type': 'string', 'default': '', 'description': 'Filter by catalog status. Empty keeps the storefront default of active only. Use "draft" to find products waiting to be reviewed (marketplace imports and unknown SKUs from orders land there), or "any" for every status.'}, 'brandId': {'type': 'string', 'default': '', 'maxLength': 40, 'description': 'Filter to one brand by its id. Empty string means any brand.'}, 'inStock': {'enum': ['', 'true'], 'type': 'string', 'default': '', 'description': 'Set "true" to return only products with stock available. Empty means include out-of-stock.'}, 'perPage': {'type': 'integer', 'default': 20, 'maximum': 100, 'minimum': 1, 'description': 'Number of products per page (1-100). Default 20.'}, 'maxPrice': {'type': 'number', 'minimum': 0, 'description': 'Only products priced at or below this amount (workspace currency).'}, 'minPrice': {'type': 'number', 'minimum': 0, 'description': 'Only products priced at or above this amount (workspace currency).'}, 'categoryId': {'type': 'string', 'default': '', 'maxLength': 40, 'description': 'Filter to one category by its id. Empty string means any category.'}, 'collection': {'type': 'string', 'default': '', 'maxLength': 120, 'description': 'Filter to the products of one collection, by its slug from GET /collections. Only a collection that is visible and in season matches â\x80\x94 an unknown, hidden or out-of-season slug is reported as not found, exactly like GET /collections/{slug}. Empty means no collection filter.'}, 'stockState': {'enum': ['', 'low', 'out'], 'type': 'string', 'default': '', 'description': 'Filter by stock state, for products that track inventory. "low" returns products at or under their reorder threshold; "out" returns products with nothing left. Empty applies no stock-state filter.'}, 'warehouseId': {'type': 'string', 'default': '', 'maxLength': 40, 'description': 'Filter to products in one warehouse by its id, from the warehouse list. Use "none" for products assigned to no warehouse â\x80\x94 they match no id, so nothing else surfaces them. Empty means any warehouse. An id absent from this workspace is reported as an error, never as an empty result.'}, 'productGroupId': {'type': 'string', 'default': '', 'maxLength': 120, 'description': "Filter to the variants of one model: products whose productGroupId equals this value exactly. It is the merchant's (or supplier's) own model code, so letter case is part of it. Use it to render the other colours and sizes of the product a buyer is looking at. Empty means any model."}}}
select_workspace
Select workspace
Re-bind this OAuth connection to the workspace selected by the user. Takes effect on the next tool call. Use the organizationId returned by list_workspaces or by WORKSPACE_SELECTION_REQUIRED; never invent or guess it.
Destructivo
Idempotente
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['organizationId'], 'properties': {'organizationId': {'type': 'string', 'minLength': 1, 'description': 'The workspace organizationId chosen by the user from list_workspaces or WORKSPACE_SELECTION_REQUIRED.'}}}
set_lead_sources
Set lead source
Create or update a workspace lead source: set its label and active state by key (built-in or custom, lowercase_with_underscores). Idempotent â re-sending the same key updates it. Archiving the fallback 'other' source is not allowed. Use list_lead_sources to see current sources. The result echoes the operating workspace.
Destructivo
Idempotente
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['isActive', 'key', 'label'], 'properties': {'key': {'type': 'string', 'pattern': '^[a-z0-9]+(?:_[a-z0-9]+)*$', 'maxLength': 80, 'minLength': 1, 'description': 'Stable source key, lowercase_with_underscores (built-in or custom).'}, 'label': {'type': 'string', 'maxLength': 120, 'minLength': 1, 'description': 'Human-readable label shown for this source in the UI.'}, 'isActive': {'type': 'boolean', 'description': "Whether the source is selectable for new leads. Set false to archive it (the fallback 'other' source cannot be archived)."}}}
transition_deal
Transition deal
Move a deal to a pipeline stage by its id. Closed-lost stages require a lostReason. Use search_deals for the deal id and list_pipeline_stages for the target stageId. The result echoes the operating workspace.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['stageId', 'id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The deal id returned by search_deals.'}, 'stageId': {'type': 'string', 'maxLength': 160, 'minLength': 1, 'description': 'The target pipeline stage id to move the deal to (from list_pipeline_stages).'}, 'lostReason': {'anyOf': [{'type': 'string', 'maxLength': 500}, {'type': 'null'}], 'description': 'Reason the deal was lost. Required when the target stage is a Closed-lost stage; otherwise omit.'}}, 'additionalProperties': False}
update_company
Update company
Update fields on a company by id. Provide a patch with at least one field. Use search_companies first to find the company id. The result echoes the operating workspace.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id', 'patch'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The company id returned by search_companies.'}, 'patch': {'type': 'object', 'properties': {'name': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'The company name (unique within the workspace).'}, 'size': {'enum': ['solo', 'small', 'medium', 'large', 'enterprise'], 'type': 'string', 'description': 'Company size band. Optional. One of: solo, small, medium, large, enterprise.'}, 'status': {'enum': ['prospect', 'active', 'inactive'], 'type': 'string', 'description': 'Relationship status. Optional. One of: prospect, active, inactive.'}, 'ownerId': {'anyOf': [{'type': 'string', 'description': 'User id of the workspace member who owns this company.'}, {'type': 'null'}], 'description': 'User id of the workspace member who owns this company. Optional.'}, 'website': {'anyOf': [{'type': 'string', 'format': 'uri', 'maxLength': 255, 'description': 'The company website URL.'}, {'type': 'null'}], 'description': 'The company website URL. Optional.'}, 'industry': {'anyOf': [{'type': 'string', 'maxLength': 120, 'description': "The company's industry."}, {'type': 'null'}], 'description': "The company's industry. Optional."}}, 'description': 'The company fields to update; include at least one changed field.', 'additionalProperties': False}}}
update_contact
Update contact
Update fields on a contact by id. Provide a patch with at least one field. Use search_contacts first to find the contact id. The result echoes the operating workspace.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id', 'patch'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The contact id returned by search_contacts.'}, 'patch': {'type': 'object', 'properties': {'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80}, 'description': 'Tags for segmentation. Optional.'}, 'email': {'anyOf': [{'type': 'string', 'format': 'email', 'pattern': "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", 'maxLength': 255, 'description': "The contact's email address."}, {'type': 'null'}], 'description': "The contact's email address. Optional."}, 'phone': {'anyOf': [{'type': 'string', 'maxLength': 50, 'description': "The contact's phone number."}, {'type': 'null'}], 'description': "The contact's phone number. Optional."}, 'ownerId': {'anyOf': [{'type': 'string', 'description': 'User id of the workspace member who owns this contact.'}, {'type': 'null'}], 'description': 'User id of the workspace member who owns this contact. Optional.'}, 'jobTitle': {'anyOf': [{'type': 'string', 'maxLength': 160, 'description': "The contact's job title."}, {'type': 'null'}], 'description': "The contact's job title. Optional."}, 'lastName': {'anyOf': [{'type': 'string', 'maxLength': 120, 'description': "The contact's last name."}, {'type': 'null'}], 'description': "The contact's last name. Optional."}, 'companyId': {'anyOf': [{'type': 'string', 'description': 'Company id to link this contact to (from search_companies).'}, {'type': 'null'}], 'description': 'Company id to link this contact to (from search_companies). Optional.'}, 'firstName': {'type': 'string', 'maxLength': 120, 'minLength': 1, 'description': "The contact's first name."}}, 'description': 'The contact fields to update; include at least one changed field.', 'additionalProperties': False}}}
update_lead
Update lead
Update fields on an existing lead by id. Provide a patch with at least one field. Use search_leads first to find the lead id. The result echoes the operating workspace.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id', 'patch'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The lead id returned by search_leads.'}, 'patch': {'type': 'object', 'properties': {'name': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': "The lead's full name or label."}, 'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'maxItems': 30, 'description': 'Tags for segmentation (replaces the existing set; max 30).'}, 'email': {'anyOf': [{'type': 'string', 'format': 'email', 'pattern': "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}, {'type': 'null'}], 'description': "The lead's email; null to clear."}, 'notes': {'anyOf': [{'type': 'string', 'maxLength': 5000}, {'type': 'null'}], 'description': 'Free-text notes; null to clear.'}, 'phone': {'anyOf': [{'type': 'string', 'maxLength': 50, 'minLength': 1}, {'type': 'null'}], 'description': "The lead's phone number; null to clear."}, 'score': {'type': 'integer', 'maximum': 100, 'minimum': 0, 'description': 'Lead quality score, 0-100.'}, 'source': {'type': 'string', 'maxLength': 80, 'minLength': 1, 'description': 'Lead source key (see list_lead_sources).'}, 'status': {'enum': ['new', 'contacted', 'qualified', 'unqualified'], 'type': 'string', 'description': 'Lead status: new, contacted, qualified, unqualified, or converted.'}, 'position': {'anyOf': [{'type': 'string', 'maxLength': 255, 'minLength': 1}, {'type': 'null'}], 'description': "The lead's job title/position; null to clear."}, 'assignedTo': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}], 'description': 'User id of the workspace member to own the lead; null to unassign.'}, 'companyName': {'anyOf': [{'type': 'string', 'maxLength': 255, 'minLength': 1}, {'type': 'null'}], 'description': "The lead's company name; null to clear."}, 'nextActionDate': {'anyOf': [{'type': 'string', 'format': 'date-time', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$'}, {'type': 'null'}], 'description': 'ISO 8601 timestamp of the next action; null to clear.'}, 'nextActionNote': {'anyOf': [{'type': 'string', 'maxLength': 500, 'minLength': 1}, {'type': 'null'}], 'description': 'What the next action is; null to clear.'}}, 'description': 'The lead fields to update; include at least one changed field.', 'additionalProperties': False}}}
update_order_item
Update order item
Update a line item on an order (quantity, unit price, discount, name, or SKU). Recomputes the order total. Use get_order to find the order's externalId and the item's itemId. The result echoes the operating workspace.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['externalId', 'itemId', 'patch'], 'properties': {'patch': {'type': 'object', 'properties': {'sku': {'type': 'string', 'maxLength': 120, 'description': 'Product SKU snapshot (from search_products). Optional.'}, 'discount': {'type': 'number', 'default': 0, 'maximum': 100, 'minimum': 0, 'description': 'Percentage discount on this line (0-100). Default 0.'}, 'quantity': {'type': 'integer', 'maximum': 9007199254740991, 'description': 'Quantity ordered (integer, at least 1).', 'exclusiveMinimum': 0}, 'unitPrice': {'anyOf': [{'type': 'string', 'pattern': '^\\d+(\\.\\d{1,2})?$'}, {'type': 'number', 'minimum': 0}], 'description': 'Price per unit in the order currency, as a decimal (e.g. 199.99). Snapshotted onto the line.'}, 'productName': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': "Line item name, snapshotted onto the order. Use search_products to quote a real catalog product's name. Required."}}, 'description': 'The order item fields to update; include at least one changed field.', 'additionalProperties': False}, 'itemId': {'type': 'string', 'minLength': 1, 'description': 'The order item id returned by get_order.'}, 'externalId': {'type': 'string', 'minLength': 1, 'description': 'The order externalId returned by list_orders or create_order.'}}}
update_order_status
Update order status
Move an order to a new status by externalId. Only valid transitions from the current status are allowed. Use list_orders to find the externalId and get_order to see the current status. The result echoes the operating workspace.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['status', 'externalId'], 'properties': {'status': {'enum': ['pending', 'confirmed', 'processing', 'shipped', 'delivered', 'cancelled', 'refunded'], 'type': 'string', 'description': 'The new order status. Only valid transitions from the current status are accepted. Allowed values: pending, confirmed, processing, shipped, delivered, cancelled, refunded.'}, 'externalId': {'type': 'string', 'minLength': 1, 'description': 'The order externalId returned by list_orders or create_order.'}}}
update_product
Update product
Update fields on an existing catalog product by id â including status, to publish a draft or archive a product. Provide a patch with at least one field; use get_product first to see the current values. A changed stock number is applied as a relative movement and recorded in the product stock history; prefer adjust_stock when the intent is a correction with a reason. A change to price, stock, tracking or status is pushed to every connected sales channel. For a product that belongs to a model, a changed shared field (name, description, category, brand, unit, keywords, videos, material, pattern, gender, age group, size type, condition) is applied to the whole model and every article of it; productGroupId null detaches the product from its model, and the code of another model moves it there. The result echoes the operating workspace.
Destructivo
Esquema de entrada
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id', 'patch'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The product id returned by search_products.'}, 'patch': {'type': 'object', 'properties': {'ean': {'anyOf': [{'type': 'string', 'pattern': '^[0-9]{8,14}$'}, {'type': 'null'}], 'example': '4006381333931', 'description': 'GTIN/EAN-8/12/13/14 barcode. Presence-and-shape validation only, no checksum.'}, 'sku': {'anyOf': [{'type': 'string', 'maxLength': 120, 'minLength': 1}, {'type': 'null'}]}, 'name': {'type': 'string', 'maxLength': 255, 'minLength': 1}, 'size': {'anyOf': [{'type': 'string', 'maxLength': 60, 'minLength': 1}, {'type': 'null'}]}, 'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'default': []}, 'type': {'enum': ['simple', 'bundle'], 'type': 'string', 'default': 'simple'}, 'unit': {'anyOf': [{'type': 'string', 'maxLength': 40, 'minLength': 1}, {'type': 'null'}]}, 'color': {'anyOf': [{'type': 'string', 'maxLength': 80, 'minLength': 1}, {'type': 'null'}]}, 'depth': {'anyOf': [{'anyOf': [{'type': 'number'}, {'type': 'string', 'minLength': 1}]}, {'type': 'null'}]}, 'price': {'anyOf': [{'anyOf': [{'type': 'number'}, {'type': 'string', 'minLength': 1}]}, {'type': 'null'}]}, 'stock': {'anyOf': [{'type': 'integer', 'maximum': 9007199254740991, 'minimum': 0}, {'type': 'null'}]}, 'width': {'anyOf': [{'anyOf': [{'type': 'number'}, {'type': 'string', 'minLength': 1}]}, {'type': 'null'}]}, 'gender': {'anyOf': [{'enum': ['male', 'female', 'unisex'], 'type': 'string'}, {'type': 'null'}]}, 'height': {'anyOf': [{'anyOf': [{'type': 'number'}, {'type': 'string', 'minLength': 1}]}, {'type': 'null'}]}, 'images': {'type': 'array', 'items': {'type': 'object', 'required': ['url'], 'properties': {'url': {'type': 'string', 'format': 'uri'}, 'name': {'type': 'string', 'maxLength': 255, 'minLength': 1}, 'size': {'type': 'integer', 'maximum': 9007199254740991, 'exclusiveMinimum': 0}, 'pathname': {'type': 'string', 'minLength': 1}, 'uploadedAt': {'type': 'string', 'format': 'date-time', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$'}, 'contentType': {'enum': ['image/jpeg', 'image/png', 'image/webp'], 'type': 'string'}}, 'additionalProperties': False}, 'maxItems': 10}, 'status': {'enum': ['draft', 'active', 'archived'], 'type': 'string', 'default': 'draft'}, 'videos': {'type': 'array', 'items': {'type': 'object', 'required': ['url'], 'properties': {'url': {'type': 'string', 'format': 'uri'}}}, 'default': [], 'example': [{'url': 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'}], 'maxItems': 5, 'description': 'Video links for the product page (YouTube, Vimeo or a direct file), https only, at most 5. Links, not uploads. On update, sending the field replaces the whole list.'}, 'weight': {'anyOf': [{'anyOf': [{'type': 'number'}, {'type': 'string', 'minLength': 1}]}, {'type': 'null'}]}, 'brandId': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}]}, 'pattern': {'anyOf': [{'type': 'string', 'maxLength': 80, 'minLength': 1}, {'type': 'null'}]}, 'ageGroup': {'anyOf': [{'enum': ['newborn', 'infant', 'toddler', 'kids', 'adult'], 'type': 'string'}, {'type': 'null'}]}, 'material': {'anyOf': [{'type': 'string', 'maxLength': 120, 'minLength': 1}, {'type': 'null'}]}, 'sizeType': {'anyOf': [{'type': 'string', 'maxLength': 40, 'minLength': 1}, {'type': 'null'}]}, 'condition': {'anyOf': [{'enum': ['new', 'used', 'refurbished'], 'type': 'string'}, {'type': 'null'}]}, 'costPrice': {'anyOf': [{'anyOf': [{'type': 'number'}, {'type': 'string', 'minLength': 1}]}, {'type': 'null'}]}, 'categoryId': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}]}, 'sizeSystem': {'anyOf': [{'enum': ['AU', 'BR', 'CN', 'DE', 'EU', 'FR', 'IT', 'JP', 'MEX', 'UK', 'US'], 'type': 'string'}, {'type': 'null'}]}, 'supplierId': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}]}, 'weightUnit': {'anyOf': [{'enum': ['kg', 'g', 'lb', 'oz'], 'type': 'string'}, {'type': 'null'}]}, 'bundleItems': {'type': 'array', 'items': {'type': 'object', 'required': ['productId', 'quantity'], 'properties': {'quantity': {'type': 'integer', 'maximum': 9007199254740991, 'exclusiveMinimum': 0}, 'productId': {'type': 'string', 'maxLength': 160, 'minLength': 1}}, 'additionalProperties': False}, 'default': []}, 'description': {'anyOf': [{'type': 'string', 'maxLength': 2000}, {'type': 'null'}]}, 'warehouseId': {'anyOf': [{'type': 'string', 'maxLength': 160, 'minLength': 1}, {'type': 'null'}]}, 'costCurrency': {'anyOf': [{'type': 'string', 'pattern': '^[A-Z]{3}$'}, {'type': 'null'}]}, 'dimensionUnit': {'anyOf': [{'enum': ['cm', 'mm', 'in'], 'type': 'string'}, {'type': 'null'}]}, 'compareAtPrice': {'anyOf': [{'anyOf': [{'type': 'number'}, {'type': 'string', 'minLength': 1}]}, {'type': 'null'}]}, 'productGroupId': {'anyOf': [{'type': 'string', 'maxLength': 120, 'minLength': 1}, {'type': 'null'}]}, 'trackInventory': {'type': 'boolean', 'default': False}}, 'description': 'The product fields to update; include at least one changed field.', 'additionalProperties': False}}}
Historial
Cambios recientes en herramientas
Modificado
update_product
29 de September de 2026 a las 03:02
Modificado
create_product
29 de September de 2026 a las 03:02
Modificado
create_order
23 de September de 2026 a las 02:53
Modificado
update_product
21 de September de 2026 a las 03:00
Modificado
create_product
21 de September de 2026 a las 03:00
Modificado
get_report
21 de September de 2026 a las 03:00
Modificado
search_products
19 de September de 2026 a las 02:51
Añadido
select_workspace
17 de September de 2026 a las 12:36
Añadido
list_workspaces
17 de September de 2026 a las 12:36
Añadido
set_lead_sources
17 de September de 2026 a las 12:36
Añadido
list_lead_sources
17 de September de 2026 a las 12:36
Añadido
configure_pipeline
17 de September de 2026 a las 12:36
Añadido
list_pipeline_stages
17 de September de 2026 a las 12:36
Añadido
adjust_stock
17 de September de 2026 a las 12:36
Añadido
update_product
17 de September de 2026 a las 12:36
Añadido
create_product
17 de September de 2026 a las 12:36
Añadido
remove_order_item
17 de September de 2026 a las 12:36
Añadido
update_order_item
17 de September de 2026 a las 12:36
Añadido
add_order_item
17 de September de 2026 a las 12:36
Añadido
create_order
17 de September de 2026 a las 12:36
Añadido
transition_deal
17 de September de 2026 a las 12:36
Añadido
assign_lead
17 de September de 2026 a las 12:36
Añadido
convert_lead
17 de September de 2026 a las 12:36
Añadido
complete_activity
17 de September de 2026 a las 12:36
Añadido
update_company
17 de September de 2026 a las 12:36
Añadido
create_company
17 de September de 2026 a las 12:36
Añadido
update_contact
17 de September de 2026 a las 12:36
Añadido
create_contact
17 de September de 2026 a las 12:36
Añadido
update_order_status
17 de September de 2026 a las 12:36
Añadido
create_activity
17 de September de 2026 a las 12:36
Descubrir
Servidores MCP similares
TOTVS Protheus
io.github.mcp-dir/protheus-mcp
Provides read-only access to TOTVS Protheus ERP data covering inventory, sales, purchasing, customers, suppliers, CRM, pricing, a…
Mercos
io.github.mcp-dir/mercos-mcp
Connects to Mercos to manage customers, products, orders, inventory, price tables, payment terms, commissions, users, and logisti…
Nuvemshop
io.github.mcp-dir/nuvemshop-mcp
Manages Nuvemshop store products, categories, customers, coupons, and orders, including order status and product mutations.
Contractors Near Me
ai.contractorsnearme/contractors-near-me
Searches contractor directories and project bids, retrieves profiles and reviews, and supports lead submission and management.
freedom-mcp
com.getfreedomos/freedom-mcp
Supports company operations through commitments, teams, agents, customer evidence, leads, content workflows, spreadsheets, commer…
Meta Council
com.meta-council/decision-intelligence
Provides governed workflows for consulting, outreach, sales deals, invoices, marketing campaigns, content approvals, accounting a…
AgentLot Marketplace
io.agentlot/marketplace
Enables agents and users to discover, bid on, purchase, deliver, and settle paid digital services and compute work.
GestãoClick
io.github.mcp-dir/gestaoclick-mcp
Connects to the GestãoClick ERP to manage customers, suppliers, products, sales, service orders, budgets, and financial records.