Simla.com
simla_comSimla.com is an omnichannel CRM platform with AI for automating communications, measuring team performance, managing customer data, and integrating delivery services and order management.
Acciones disponibles (19)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create CustomerSIMLA_COM_CREATE_CUSTOMERAcciónTool to create a new customer. use after gathering all customer information.
SIMLA_COM_CREATE_CUSTOMERAcciónTool to create a new customer. use after gathering all customer information.
Parámetros de entrada
customerobjectObligatorioThe customer object to create
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Custom FieldSIMLA_COM_CREATE_CUSTOM_FIELDAcciónTool to create a custom field for a specified entity in simla. use when you need to extend orders, customers, corporate customers, or companies with custom metadata fields.
SIMLA_COM_CREATE_CUSTOM_FIELDAcciónTool to create a custom field for a specified entity in simla. use when you need to extend orders, customers, corporate customers, or companies with custom metadata fields.
Parámetros de entrada
codestringSymbolic code for the field (letters, numbers, underscores). Automatically generated if omitted.
namestringObligatorioDisplay name of the custom field.
typestringObligatorioenumData type of the custom field.
stringtextintegernumberbooldictionarydateemailentitystringObligatorioenumThe entity to which the custom field will be added.
ordercustomercorporate_customercompanyin_listbooleanWhether the field is shown in list views.
editablebooleanWhether the field is editable after creation.
requiredbooleanWhether this field is mandatory.
in_filterbooleanWhether the field is available in filtering UI.
display_areastringUI area where the field is displayed. Defaults to 'Additional data' block if omitted.
in_group_actionsbooleanWhether the field can be used in bulk actions.
display_in_mobile_appstringenumHow the field appears in the mobile app.
editablenot_editableabsent
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create OrderSIMLA_COM_CREATE_ORDERAcciónTool to create a new order. use when you have all order details prepared and need to register it in simla via the api.
SIMLA_COM_CREATE_ORDERAcciónTool to create a new order. use when you have all order details prepared and need to register it in simla via the api.
Parámetros de entrada
sitestringSite code (optional)
orderobjectObligatorioOrder object with all creation parameters
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create TaskSIMLA_COM_CREATE_TASKAcciónTool to create a new task. use after gathering task details and assignees.
SIMLA_COM_CREATE_TASKAcciónTool to create a new task. use after gathering task details and assignees.
Parámetros de entrada
textstringObligatorioTask description text
entityobjectRelated entity reference for the task
commentstringAdditional comment for the task
userIdsinteger[]ObligatorioIDs of users assigned to the task
customerobjectCustomer reference for the task
deadlinestringTask deadline in ISO 8601 datetime format
taskTypestringObligatorioType/identifier of the task
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Edit CustomerSIMLA_COM_EDIT_CUSTOMERAcciónTool to edit an existing customer. use when you need to update customer details by external id.
SIMLA_COM_EDIT_CUSTOMERAcciónTool to edit an existing customer. use when you need to update customer details by external id.
Parámetros de entrada
sexstringenumCustomer's gender; 'male' or 'female'
malefemaleemailstringCustomer's email address
phonestringCustomer's phone number
addressobjectCustomer's address details
birthdaystringCustomer's date of birth in 'Y-m-d' format
lastNamestringCustomer's last name
firstNamestringCustomer's first name
externalIdstringObligatorioExternal identifier of the customer to edit
customFieldsobjectCustom fields associated with the customer
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Edit Custom FieldSIMLA_COM_EDIT_CUSTOM_FIELDAcciónTool to edit an existing custom field by entity and code. use when you need to update custom field metadata before usage.
SIMLA_COM_EDIT_CUSTOM_FIELDAcciónTool to edit an existing custom field by entity and code. use when you need to update custom field metadata before usage.
Parámetros de entrada
codestringObligatorioUnique code of the custom field to edit.
namestringNew display name for the custom field.
sortintegerSort order index; must be non-negative.
typestringenumData type of the custom field.
stringtextintegernumberbooldictionarydateemailentitystringObligatorioenumThe entity type to which the custom field belongs.
ordercustomercorporate_customercompanyisActivebooleanWhether the custom field is active/enabled.
settingsobject[]Additional settings specific to the field type.
isVisiblebooleanWhether the custom field is visible in UI.
isEditablebooleanWhether the custom field is editable by users.
isRequiredbooleanWhether the custom field is required.
descriptionstringDetailed description of the custom field.
defaultValuestringNew default value for the custom field.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Edit OrderSIMLA_COM_EDIT_ORDERAcciónTool to edit an existing order by external id. use when you need to update order details by external id.
SIMLA_COM_EDIT_ORDERAcciónTool to edit an existing order by external id. use when you need to update order details by external id.
Parámetros de entrada
sitestringCode of the site where the order belongs
orderobjectObligatorioOrder object with fields to update
externalIdstringObligatorioExternal ID of the order to edit
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Edit TaskSIMLA_COM_EDIT_TASKAcciónTool to edit an existing task. use after confirming task id and fields to update. updates only provided fields on the task.
SIMLA_COM_EDIT_TASKAcciónTool to edit an existing task. use after confirming task id and fields to update. updates only provided fields on the task.
Parámetros de entrada
idstringObligatorioUnique identifier of the task to edit
taskobjectObligatorioObject containing one or more fields to update
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get CustomerSIMLA_COM_GET_CUSTOMERAcciónTool to retrieve information about a specific customer. use when you need full customer data by external id before further operations.
SIMLA_COM_GET_CUSTOMERAcciónTool to retrieve information about a specific customer. use when you need full customer data by external id before further operations.
Parámetros de entrada
bystringenumType of identifier provided in externalId path parameter
idexternalIdsitestringSymbolic code of the store (if applicable)
externalIdstringObligatorioThe identifier of the customer to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get CustomersSIMLA_COM_GET_CUSTOMERSAcciónTool to retrieve a list of customers. use after setting optional filters (ids, email, custom fields) to fetch paginated customer data.
SIMLA_COM_GET_CUSTOMERSAcciónTool to retrieve a list of customers. use after setting optional filters (ids, email, custom fields) to fetch paginated customer data.
Parámetros de entrada
pageintegerPage number for pagination
limitintegerNumber of customers to return per page
filter[email]stringFilter customers by email address
filter[ids][]integer[]Filter customers by a list of IDs
filter[customFieldKey]stringFilter customers by a custom field key
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Custom FieldsSIMLA_COM_GET_CUSTOM_FIELDSAcciónTool to list custom fields. use when retrieving custom field definitions with optional filtering by entity or code.
SIMLA_COM_GET_CUSTOM_FIELDSAcciónTool to list custom fields. use when retrieving custom field definitions with optional filtering by entity or code.
Parámetros de entrada
pageintegerPage number to return (default: 1)
limitintegerNumber of records per page (default: 20, max: 250)
entitystringFilter by entity type (e.g., customer, order)
filter[code]stringFilter by custom field code
filter[type]stringFilter by custom field type
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get OrderSIMLA_COM_GET_ORDERAcciónTool to retrieve detailed information about a specific order. use when you need to fetch full order data by external id before further processing.
SIMLA_COM_GET_ORDERAcciónTool to retrieve detailed information about a specific order. use when you need to fetch full order data by external id before further processing.
Parámetros de entrada
external_idstringObligatorioExternal identifier of the order to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get OrdersSIMLA_COM_GET_ORDERSAcciónTool to retrieve a list of orders. use when you need to fetch orders with optional filters (order numbers, custom fields) and pagination.
SIMLA_COM_GET_ORDERSAcciónTool to retrieve a list of orders. use when you need to fetch orders with optional filters (order numbers, custom fields) and pagination.
Parámetros de entrada
pageintegerPage number for pagination (default: 1)
limitintegerNumber of orders per page (default: 20)
numbersstring[]List of order numbers to filter by
customFieldsobjectFilters for custom fields, as a dict where each key is the field name and value defines min/max
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ProductsSIMLA_COM_GET_PRODUCTSAcciónTool to retrieve a list of products. use when you need to list products with optional filters.
SIMLA_COM_GET_PRODUCTSAcciónTool to retrieve a list of products. use when you need to list products with optional filters.
Parámetros de entrada
pageintegerPage number to retrieve (default: 1)
ids[]integer[]Filter by a list of product IDs
limitintegerNumber of products to return per page (max: 250)
filter[name]stringFilter by product name
filter[active]booleanFilter active products
filter[maxPrice]numberFilter products by maximum price
filter[minPrice]numberFilter products by minimum price
filter[quantity]integerFilter by available quantity
filter[externalId]stringFilter by external product ID
filter[createdAtTo]stringISO8601 datetime; only products created before this timestamp
filter[updatedAtTo]stringISO8601 datetime; only products updated before this timestamp
filter[createdAtFrom]stringISO8601 datetime; only products created after this timestamp
filter[updatedAtFrom]stringISO8601 datetime; only products updated after this timestamp
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SegmentsSIMLA_COM_GET_SEGMENTSAcciónTool to retrieve a list of customer segments. use when you need to list segments with optional filters after authentication.
SIMLA_COM_GET_SEGMENTSAcciónTool to retrieve a list of customer segments. use when you need to list segments with optional filters after authentication.
Parámetros de entrada
pageintegerPage number for pagination. Default is 1.
sitestringSymbolic code of the store. Required if the API key has access to multiple stores.
limitintegerNumber of segments per page. Default is 20.
filter[name]stringFilter segments by name.
filter[active]booleanFilter segments by active status.
filter[createdAtTo]stringFilter segments created on or before this date (YYYY-MM-DD).
filter[createdAtFrom]stringFilter segments created on or after this date (YYYY-MM-DD).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SitesSIMLA_COM_GET_SITESAcciónTool to retrieve a list of sites. use when you need to discover all configured sites with optional pagination.
SIMLA_COM_GET_SITESAcciónTool to retrieve a list of sites. use when you need to discover all configured sites with optional pagination.
Parámetros de entrada
pageintegerPage number to retrieve (default: 1)
limitintegerNumber of sites per page (default: 20)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TaskSIMLA_COM_GET_TASKAcciónTool to retrieve detailed information about a specific task. use when you need full task details by task id before taking further actions.
SIMLA_COM_GET_TASKAcciónTool to retrieve detailed information about a specific task. use when you need full task details by task id before taking further actions.
Parámetros de entrada
idintegerObligatorioUnique identifier of the task to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TasksSIMLA_COM_GET_TASKSAcciónTool to retrieve a list of tasks with optional filters. use when you need to fetch tasks after specifying filter criteria like ids, status, or date range.
SIMLA_COM_GET_TASKSAcciónTool to retrieve a list of tasks with optional filters. use when you need to fetch tasks after specifying filter criteria like ids, status, or date range.
Parámetros de entrada
idsinteger[]Filter by specific task IDs
limitintegerMaximum number of tasks to return
expandstring[]Related entities to expand in the response
filterobject[]Custom filter conditions as defined by the API (array of objects)
offsetintegerNumber of tasks to skip for pagination
statusstringFilter tasks by status
orderIdsinteger[]Filter by related order IDs
createdAtTostringISO 8601 datetime to include tasks created on or before this timestamp
createdAtFromstringISO 8601 datetime to include tasks created on or after this timestamp
responsibleUserIdsinteger[]Filter by IDs of users responsible for the task
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get UsersSIMLA_COM_GET_USERSAcciónTool to retrieve a list of users. use when you need to fetch users with optional pagination, filtering, and sorting.
SIMLA_COM_GET_USERSAcciónTool to retrieve a list of users. use when you need to fetch users with optional pagination, filtering, and sorting.
Parámetros de entrada
pageintegerPage number for pagination
limitintegerNumber of users to return per page
sortBystringField name to sort by
sortOrderstringenumSort order: 'asc' or 'desc'
ascdescfilter[externalId]stringFilter by external user ID
filter[createdAtTo]stringFilter users created before this timestamp (YYYY-MM-DD HH:MM:SS)
filter[customField]stringFilter by a custom field
filter[createdAtFrom]stringFilter users created after this timestamp (YYYY-MM-DD HH:MM:SS)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not