Skip to content
Changelog

Report a bug

Simla.com integration: operations for AI agents

Simla.com connects to Type.com as an integration. This page lists the 225 operations documented for Claude and Codex in Type.com: 100 read, 110 write, 15 destructive.

About Simla.com

Simla.com is an omnichannel CRM platform with AI for automating communications, measuring team performance, managing customer data, and integrating delivery services and order management.

Categories: Sales & CRM

How to connect Simla.com to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

225 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

225 operations listed.

Historical Pipedream actions

  • Write

    Create Customer

    Creates a new customer profile. .

  • Write

    Create Order

    Creates a new order with customer and order details. .

Simla API / API

  • Read

    Getting the list of available api versions

    Method allows to get all API-versions, which can be used on current account

    GET /api/api-versions

  • Read

    Getting the list of available api methods and stores for current key

    Method allows to get list of methods and information about access to stores for current API-key.

    GET /api/credentials

Simla API / Cost

  • Read

    Getting of the cost list, adequate for the given filter

    To access the method, the following permission is required cost_read. The result is returned page by page. In the field pagination there is information on pagination.

    GET /api/v5/costs

  • Read

    Getting of cost information

    To access the method, the following permission is required cost_read.

    GET /api/v5/costs/{id}

  • Write

    Creation of the cost

    To access the method, the following permission is required cost_write. When creating costs for attracting customers in fields cost[source][...] it`s possible to specify meanings of appropriate tags. Default meanings of tags will be taken from a cost item, whose character code is specified in field cost[costItem]. For specifying stores to which the cost will be attached it`s necessary to specify array of their character codes in field cost[sites][]. Cost will be created by default for all stores, which have access to API-key. Cost can be bound with existing order only if the cost item has "Refers to the costs on orders" attribute. For this purpose it is necessary to set the value for one of the following field: cost[order][id] – order internal ID; cost[order][externalId] – order external ID; cost[order][number] – order number. If the values of several fields are set, they will be processed in order specified above. Order search by externalId/number will be performed within the store specified in the site parameter.

    POST /api/v5/costs/create

  • Write

    Batch loading of costs

    To access the method, the following permission is required cost_write. Method allows to upload as packet up to 50 costs. More detailed information on data format you can find in description of method /api/v*/costs/create. When batch uploading costs for attracting customers in fields cost[][source][...] it`s possible to specify meanings of appropriate tags Default meanings of tags will be taken from a cost item, which character code is specified in the field costs[][costItem].

    POST /api/v5/costs/upload

  • Write

    Cost editing

    To access the method, the following permission is required cost_write. When editing costs for attracting customers in fields cost[source][...] it`s possible to specify meanings of appropriate tags. Cost can be bound with existing order only if the cost item has "Refers to the costs on orders" attribute. For this purpose it is necessary to set the value for one of the following field: cost[order][id] – order internal ID; cost[order][externalId] – order external ID; cost[order][number] – order number. If the values of several fields are set, they will be processed in order specified above. Order search by externalId/number will be performed within the store specified in the site parameter.

    POST /api/v5/costs/{id}/edit

  • Destructive

    Batch removing of costs

    To access the method, the following permission is required cost_write. Method allows to remove batch up to 50 costs.

    POST /api/v5/costs/delete

  • Destructive

    Cost removing

    To access the method, the following permission is required cost_write.

    POST /api/v5/costs/{id}/delete

Simla API / Custom fields

  • Read

    Getting the list of custom fields

    To access the method, the following permission is required custom_fields_read.

    GET /api/v5/custom-fields

  • Read

    Getting the list of custom directory

    To access the method, the following permission is required custom_fields_read.

    GET /api/v5/custom-fields/dictionaries

  • Read

    Getting information on directory

    To access the method, the following permission is required custom_fields_read.

    GET /api/v5/custom-fields/dictionaries/{code}

  • Read

    Getting information on custom fields

    To access the method, the following permission is required custom_fields_read.

    GET /api/v5/custom-fields/{entity}/{code}

  • Write

    Directory fields creation

    To access the method, the following permission is required custom_fields_write. customDictionary[code] field is specified only at directory creation. customDictionary[elements][][name] field is mandatory. customDictionary[elements][][ordering] field takes 50 value by default.

    POST /api/v5/custom-fields/dictionaries/create

  • Write

    Directory fields editing

    To access the method, the following permission is required custom_fields_write. customDictionary[code] field is not editable. customDictionary[elements][][name] field is mandatory. customDictionary[elements][][ordering] field takes 50 value by default.

    POST /api/v5/custom-fields/dictionaries/{code}/edit

  • Write

    Custom fields creation

    To access the method, the following permission is required custom_fields_write. {entity}, customField[type], customField[code] fields are specified only at creation of custom field. If customField[type] = dictionary, then customField[default] takes code element of the directory. Available values of customField[displayArea] field depends on {entity}. If {entity} = order, then customField[displayArea] field can take the following values: customer – Customer legal_details – Legal details shipment – Shipment dimensions – Dimensions delivery – Delivery payment – Payment If {entity} = customer, then customField[displayArea] field can take the following values: main_data – Main data delivery – Delivery legal_details – Legal details If {entity} = customer_corporate, then customField[displayArea] field can take the following values: main_data – Main data If {entity} = company, then customField[displayArea] field can take the following values: main_data – Main data legal_details – Legal details customField[required] field takes false value by default. customField[inFilter] field takes true value by default. customField[inList] field takes true value by default. customField[inGroupActions] field takes false value by default. customField[viewMode] field takes editable value by default. customField[viewModeMobile] field takes editable value by default. customField[ordering] field takes 50 value by default. If customField[type] = dictionary, then customField[dictionary] field is mandatory and contains code of related directory. It is filled only at creation of custom field.

    POST /api/v5/custom-fields/{entity}/create

  • Write

    Custom fields editing

    To access the method, the following permission is required custom_fields_write. If customField[type] = dictionary, then customField[default] takes code element of the directory. Available values of customField[displayArea] field depends on {entity}. If {entity} = order, then customField[displayArea] field can take the following values: customer – Customer legal_details – Legal details shipment – Shipment dimensions – Dimensions delivery – Delivery payment – Payment If {entity} = customer, then customField[displayArea] field can take the following values: main_data – Main data delivery – Delivery legal_details – Legal details If {entity} = customer_corporate, then customField[displayArea] field can take the following values: main_data – Main data If {entity} = company, then customField[displayArea] field can take the following values: main_data – Main data legal_details – Legal details

    POST /api/v5/custom-fields/{entity}/{code}/edit

Simla API / Customers

  • Read

    Getting the list of customers matched the specified filter

    To access the method, the following permission is required customer_read. The result is returned page by page. In the field pagination there is information on pagination. In the filters filter[sourceName], filter[mediumName], filter[campaignName], filter[keywordName], filter[adContentName] the name of the elements are specified. In the filter[managers][] filters the internal IDs of the system elements are specified. In the filter[managerGroups] filter the symbol codes of the elements are specified. The filter filter[discountCardNumber] is available, if the field "Discount card" in the "Loyalty" module is active. In the following filters filter[ids][] and filter[externalIds][] the array of internal and external identifiers are passed. Filter filter[classSegment] allows to get segments of customers RFM-analysis. There are available the following values: monetary[0..2]_recency[0..2] frequency[0..2]_recency[0..2] monetary[0..2]_frequency[0..2]. By filter filter[name] possible to search by customer name and phone. With the help of the filter[customFields][] filter you can search by the custom fields value. For the "Data book" fields the symbol code of data book value is specified. For the "Date" and "Date-time" fields the date is specified in the Y-m-d format. For other field types exactly the value is specified. For the Integer, Numeric, Date and Date-time custom fields the filtration is realized over the range, for other fields types — by the exact value. Filter name is the same as field symbol code. E.g.: for the Date field with the symbol code birth_date there are filters filter[customFields][birth_date][min] and filter[customFields][birth_date][max]. For the DataBook field with the symbol code quality there is multiple filter filter[customFields][quality][]. One of three values can be specified in filter[attachments]: 1 - returns customers, which have no attached files; 2 - returns customers, which have attached files; 3 - returns customers, which have attached files and attachments to letters. One of three values can be specified in the filter[tasksCounts]: 1 - returns customers having no uncompleted tasks; 2 - returns customers with any uncompleted tasks (both expired and not expired ones); 3 - returns only those customers who have expired tasks among uncompleted ones. The filter[mgChannels] filter specifies an array of internal IDs of channels in the system. The filter selects customers with chats in the specified channels. Filter customers by tags using filter[tags][] and filter[attachedTags][]. If filter[tags][] is applied, the system will return customers with all tags mentioned in the list. This means that the AND condition is used for filtering. If filter[attachedTags][] is applied, the system will return customers for whom one of the tags mentioned in the list is an attached one. This means that the OR condition is used for filtering. The values of filter[tags][] and filter[attachedTags][] should not be empty or have duplicates or tags with more than two consecutive spaces. Otherwise, a corresponding error will be shown for the request. The fields personalDiscount, cumulativeDiscount and discountCardNumber are returned, if they are active in the "Loyalty" module settings. Field contragent[contragentType] can receive 3 values: individual - private individual, legal-entity - legal entity, entrepreneur - individual entrepreneur. For different types of legal entities there are available different set of fields. For type individual all fields are unavailable, for type legal-entity the fields contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate] are unavailable, for type entrepreneur the fields contragent[OGRN], contragent[KPP] are unavailable.

    GET /api/v5/customers

  • Read

    Getting the customer change history

    To access the method, the following permission is required customer_read. Returns the changes in customer data, which were made in the specified range of dates, or the set of incremental changes for carrying out the permanent synchronization The result is returned per-page. In the field pagination there is an information about the pagination. To paginate through history records, it is necessary to use filter[sinceId]. It is not recommended to use the page parameter. More information about the work with history you can find in other article (https://docs.simla.com/en/Developers/API/APIFeatures/WorkingHistoryAPI).

    GET /api/v5/customers/history

  • Read

    Getting the notes

    To access the method, the following permission is required customer_read. The result is returned page by page. In the field pagination there is information on pagination. The array of notes internal identifiers is being transferred in filter[ids][]. The arrays of customers internal and external identifiers is being transferred in filter[customerIds][] and filter[customerExternalIds][]. The array of managers internal identifiers is being transferred in filter[managerIds][]. filter[text] allows to get notes on partial coincidence of specified text. filter[createdAtFrom] and filter[createdAtTo] allow to get notes created at specified time interval.

    GET /api/v5/customers/notes

  • Read

    Get customer mobile app push token data

    To access the method, the following permission is required customer_read.

    GET /api/v5/customers/push-tokens

  • Read

    Getting information on customer

    To access the method, the following permission is required customer_read. Method returns full information on the customer. You may refer to customer either by external customer ID (by=externalId), or by internal ID (by=id). Field contragent[contragentType] can receive 3 values: individual - private individual, legal-entity - legal entity, entrepreneur - individual entrepreneur. For different types of legal entities there are available different set of fields. For type individual all fields are unavailable, for type legal-entity the fields contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate] are unavailable, for type entrepreneur the fields contragent[OGRN], contragent[KPP] are unavailable. Empty fields without values are not returned. In the managerId field the internal ID of system entity is returned. The fields personalDiscount, cumulativeDiscount and discountCardNumber are returned, if they are active in the "Loyalty" module settings. In the customFields field the value array of custom fields is returned. For the "DataBook" fields the symbol code of data book value is specified. For the date fields the date in the format Y-m-d is specified. For other field types the exact value is specified. If the customer address was specified in the string form it will be returned to the customer[address][text]. If the address was specified in detailed view, there will be returned all delivery filled fields, and in the customer[address][text] there will be automatically generated textual representation of the address.

    GET /api/v5/customers/{externalId}

  • Write

    Customer creation

    To access the method, the following permission is required customer_write. Method creates the customer and returns internal ID of created customer. If customer[createdAt] is not specified, then current time will be used as the date/time of customer creation. Field contragent[contragentType] can receive 3 values: individual - private individual, legal-entity - legal entity, entrepreneur - individual entrepreneur. For different types of legal entities there are available different set of fields. For type individual all fields are unavailable, for type legal-entity the fields contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate] are unavailable, for type entrepreneur the fields contragent[OGRN], contragent[KPP] are unavailable. The fields customer[personalDiscount] and customer[discountCardNumber] are received, if they are active in the "Loyalty" module settings. You can pass the custom fields value array in the field customer[customFields]. For the "DataBook" fields the symbol code of value is specified in the data book. For the "Date" field the date in the format Y-m-d is specified. For other field types the exact value is specified. The customer address customer[address] you can specify either in a string form in the customer[address][text] field or in a detailed view, filled all the fields except customer[address][text].

    POST /api/v5/customers/create

  • Write

    The mass recording of customers external ID

    To access the method, the following permission is required customer_write. This method is useful in case of reverse synchronization of customers, which were created in system initially. The store requests customers created in system, and creates them in its own base. When creating of customers in store there are customers' own ID generated (externalId of customers in system notation). Immediately after customers creation the web-store calls method /api/v*/customers/fix-external-ids, keeping in system customers' own ID.

    POST /api/v5/customers/fix-external-ids

  • Write

    Note creation

    To access the method, the following permission is required customer_write. Method creates the note and returns its internal ID in case of success. It is possible to specify manager internal ID, whom the note will be bound to, in the note[managerId] field. It is necessary to specify the note content in the note[text] field. Text length must be not less than 1 symbol and not more than 2000 symbols. It is allowed to use HTML tags (p, a, ul, ol, strong, em, blockquote). When using HTML in text, it is important to follow the semantics and monitor the presence of closing tags, otherwise the system will give an error. It is necessary to specify the customer, whom the note will be bound to, in the note[customer] field. It is possible to do, using internal note[customer][id] or external note[customer][externalId].

    POST /api/v5/customers/notes/create

  • Write

    Batch create/edit customer mobile app push tokens

    To access the method, the following permission is required customer_write.

    POST /api/v5/customers/push-tokens/batch

  • Write

    Packet customers uploading

    To access the method, the following permission is required customer_write. Method allows to upload as packet up to 50 customers. More detailed information on data format you can find in description of method /api/v*/customers/create.

    POST /api/v5/customers/upload

  • Write

    Customer editing

    To access the method, the following permission is required customer_write. Method allows to edit the customer. You may refer to customer either by external customer ID (by=externalId), or by internal ID (by=id). In case of trying to edit the removed customer, the system returns state=removed in the answer. Field contragent[contragentType] can receive 3 values: individual - private individual, legal-entity - legal entity, entrepreneur - individual entrepreneur. For different types of legal entities there are available different set of fields. For type individual all fields are unavailable, for type legal-entity the fields contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate] are unavailable, for type entrepreneur the fields contragent[OGRN], contragent[KPP] are unavailable. The fields customer[personalDiscount] and customer[discountCardNumber] are received, if they are active in the "Loyalty" module settings. You can pass the custom fields value array in the field customer[customFields]. For the "DataBook" fields the symbol code of value is specified in the data book. For the "Date" field the date in the format Y-m-d is specified. For other field types the exact value is specified. The customer address customer[address] you can specify either in a string form in the customer[address][text] field or in a detailed view, filled all the fields except customer[address][text]. The fields customer[addTags] and customer[removeTags] cannot be used together with the field customer[tags]. Values of these fields should be lowercase and should not contain whitespace characters other than regular whitespace and whitespaces at the beginning and end of the string.

    POST /api/v5/customers/{externalId}/edit

  • Write

    Subscribe/unsubscribe customer to mailings

    To access the method, the following permission is required customer_write. Method allows to subscribe or unsubscribe the customer from the mailing list. The array of customer's subscriptions is passed in the field subscriptions[]. If the field subscriptions[][subscription] is not provided, a subscription or unsubscription is made for all subscription types to the channel subscriptions[][channel]. The field subscriptions[][messageId] is used to pass the identifier of the message from which the customer subscribed/unsubscribed. If this message is from a chat, the message identifier in MG is expected.

    POST /api/v5/customers/{externalId}/subscriptions

  • Destructive

    Combining of customers

    To access the method, the following permission is required customer_write. Allows to combine customers. When conflict of fields, only resultCustomer customer data will be saved, other customers data by certain field will be removed. All phones will be added to resultCustomer customer. Customers from customers parameter will be irreversibly removed. While combining of customers the related data will be combined. Up to 50 customers can be combined at once. The operation is performed asynchronously. The successful response success=true means that the operation will be executed but it hasn't been completed yet. The actual result of the operation can be tracked using the /api/v5/customers/history method for those customers that will be deleted when combining (history[][combinedTo] response parameter).

    POST /api/v5/customers/combine

  • Destructive

    Note removing

    To access the method, the following permission is required customer_write.

    POST /api/v5/customers/notes/{id}/delete

Simla API / Corporate customers

  • Read

    Getting the list of corporate customers matched the specified filter

    To access the method, the following permission is required customer_read. The result is returned page by page. In the field pagination there is information on pagination. In the filter[managers][] filters the internal IDs of the system elements are specified. In the filter[managerGroups] filter the symbol codes of the elements are specified. The filter filter[discountCardNumber] is available, if the field "Discount card" in the "Loyalty" module is active. In the following filters filter[ids][] and filter[externalIds][] the array of internal and external identifiers are passed. By filter filter[name] possible to search by customer name and phone. With the help of the filter[customFields][] filter you can search by the custom fields value. For the "Data book" fields the symbol code of data book value is specified. For the "Date" and "Date-time" fields the date is specified in the Y-m-d format. For other field types exactly the value is specified. For the Integer, Numeric, Date and Date-time custom fields the filtration is realized over the range, for other fields types — by the exact value. Filter name is the same as field symbol code. E.g.: for the Date field with the symbol code birth_date there are filters filter[customFields][birth_date][min] and filter[customFields][birth_date][max]. For the DataBook field with the symbol code quality there is multiple filter filter[customFields][quality][]. One of three values can be specified in filter[attachments]: 1 - returns customers, which have no attached files; 2 - returns customers, which have attached files; 3 - returns customers, which have attached files and attachments to letters. One of three values can be specified in the filter[tasksCounts]: 1 - returns customers having no uncompleted tasks; 2 - returns customers with any uncompleted tasks (both expired and not expired ones); 3 - returns only those customers who have expired tasks among uncompleted ones. The fields personalDiscount, cumulativeDiscount and discountCardNumber are returned, if they are active in the settings.

    GET /api/v5/customers-corporate

  • Read

    Getting the corporate customer change history

    To access the method, the following permission is required customer_read. Returns the changes in customer data, which were made in the specified range of dates, or the set of incremental changes for carrying out the permanent synchronization The result is returned per-page. In the field pagination there is an information about the pagination. To paginate through history records, it is necessary to use filter[sinceId]. It is not recommended to use the page parameter. More information about the work with history you can find in other article (https://docs.simla.com/en/Developers/API/APIFeatures/WorkingHistoryAPI).

    GET /api/v5/customers-corporate/history

  • Read

    Getting the notes

    To access the method, the following permission is required customer_read. The result is returned page by page. In the field pagination there is information on pagination. The array of notes internal identifiers is being transferred in filter[ids][]. The arrays of customers internal and external identifiers is being transferred in filter[customerIds][] and filter[customerExternalIds][]. The array of managers internal identifiers is being transferred in filter[managerIds][]. filter[text] allows to get notes on partial coincidence of specified text. filter[createdAtFrom] and filter[createdAtTo] allow to get notes created at specified time interval.

    GET /api/v5/customers-corporate/notes

  • Read

    Getting information on corporate customer

    To access the method, the following permission is required customer_read. Method returns full information on the customer. You may refer to customer either by external customer ID (by=externalId), or by internal ID (by=id). Empty fields without values are not returned. In the managerId field the internal ID of system entity is returned. The fields personalDiscount, cumulativeDiscount and discountCardNumber are returned, if they are active in the "Loyalty" module settings. In the customFields field the value array of custom fields is returned. For the "DataBook" fields the symbol code of data book value is specified. For the date fields the date in the format Y-m-d is specified. For other field types the exact value is specified.

    GET /api/v5/customers-corporate/{externalId}

  • Read

    List of addresses for a corporate customer

    To access the method, the following permission is required customer_read. The result is returned page by page. In the field pagination there is information on pagination. You may refer to customer addresses either by external customer ID (by=externalId), or by internal ID (by=id). If the customer address was specified in the string form it will be returned to the address[text]. If the address was specified in detailed view, there will be returned all delivery filled fields, and in the address[text] there will be automatically generated textual representation of the address.

    GET /api/v5/customers-corporate/{externalId}/addresses

  • Read

    List of companies of a contact person

    To access the method, the following permission is required customer_read. The result is returned page by page. In the field pagination there is information on pagination. You may refer to customer companies either by external customer ID (by=externalId), or by internal ID (by=id). If the customer address was specified in the string form it will be returned to the address[text]. If the address was specified in detailed view, there will be returned all delivery filled fields, and in the address[text] there will be automatically generated textual representation of the address. Field contragent[contragentType] can receive 3 values: individual - private individual, legal-entity - legal entity, entrepreneur - individual entrepreneur. For different types of legal entities there are available different set of fields. For type individual all fields are unavailable, for type legal-entity the fields contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate] are unavailable, for type entrepreneur the fields contragent[OGRN], contragent[KPP] are unavailable.

    GET /api/v5/customers-corporate/{externalId}/companies

  • Read

    List of contact persons of the corporate customer

    To access the method, the following permission is required customer_read. The result is returned page by page. In the field pagination there is information on pagination. You may refer to customer contact person either by external customer ID (by=externalId), or by internal ID (by=id).

    GET /api/v5/customers-corporate/{externalId}/contacts

  • Write

    Corporate customer creation

    To access the method, the following permission is required customer_write. Method creates the customer and returns internal ID of created customer. If customerCorporate[createdAt] is not specified, then current time will be used as the date/time of customer creation. externalId should be unique for customers and corporate customers within one store. To separate different types of customers, it is possible to add a prefix into a string (for example, use i123234 for the customer and l123234 for the corporate customer) Field contragent[contragentType] can receive 3 values: individual - private individual, legal-entity - legal entity, entrepreneur - individual entrepreneur. For different types of legal entities there are available different set of fields. For type individual all fields are unavailable, for type legal-entity the fields contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate] are unavailable, for type entrepreneur the fields contragent[OGRN], contragent[KPP] are unavailable. The fields customerCorporate[personalDiscount] and customerCorporate[discountCardNumber] are received, if they are active in the module settings. You can pass the custom fields value array in the field customerCorporate[customFields]. For the "DataBook" fields the symbol code of value is specified in the data book. For the "Date" field the date in the format Y-m-d is specified. For other field types the exact value is specified. The customer address customerCorporate[addresses] you can specify either in a string form in the customerCorporate[addresses][][text] field or in a detailed view, filled all the fields except customerCorporate[addresses][][text].

    POST /api/v5/customers-corporate/create

  • Write

    The mass recording of corporate customers external ID

    To access the method, the following permission is required customer_write. This method is useful in case of reverse synchronization of customers, which were created in system initially. The store requests customers created in system, and creates them in its own base. When creating of customers in store there are customers' own ID generated (externalId of customers in system notation). Immediately after customers creation the web-store calls method /api/v*/customers-corporate/fix-external-ids, keeping in system customers' own ID. externalId should be unique for customers and corporate customers within one store. To separate different types of customers, it is possible to add a prefix into a string (for example, use i123234 for the customer and l123234 for the corporate customer)

    POST /api/v5/customers-corporate/fix-external-ids

  • Write

    Note creation

    To access the method, the following permission is required customer_write. Method creates the note and returns its internal ID in case of success. It is possible to specify manager internal ID, whom the note will be bound to, in the note[managerId] field. It is necessary to specify the note content in the note[text] field. Text length must be not less than 1 symbol and not more than 2000 symbols. It is allowed to use HTML tags (p, a, ul, ol, strong, em, blockquote). When using HTML in text, it is important to follow the semantics and monitor the presence of closing tags, otherwise the system will give an error. It is necessary to specify the customer, whom the note will be bound to, in the note[customer] field. It is possible to do, using internal note[customer][id] or external note[customer][externalId].

    POST /api/v5/customers-corporate/notes/create

  • Write

    Packet corporate customers uploading

    To access the method, the following permission is required customer_write. Method allows to upload as packet up to 50 customers. More detailed information on data format you can find in description of method /api/v*/customers-corporate/create.

    POST /api/v5/customers-corporate/upload

  • Write

    Creating an address for a corporate customer

    To access the method, the following permission is required customer_write. The customer address address you can specify either in a string form in the address[text] field or in a detailed view, filled all the fields except address[text]. No more than 100 addresses can be created for a customer.

    POST /api/v5/customers-corporate/{externalId}/addresses/create

  • Write

    Editing the address of the corporate customer

    To access the method, the following permission is required customer_write. You may refer to customer addresses either by external customer ID (by=externalId), or by internal ID (by=id). You may edit customer address (entityExternalId) either by external customer address ID (entityBy=externalId), or by internal ID (entityBy=id). The customer address address you can specify either in a string form in the address[text] field or in a detailed view, filled all the fields except address[text].

    POST /api/v5/customers-corporate/{externalId}/addresses/{entityExternalId}/edit

  • Write

    Creating a company for a corporate customer

    To access the method, the following permission is required customer_write. Field contragent[contragentType] can receive 3 values: individual - private individual, legal-entity - legal entity, entrepreneur - individual entrepreneur. For different types of legal entities there are available different set of fields. For type individual all fields are unavailable, for type legal-entity the fields contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate] are unavailable, for type entrepreneur the fields contragent[OGRN], contragent[KPP] are unavailable. You can pass the custom fields value array in the field company[customFields]. For the "DataBook" fields the symbol code of value is specified in the data book. For the "Date" field the date in the format Y-m-d is specified. For other field types the exact value is specified.

    POST /api/v5/customers-corporate/{externalId}/companies/create

  • Write

    Editing the company of the corporate customer

    To access the method, the following permission is required customer_write. You may refer to customer companies either by external customer ID (by=externalId), or by internal ID (by=id). You may edit customer company (entityExternalId) either by external customer company ID (entityBy=externalId), or by internal ID (entityBy=id). Field contragent[contragentType] can receive 3 values: individual - private individual, legal-entity - legal entity, entrepreneur - individual entrepreneur. For different types of legal entities there are available different set of fields. For type individual all fields are unavailable, for type legal-entity the fields contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate] are unavailable, for type entrepreneur the fields contragent[OGRN], contragent[KPP] are unavailable. You can pass the custom fields value array in the field company[customFields]. For the "DataBook" fields the symbol code of value is specified in the data book. For the "Date" field the date in the format Y-m-d is specified. For other field types the exact value is specified.

    POST /api/v5/customers-corporate/{externalId}/companies/{entityExternalId}/edit

  • Write

    Creating a link between a corporate customer and a contact person

    To access the method, the following permission is required customer_write.

    POST /api/v5/customers-corporate/{externalId}/contacts/create

  • Write

    Editing the link between the corporate customer and the contact person

    To access the method, the following permission is required customer_write. You may refer to customer contact person either by external customer ID (by=externalId), or by internal ID (by=id). You may edit customer contact person (entityExternalId) either by external customer contact person ID (entityBy=externalId), or by internal ID (entityBy=id).

    POST /api/v5/customers-corporate/{externalId}/contacts/{entityExternalId}/edit

  • Write

    Corporate customer editing

    To access the method, the following permission is required customer_write. Method allows to edit the customer. In case of trying to edit the removed customer, the system returns state=removed in the answer. The fields customer[personalDiscount] and customer[discountCardNumber] are received, if they are active in the "Loyalty" module settings. You can pass the custom fields value array in the field customer[customFields]. For the "DataBook" fields the symbol code of value is specified in the data book. For the "Date" field the date in the format Y-m-d is specified. For other field types the exact value is specified.

    POST /api/v5/customers-corporate/{externalId}/edit

  • Destructive

    Combining of corporate customers

    To access the method, the following permission is required customer_write. Allows to combine customers. When conflict of fields, only resultCustomer customer data will be saved, other customers data by certain field will be removed. All addresses, companies and contact persons will be added to resultCustomer customer. Customers from customers parameter will be irreversibly removed. While combining of customers the related data will be combined. Up to 50 customers can be combined at once.

    POST /api/v5/customers-corporate/combine

  • Destructive

    Note removing

    To access the method, the following permission is required customer_write.

    POST /api/v5/customers-corporate/notes/{id}/delete

Simla API / Customer actions on the site of the store

  • Read

    Getting the current cart of the customer

    To access the method, the following permission is required customer_interaction_read. In the {site} parameter you can transfer either the symbol code of the store or the store ID. The symbol code will be used by default. To use the store ID you also have to transfer the siteBy=id parameter.

    GET /api/v5/customer-interaction/{site}/cart/{customerId}

  • Read

    Getting a list of favorites for the customer

    To access the method, the following permission is required customer_interaction_read. In the {site} parameter you can transfer either the symbol code of the store or the store ID. The symbol code will be used by default. To use the store ID you also have to transfer the siteBy=id parameter.

    GET /api/v5/customer-interaction/{site}/favorites/{customerId}

  • Write

    Cleaning the current cart of the customer

    To access the method, the following permission is required customer_interaction_write. In the {site} parameter you can transfer either the symbol code of the store or the store ID. The symbol code will be used by default. To use the store ID you also have to transfer the siteBy=id parameter. If an order is created from the cart, it is passed to this method

    POST /api/v5/customer-interaction/{site}/cart/clear

  • Write

    Creating or overwriting cart data

    To access the method, the following permission is required customer_interaction_write. In the {site} parameter you can transfer either the symbol code of the store or the store ID. The symbol code will be used by default. To use the store ID you also have to transfer the siteBy=id parameter. If the store's customer has a shopping cart with the empty value for clearedAt, the request will overwrite the cart data. Otherwise, a new cart will be created

    POST /api/v5/customer-interaction/{site}/cart/set

  • Write

    Adding a product offer to the customer's list of favorites

    To access the method, the following permission is required customer_interaction_write. In the {site} parameter you can transfer either the symbol code of the store or the store ID. The symbol code will be used by default. To use the store ID you also have to transfer the siteBy=id parameter. If the product offer is already in the list of favorites, a successful response success=true is returned. The maximum number of product offers in the list of favorites is 1000. When adding a new product offer in excess of the specified limit, an unsuccessful response success=false is returned.

    POST /api/v5/customer-interaction/{site}/favorites/{customerId}/add

  • Destructive

    Deleting a product offer from the customer's list of favorites

    To access the method, the following permission is required customer_interaction_write. In the {site} parameter you can transfer either the symbol code of the store or the store ID. The symbol code will be used by default. To use the store ID you also have to transfer the siteBy=id parameter. If the product offer is not in the list of favorites, a successful response is returned success=true.

    POST /api/v5/customer-interaction/{site}/favorites/{customerId}/remove

Simla API / Deliveries

  • Read

    Getting the list of shipments to delivery services

    To access the method, the following permission is required delivery_read.

    GET /api/v5/delivery/shipments

  • Read

    Getting information on shipment

    To access the method, the following permission is required delivery_read. The set of fields depends on delivery type.

    GET /api/v5/delivery/shipments/{id}

  • Write

    Calculation of the delivery cost

    The method calculates the delivery cost for the selected delivery types (deliveryTypeCodes).

    POST /api/v5/delivery/calculate

  • Write

    Updating of delivery statuses

    To access the method, the following permission is required delivery_write. Method allows to transmit statuses separately for each order at the moment of status change or transmit the history of changes for orders group in definite intervals at the discretion of delivery service Important: Per one request it is possible to update statuses not more than for 100 orders. When transferring a larger number of orders, the method will return error message.

    POST /api/v5/delivery/generic/{subcode}/tracking

  • Write

    Shipment creation

    To access the method, the following permission is required delivery_write. The set of fields depends on delivery type.

    POST /api/v5/delivery/shipments/create

  • Write

    Shipment editing

    To access the method, the following permission is required delivery_write. Shipment editing is available only for shipments in created status The set of fields depends on delivery type.

    POST /api/v5/delivery/shipments/{id}/edit

Simla API / Files

  • Read

    Getting the list of files according to the selected filter

    To access the method, the following permission is required file_read. Method returns the list of files and information about them. Only files uploaded via API are returned or files added to an order, customer, or customer service ticket. Array of internal IDs of elements in the system is specified in filters filter[ids][], filter[orderIds][], filter[customerIds][], filter[ticketIds][]. Array of external IDs of elements in the system is specified in filters filter[customerExternalIds][], filter[orderExternalIds][], filter[ticketExternalIds][]. Array of MIME types of files is specified in filter filter[type][].

    GET /api/v5/files

  • Read

    Getting information about the file

    To access the method, the following permission is required file_read.

    GET /api/v5/files/{id}

  • Read

    File downloading

    To access the method, the following permission is required file_read. Method allows to download the file. When downloading, the file content is returned as a stream, the file name is returned in the Content-Disposition HTTP header.

    GET /api/v5/files/{id}/download

  • Write

    Uploading the file to server

    To access the method, the following permission is required file_write. Method allows to upload the file. For uploading the file, it is necessary to insert its content into the query body. Some file types are prohibited for uploading. The name API upload is automatically assigned to the file uploaded via API.

    POST /api/v5/files/upload

  • Destructive

    Deleting the file

    To access the method, the following permission is required file_write. Method allows to delete the file with all links to orders, customers, and customer service tickets.

    POST /api/v5/files/{id}/delete

  • Destructive

    Editing the file

    To access the method, the following permission is required file_write. Method allows to edit the file name and links to orders, customers, and customer service tickets. All required links are passed in file[attachment][]. Links not mentioned in this field will be deleted. To attach a file to a customer service ticket, pass its id, externalId, or number in file[attachment][][ticket]. The fields are processed in that order. When searching by externalId or number, also pass the store code in site. The search is limited to stores available to the API key.

    POST /api/v5/files/{id}/edit

Simla API / Integration

  • Read

    Getting the integration module

    To access the method, the following permission is required integration_read. Module can have one or many different types of configuration, or not have any of configurations. Delivery service (https://docs.simla.com/en/Developers/API/APIFeatures/DeliveryApi#h-2) delivery Payment system (https://docs.simla.com/en/Developers/API/APIFeatures) payment Warehouse system (https://docs.simla.com/en/Developers/API/APIFeatures) store Telephony (https://docs.simla.com/en/Developers/API/APIFeatures) telephony Instant messaging (https://docs.simla.com/en/Developers/API/APIFeatures/MgTransport) mgTransport MessageGateway Bot (https://docs.simla.com/en/Developers/API/APIFeatures/MgBot) mgBot

    GET /api/v5/integration-modules/{code}

  • Write

    Integration module creation/editing

    To access the method, the following permission is required integration_write. For receiving notifications about module activation/deactivation or freezing/unfreezing specify baseUrl and path to activity callback - integrationModule[actions][activity] Important! Since 2026, it will be possible to edit the module only using the related API key (the one with which the module was created or updated using the /api/v5/integration-modules/{code}/update-scopes method). For old modules that do not have a fixed API key, editing will be available with any API key that has permissions to manage integration modules. Module can have one or many different types of configuration, or not have any of configurations. Recommendations service (https://docs.simla.com/en/Developers/API/APIFeatures) (recommendation) The availability of configurations of this type gives access to use methods from the section "Recommendations". Delivery service (https://docs.simla.com/en/Developers/API/APIFeatures/DeliveryApi#h-2) (delivery) This type of configuration allows module to use methods from "Deliveries" section. Payment system (https://docs.simla.com/en/Developers/API/APIFeatures) (payment) Configuration of this type allows to use methods from “Payments” section. Warehouse system (https://docs.simla.com/en/Developers/API/APIFeatures) (store) This type of configuration allows module to use method {integrationModule["integrations"]["store"]["actions"]["inventoriesUpload"]} from "Store" section. Instant messaging (https://docs.simla.com/en/Developers/API/APIFeatures/MgTransport) (mgTransport) Configuration of a such type allows to integrate external messengers with the system. MessageGateway Bot (https://docs.simla.com/en/Developers/API/APIFeatures/MgBot) (mgBot) Configuration of a such type allows to integrate MessageGateway Bots. Telephony (https://docs.simla.com/en/Developers/API/APIFeatures) (telephony) This type of configuration allows module to use methods from "Telephony" section. Field integrationModule[integrations][telephony][inputEventSupported] contains information, does the service support notifications about incoming call. Default value is 0. Field integrationModule[integrations][telephony][outputEventSupported] contains information, does the service support notifications about outgoing call. Default value is 0. Field integrationModule[integrations][telephony][hangupEventSupported] contains information, does the service support notification about call completion. Default value is 0. The field integrationModule[integrations][telephony][additionalCodes] contains JSON, where there is an array of mapping: user id and code - extension code in telephony. The field integrationModule[integrations][telephony][externalPhones] contains JSON, where there is an array of mapping: siteCode - store code and externalPhone - external phone number. If there are several external numbers specified for one store, the last one will be chosen when initiating the call from this store. If the field integrationModule[integrations][telephony][changeUserStatusUrl] specified, when changing the manager status in system to the specified address will be sent GET request. If the module is created or edited successfully, the response will contain information on the cost of the module (the information will be specified in the info[billingInfo] field). If the module isn't published in the marketplace, the information isn't transferred.

    POST /api/v5/integration-modules/{code}/edit

  • Write

    Updating permissions for the API key

    To access the method, the following permission is required integration_write. The method allows to get a new API key with the permissions that were passed in the request for the integrated module. Important! Since 2026, it will be possible to update the module only using the related API key (the one with which the module was created or updated using this method). For old modules that do not have a fixed API key, updating will be available with any API key that has permissions to manage integration modules. This method is available for modules that support simple connection and can also be used to update API keys by modules that were connected in an outdated way via the creation of API keys in the system interface.

    POST /api/v5/integration-modules/{code}/update-scopes

Simla API / Knowledge base

  • Read

    Getting the list of knowledge base documents matching the filter

    To access the method, the following permission is required knowledge_base_read. Documents are returned with Markdown text and a link to the original file if one is attached. filter[sectionId] selects documents of the section together with its subsections, with filter[directOnly]=1 — only directly in the section; filter[directOnly]=1 without a section — documents without a section. A file is attached to a document with /api/v5/files/upload and /api/v5/files/{id}/edit (field attachment[][knowledgeBaseDocument][id]); a document has one file. The list is paginated with a cursor: pagination.nextCursor in the response is the cursor of the first document on the next page, pass it in the cursor parameter; an empty cursor means the last page. The total number of documents is not returned.

    GET /api/v5/knowledge-base/documents

  • Read

    Getting the change history of knowledge base documents

    To access the method, the following permission is required knowledge_base_read. History is kept for documents; sections are not written to history. Use filter[sinceId] to load changes since the previous request. The document text is not stored in history: the content row carries a hash of the text. The file row carries the attached or removed file.

    GET /api/v5/knowledge-base/documents/history

  • Read

    Getting a knowledge base document

    To access the method, the following permission is required knowledge_base_read.

    GET /api/v5/knowledge-base/documents/{id}

  • Read

    Getting the list of knowledge base sections

    To access the method, the following permission is required knowledge_base_read.

    GET /api/v5/knowledge-base/sections

  • Write

    Knowledge base document creation

    To access the method, the following permission is required knowledge_base_write.

    POST /api/v5/knowledge-base/documents/create

  • Write

    Knowledge base document editing

    To access the method, the following permission is required knowledge_base_write.

    POST /api/v5/knowledge-base/documents/{id}/edit

  • Write

    Knowledge base section creation

    To access the method, the following permission is required knowledge_base_write.

    POST /api/v5/knowledge-base/sections/create

  • Write

    Knowledge base section editing

    To access the method, the following permission is required knowledge_base_write.

    POST /api/v5/knowledge-base/sections/{id}/edit

  • Destructive

    Knowledge base document deletion

    To access the method, the following permission is required knowledge_base_write.

    POST /api/v5/knowledge-base/documents/{id}/delete

  • Destructive

    Knowledge base section deletion

    To access the method, the following permission is required knowledge_base_write. The section is deleted together with all its subsections and their documents.

    POST /api/v5/knowledge-base/sections/{id}/delete

Simla API / Loyalty

  • Read

    Getting information about participation in the loyalty program

    To access the method, the following permission is required loyalty_read.

    GET /api/v5/loyalty/account/{id}

  • Read

    History of the bonus account for a specific participation

    To access the method, the following permission is required loyalty_read. This method allows to get the history of the bonus account for participation in the loyalty program. The bonusOperations[][type] field contains the type of action that led to the change of the bonus account. Possible values: credit_for_order - accrual for the order burn - expiration credit_for_event - accrual for the event charge_for_order - redemption for the order charge_manual - redeemed manually import - bonus balance import cancel_of_charge - cancellation of redemption cancel_of_credit - cancellation of accrual The bonusOperations[][amount] field contains the amount of redeemed, expired or accrued bonuses. If bonuses were accrued, the value is positive, if they were redeemed or expired - negative.

    GET /api/v5/loyalty/account/{id}/bonus/operations

  • Read

    Getting details on the bonus account

    To access the method, the following permission is required loyalty_read. The method allows to get detailed information about bonuses in the statuses "Waiting for activation" waiting_activation and "Will expire soon" burn_soon. The filter[date] parameter filters depending on the transferred status If the status is waiting_activation - inactive bonuses with the activation date up to and including the date passed in the filter If the status is burn_soon - bonuses that will expire up to and including the date passed in the filter

    GET /api/v5/loyalty/account/{id}/bonus/{status}/details

  • Read

    List participation in the loyalty program

    To access the method, the following permission is required loyalty_read. Method returns a list of participations in the loyalty program.

    GET /api/v5/loyalty/accounts

  • Read

    History of the bonus account for all participations

    To access the method, the following permission is required loyalty_read. This method allows to get the history of the bonus account for all participations in all loyalty programs The bonusOperations[][type] field contains the type of action that led to the change of the bonus account. Possible values: credit_for_order - accrual for the order burn - expiration credit_for_event - accrual for the event charge_for_order - redemption for the order charge_manual - redeemed manually import - bonus balance import cancel_of_charge - cancellation of redemption cancel_of_credit - cancellation of accrual The bonusOperations[][amount] field contains the amount of redeemed, expired or accrued bonuses. If bonuses were accrued, the value is positive, if they were redeemed or expired - negative.

    GET /api/v5/loyalty/bonus/operations

  • Read

    Calculation of a maximum discount

    To access the method, the following permission is required loyalty_read. This method calculates the maximum discount for a customer taking into account a personal discount or loyalty level or event. The method allows transferring the estimated number of bonuses to be redeemed (only for calculations) in the bonuses parameter, 0 by default. The privilegeType field can contain one of the following values: personal_discount - the customer’s personal discount; loyalty_level - calculation of a discount or bonus accrual based on the level settings of the customer’s Loyalty Program; loyalty_event - calculation of the discount on the event of the Loyalty Program; none - do not apply discounts of the Loyalty Program to the order;

    POST /api/v5/loyalty/calculate

  • Read

    List of loyalty programs

    To access the method, the following permission is required loyalty_read. The method returns a list of loyalty programs

    GET /api/v5/loyalty/loyalties

  • Read

    Getting information about the loyalty program

    To access the method, the following permission is required loyalty_read.

    GET /api/v5/loyalty/loyalties/{id}

  • Write

    Adding a customer to the loyalty program

    To access the method, the following permission is required loyalty_write. Method checks the possibility of customer participation in the loyalty program and adds the customer In the settings for the Loyalty Program it is possible to specify a list of fields required for filling in in the customer and participation card. If not all of the specified fields are filled in, the corresponding message is displayed in the response in the warnings field. If the required fields are not set up and there is no requirement to confirm activation by SMS or all the required fields are transferred, then the participation is created active. Otherwise, it is created inactive. When the participation is inactive, it is not possible to redeem bonuses and apply discount privileges. One of the following fields must also be filled in: phoneNumber or cardNumber

    POST /api/v5/loyalty/account/create

  • Write

    Activation of participation in the loyalty program

    To access the method, the following permission is required loyalty_write. The method allows you to activate the created participation. If the setting of registration in the loyalty program "Confirmation of registration by SMS" is enabled, it is required to specify a phone number in the participation of the loyalty program. An SMS message will be sent to this phone number confirming the activation of the participation in the program. The activation will be performed only after the confirmation via the SMS code. To resend SMS, call this method again. Resending is available in 60 seconds. The validity of the SMS code is 5 minutes. If it is not required to send an SMS for activation, the activation will be performed according to the settings of the loyalty program and the LoyaltyAccount object will be returned in the response. In case of confirmation via SMS, the SmsVerification object will also be returned. The code received by SMS must be sent in the method of verification confirmation specifying the checkId parameter.

    POST /api/v5/loyalty/account/{id}/activate

  • Write

    Charging off bonuses to a loyalty program participant

    To access the method, the following permission is required loyalty_write. The method allows to charge off bonuses to a loyalty program participant.

    POST /api/v5/loyalty/account/{id}/bonus/charge

  • Write

    Accrual of bonuses for participation in the loyalty program

    To access the method, the following permission is required loyalty_write. This method allows to accrue bonuses for participation in the loyalty program. If the activation date of bonuses activationDate wasn’t passed, bonuses will be activated in accordance with the settings of the loyalty program If the expiration date of bonuses expireDate wasn’t not passed, bonuses will expire in accordance with the settings of the loyalty program

    POST /api/v5/loyalty/account/{id}/bonus/credit

  • Write

    Editing participation in the loyalty program

    To access the method, the following permission is required loyalty_write. Method for editing participation in the loyalty program. An error will be returned when trying to change the verified phone number.

    POST /api/v5/loyalty/account/{id}/edit

Simla API / Notifications

  • Write

    Sending notification

    To access the method, the following permission is required notification_write. The method sends notifications to recipients that are specified in mutually exclusive fields: notification[userIds], notification[userGroups]. Via notification[userIds] you can transfer an array of identifiers of users existing in the system. All array elements must be of type integer. At the moment, the only valid value of the notification[userGroups] field can be the code of the superadmins group. Only one of the fields notification[userIds] or notification[userGroups] should be filled in the request. The notification[type] field can get the following values: api.info - informational, api.error - error. The notification[message] field allows the use of HTML-code. To ensure the security of using notifications only certain HTML-tagsare allowed in the message text: <b></b>, <i></i>, <strong></strong>, <em></em>, <br>, <span>, <div>, <p>, <a href=""></a>. Message length should not exceed 160 characters, excluding tags. When using this method, keep in mind that for each user there is a limit of notifications that he can receive over a period of time from one api key. When sending to multiple recipients at once, the user limit with the minimum notification balance is used. Notifications are not sent if the list of recipients contains a user with zero balance of available notifications. Depending on the type of notification there are two limitations: notification with api.error type has a limit of 3 messages from the module for a user over the last hour; notification with api.info type has a limit of 10 notifications from the module for a user over the last 30 minutes. Information about limits is returned in the response headers: X-RateLimit-Remaining - number of available notifications; X-RateLimit-Retry-After - the time when the notifications will be available again; X-RateLimit-Limit - limit of notifications.

    POST /api/v5/notifications/send

Simla API / Orders

  • Read

    Getting the list of orders matched the specified filter

    To access the method, the following permission is required order_read. The result is returned page by page. In the field pagination there is information on pagination. In the filters filter[managers][], filter[couriers][] the internal IDs of the system elements are specified. In the filters filter[orderTypes][], filter[paymentStatuses][], filter[paymentTypes][], filter[deliveryTypes][], filter[orderMethods][], filter[managerGroups][] the symbol codes of the elements are specified. In the filters filter[sourceName], filter[mediumName], filter[campaignName], filter[keywordName], filter[adContentName] the name of the elements are specified. In the filter filter[number] the exact comparison with the specified string expression is carried out. In the following filters filter[ids][] and filter[externalIds][] the array of internal and external identifiers are passed. In the filter filter[extendedStatus][] you can specify one or more statuses or order status groups. For filtration by status the symbol code of status is passed. For filtration by the status group the symbol code of status group and the postfix -group are passed. E.g.: filter[extendedStatus][]=new&filter[extendedStatus][]=approval-group. The filter filter[statusHistorySequence][] accepts only an array of step tokens: filter[statusHistorySequence][0]=..., filter[statusHistorySequence][1]=... and so on. Each step must be either an order status internal ID or a status group token in the format <groupId>-group. Group token matches any status from that group at the selected step. Correct example: filter[statusHistorySequence][0]=12-group&filter[statusHistorySequence][1]=34&filter[statusHistorySequence][2]=56. Unsupported examples: filter[statusHistorySequence]=12,34,56, filter[statusHistorySequence][]=new, filter[statusHistorySequence][]=approval-group. The filter uses strict sequence matching: only neighboring status transitions in history are considered. If there is another status between two selected steps, the order will not be included in the result. With the help of the filter[customFields][] filter you can search by the custom fields value. For the "Data book" fields the symbol code of data book value is specified. For the "Date" and "Date-time" fields the date is specified in the Y-m-d format. For other field types exactly the value is specified. For the Integer, Numeric, Date and Date-time custom fields the filtration is realized over the range, for other fields types — by the exact value. Filter name is the same as field symbol code. E.g.: for the Date field with the symbol code birth_date there are filters filter[customFields][birth_date][min] and filter[customFields][birth_date][max]. For the DataBook field with the symbol code quality there is multiple filter filter[customFields][quality][]. One of three values can be specified in filter[attachments]: 1 - returns orders, which have attached files and attachments to letters; 2 - returns orders, which have attached files; 3 - returns orders, which have no attached files. One of three values can be specified in the filter[tasksCounts]: 1 - returns orders having no uncompleted tasks; 2 - returns orders with any uncompleted tasks (both expired and not expired ones); 3 - returns only those orders which have expired tasks among uncompleted ones. The filter[mgChannels] filter specifies an array of internal IDs of channels in the system. The filter selects orders created via the right-hand chat widget. Empty fields without values are not returned. In the fields orderType, orderMethod, payments[][type], payments[][status], status, site, delivery[code] the symbol code of the element is returned. In the fields managerId, sourceId the internal ID of the system entity is returned. In the customFields field the value array of custom fields is returned. For the "DataBook" fields the symbol code of data book value is specified. For the date fields the date in the format Y-m-d is specified. For other field types the exact value is specified. If the customer address was specified in the string form it will be returned to the delivery[address][text]. If the address was specified in detailed view, there will be returned all delivery filled fields, and in the delivery[address][text] there will be automatically generated textual representation of the address. The privilegeType field can contain one of the following values: personal_discount - the customer’s personal discount; loyalty_level - calculation of a discount or bonus accrual based on the level settings of the customer’s Loyalty Program; loyalty_event - calculation of the discount on the event of the Loyalty Program; none - do not apply discounts of the Loyalty Program to the order;

    GET /api/v5/orders

  • Read

    Getting the order change history

    To access the method, the following permission is required order_read. Returns the changes in order data, which were made in the specified range of dates (using filter[startDate] and filter[endDate] filters) or the set of incremental changes for carrying out the permanent synchronization (using filter[sinceId] filter) Full set of fields in corresponding 'order' or 'item' keys is returned for order creating or removal entries. When adding item to order, fieldName=order_product entry is displayed in the history. By that full object in "item" context is available and only identificating fields are pointed out in "newValue" field. The result is returned per-page. In the field pagination there is an information about the pagination. To paginate through history records, it is necessary to use filter[sinceId]. It is not recommended to use the page parameter. More information about the work with history you can find in other article (https://docs.simla.com/en/Developers/API/APIFeatures/WorkingHistoryAPI).

    GET /api/v5/orders/history

  • Read

    Getting the list of order statuses

    To access the method, the following permission is required order_read. Returns statuses (and status groups) of orders, id or externalId of which were specified in parameters of query ids[] and externalIds[]. You may specify summarily up to 500 ids. if specified both ids[], and externalIds[], then order searching is carried out by all specified ids.

    GET /api/v5/orders/statuses

  • Read

    Getting information on order

    To access the method, the following permission is required order_read. Method returns full information on the order. You may refer to order either by external order ID (by=externalId), or by internal ID (by=id). Field contragent[contragentType] can receive 3 values: individual - private individual, legal-entity - legal entity, entrepreneur - individual entrepreneur. For different types of legal entities there are available different set of fields. For type individual all fields are unavailable, for type legal-entity the fields contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate] are unavailable, for type entrepreneur the fields contragent[OGRN], contragent[KPP] are unavailable. Empty fields without values are not returned. In the fields orderType, orderMethod, payments[][type], payments[][status], status, site, delivery[code] the symbol code of the element is returned. In the fields managerId, sourceId the internal ID of the system entity is returned. In the customFields field the value array of custom fields is returned. For the "DataBook" fields the symbol code of data book value is specified. For the date fields the date in the format Y-m-d is specified. For other field types the exact value is specified. If the customer address was specified in the string form it will be returned to the delivery[address][text]. If the address was specified in detailed view, there will be returned all delivery filled fields, and in the delivery[address][text] there will be automatically generated textual representation of the address. The privilegeType field can contain one of the following values: personal_discount - the customer’s personal discount; loyalty_level - calculation of a discount or bonus accrual based on the level settings of the customer’s Loyalty Program; loyalty_event - calculation of the discount on the event of the Loyalty Program; none - do not apply discounts of the Loyalty Program to the order;

    GET /api/v5/orders/{externalId}

  • Read

    Getting the file of the printed form for the order

    To access the method, the following permission is required order_read. This method allows to download the generated printed form for the template with id={plateId} in the context of the specified order. When downloading, the content of the file is given as a stream, the name of the file is given in the HTTP header Content-Disposition.

    GET /api/v5/orders/{externalId}/plates/{plateId}/print

  • Write

    Combining of orders

    To access the method, the following permission is required order_write. Allows to combine orders. Order items in resultOrder parameter will be combined with order items of order, after that the order will be irreversibly removed. The operation is performed asynchronously. The successful response success=true means that the operation will be executed but it hasn't been completed yet. The actual result of the operation can be tracked using the /api/v5/orders/history method for those orders that will be deleted when combining (history[][combinedTo] response parameter). In technique parameter you can specify the strategy of combining in case if there are similar items in orders ours to use item quantity from current order summ to summarize item quantity in both orders theirs to use item quantity from order being combined

    POST /api/v5/orders/combine

  • Write

    Order creation

    To access the method, the following permission is required order_write. Method creates the order and returns internal ID of created order. If order[createdAt] is not specified, then current time will be used as the date/time of order creation. If you need to attach the order to the current customer, you should pass the customer external ID to the field order[customer][externalId], the customer internal ID to the field order[customer][id] or the customer ID in Daemon Collector in order[customer][browserId]. The search of the customer will be realized under the stores, to which the used API-key has an access. If the order[customer] is not specified, the customer will be created automatically based on the order data. Field contragent[contragentType] can receive 3 values: individual - private individual, legal-entity - legal entity, entrepreneur - individual entrepreneur. For different types of legal entities there are available different set of fields. For type individual all fields are unavailable, for type legal-entity the fields contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate] are unavailable, for type entrepreneur the fields contragent[OGRN], contragent[KPP] are unavailable. In the fields order[orderType], order[orderMethod], order[payments][][type], order[payments][][status], order[status], order[shipmentStore], order[delivery][code], order[items][][status] the symbol code of the element is specified. In the fields order[managerId], order[sourceId] the internal ID of the system entity is specified. The comment order[statusComment] cannot be changed without changing the order status order[status]. Order items are specified in the field order[items][]. The products that were not passed in the request for editing are deleted from the order. If item is in the catalog, then it is necessary to set the value for one of the following fields: order[items][][offer][id] – SKU ID; order[items][][offer][externalId] – external ID of item or SKU; order[items][][offer][xmlId] – SKU ID in the warehouse system. If the values are set for several fields, they will be processed in the following above order. In case, if the ofeer will be not found by any of criteria, the order item will be automatically created based on data from fields order[items][][initialPrice], order[items][][purchasePrice], order[items][][productName]. The delivery address order[delivery][address] you can specify either in the string form in the order[delivery][address][text] field, or in the detailed view, filling all the fields except order[delivery][address][text]. In the order[customFields] field you can pass the values array of custom fields. For the "DataBook" fields the symbol code of data book value is specified. For the "Date" fields the date in the format Y-m-d is specified. For other field types the exact value is specified. For working with price types, more than one price type must be enabled in data book. For transferring the price type for order item, code of necessary price type must be transferred to order[items][][priceType][code] field. It is recommended to transfer actual value of item price together with price type to order[items][][initialPrice]. If order[items][][priceType][code] price type is transferred without the order[items][][initialPrice] price value, then the current value of this price type for the current item will be taken for the item price. For new item it is recommended always to transfer order[items][][initialPrice] price clearly, in case if actual price has not been downloaded to system yet. If not to transfer order[items][][priceType][code] price type for the item, then price type for the item in order will be No type. In case if there is only the basic price type in the system, then order[items][][priceType][code] parameter should not be considered. The order of order items order[items][] is saved in response. Parameters order[items][][externalId] and order[items][][externalIds] are optional. Either external ID value order[items][][externalId] or array of external IDs order[items][][externalIds] can be specified at the same time. The external ID value order[items][][externalId] will be written to the array order[items][][externalIds] with default code. Values of external identifiers order[items][][externalIds][][value] should be unique by code order[items][][externalIds][][code] within one order. The privilegeType field can contain one of the following values: personal_discount - the customer’s personal discount; loyalty_level - calculation of a discount or bonus accrual based on the level settings of the customer’s Loyalty Program; loyalty_event - calculation of the discount on the event of the Loyalty Program; none - do not apply discounts of the Loyalty Program to the order; To apply the Loyalty Program to an order, the following conditions must be met: the store of the order must coincide with the store of the necessary Loyalty Program; participation in the Loyalty Program must be created for the customer in the order; the privilegeType field must be specified with none by default; If the loyalty_event value is specified in privilegeType and the event gives a discount, then it is required to specify the ID in the loyaltyEventDiscountId field

    POST /api/v5/orders/create

  • Write

    The mass recording of orders external ID

    To access the method, the following permission is required order_write. This method is useful in case of reverse synchronization of orders, which were created in system initially. It is recommended to use the following script of order reverse synchronization between web store and system. Web store periodically requests method /api/v*/orders/history. On the basis of received data the store applies changes to existing orders, and also creates new orders, created in system initially. When creating of orders in store there are orders' own ID generated (externalId of orders in system notation). Immediately after customers creation the web-store calls method /api/v*/orders/fix-external-ids, keeping in system orders' own ID.

    POST /api/v5/orders/fix-external-ids

  • Write

    Creating a link between orders

    To access the method, the following permission is required order_write. The method allows to link several orders together.

    POST /api/v5/orders/links/create

  • Write

    Applying bonuses according to the loyalty program

    To access the method, the following permission is required order_write. Method to apply bonuses according to the loyalty program. If the setting of the bonus account of the loyalty program "Confirm redemption by SMS" is enabled, it is required to specify a phone number in the participation of the loyalty program. An SMS message will be sent to this phone number confirming that bonuses will be redeemed. The redemption will be made only after the confirmation via the SMS code. To resend SMS, call this method with the current parameters again. Resending is available in 60 seconds. The validity of the SMS code is 5 minutes. If it is not required to send an SMS to confirm the redemption of bonuses, the bonuses will be redeemed and the SerializedLoyaltyOrder object will be returned in the response. In case of confirmation via SMS, the SmsVerification object will be returned.

    POST /api/v5/orders/loyalty/apply

  • Write

    Payment creation

    To access the method, the following permission is required order_write. Method adds payment to the order and returns internal ID of created payment. For specifying the order, which payment is related to, it is necessary to set the value for one of the following field: payment[order][id] - order internal ID payment[order][externalId] - order external ID payment[order][number] - order number

    POST /api/v5/orders/payments/create

  • Write

    Payment editing

    To access the method, the following permission is required order_write. Methods allows to change the payment. Change of payment[externalId] is available only when referring to payment by id (by=id), otherwise (by=externalId) transferred value will be ignored.

    POST /api/v5/orders/payments/{id}/edit

  • Write

    Packet orders uploading

    To access the method, the following permission is required order_write. Method allows to upload as packet up to 50 orders. More detailed information on data format you can find in description of method /api/v*/orders/create.

    POST /api/v5/orders/upload

  • Write

    Order editing

    To access the method, the following permission is required order_write. Method allows to edit the order. You may refer to order either by external order ID (by=externalId), or by internal ID (by=id). In case of trying to edit the removed order, the system returns state=removed in the answer. Field contragent[contragentType] can receive 3 values: individual - private individual, legal-entity - legal entity, entrepreneur - individual entrepreneur. For different types of legal entities there are available different set of fields. For type individual all fields are unavailable, for type legal-entity the fields contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate] are unavailable, for type entrepreneur the fields contragent[OGRN], contragent[KPP] are unavailable. In the fields order[orderType], order[orderMethod], order[status], order[shipmentStore], order[delivery][code], order[items][][status] the symbol code of the element is specified. In the fields order[managerId], order[sourceId] the internal ID of the system entity is specified. The comment order[statusComment] cannot be changed without changing the order status order[status]. Order items are specified in the field order[items][]. The products that were not passed in the request for editing are deleted from the order. If item is in the catalog, then it is necessary to set the value for one of the following fields: order[items][][offer][id] – SKU ID; order[items][][offer][externalId] – external ID of item or SKU; order[items][][offer][xmlId] – SKU ID in the warehouse system. If the values are set for several fields, they will be processed in the following above order. In case, if the ofeer will be not found by any of criteria, the order item will be automatically created based on data from fields order[items][][initialPrice], order[items][][purchasePrice], order[items][][productName]. The delivery address order[delivery][address] you can specify either in the string form in the order[delivery][address][text] field, or in the detailed view, filling all the fields except order[delivery][address][text]. In the order[customFields] field you can pass the values array of custom fields. For the "DataBook" fields the symbol code of data book value is specified. For the "Date" fields the date in the format Y-m-d is specified. For other field types the exact value is specified. For working with price types, more than one price type must be enabled in data book. For transferring the price type for order item, code of necessary price type must be transferred to order[items][][priceType][code] field. It is recommended to transfer actual value of item price together with price type to order[items][][initialPrice]. If order[items][][priceType][code] price type is transferred without the order[items][][initialPrice] price value, then the current value of this price type for the current item will be taken for the item price. For new item it is recommended always to transfer order[items][][initialPrice] price clearly, in case if actual price has not been downloaded to system yet. If not to transfer order[items][][priceType][code] price type for the item, then price type for the item in order will be No type. In case if there is only the basic price type in the system, then order[items][][priceType][code] parameter should not be considered. The order of order items order[items][] is saved in response. Parameters order[items][][externalId] and order[items][][externalIds] are optional. Either external ID value order[items][][externalId] or array of external IDs order[items][][externalIds] can be specified at the same time. The external ID value order[items][][externalId] will be written to the array order[items][][externalIds] with default code. Values of external identifiers order[items][][externalIds][][value] should be unique by code order[items][][externalIds][][code] within one order. The privilegeType field can contain one of the following values: personal_discount - the customer’s personal discount; loyalty_level - calculation of a discount or bonus accrual based on the level settings of the customer’s Loyalty Program; loyalty_event - calculation of the discount on the event of the Loyalty Program; none - do not apply discounts of the Loyalty Program to the order; To apply the Loyalty Program to an order, the following conditions must be met: the store of the order must coincide with the store of the necessary Loyalty Program; participation in the Loyalty Program must be created for the customer in the order; the privilegeType field must be specified with none by default; If the loyalty_event value is specified in privilegeType and the event gives a discount, then it is required to specify the ID in the loyaltyEventDiscountId field If there are items with the same SKUs in the order, then it is required to pass identifiers (order[items][][id] or order[items][][externalId] or order[items][][externalIds]) to edit them. When editing an item via identifiers (order[items][][id] or order[items][][externalId] or order[items][][externalIds]), it is impossible to change the SKU order[items][][offer]. When editing an order, items are updated in the following order: If API request contains item identifier order[items][][id] but there is no such identifier in the system, the corresponding error message will be displayed. If API request contains item identifier order[items][][id] which exists in the system but belongs to another order, the corresponding error message will be displayed. If API request contains item identifier order[items][][id] which exists in the system and belongs to the order that is being edited, the item will be updated. If API request does NOT contain item identifier order[items][][id] but contains external identifier of the item order[items][][externalId] which exists in the system and belongs to the order that is being edited, the item will be updated. If API request does NOT contain item identifier order[items][][id] but contains external identifier of the item order[items][][externalId]` which does NOT exist in the system, a new item will be added. If the API request does NOT contain item identifiers (order[items][][id] and order[items][][externalId]) but there are items with the same SKUs either in the order or in the API request, the corresponding error message will be displayed. If neither the order nor the API request contain items with the same SKUs, then in order to update the item the search will be made by the ID of the SKU order[items][][offer][id], by the external ID of the SKU order[items][][offer][externalId], by the ID of the SKU in the warehouse system order[items][][offer][xmlId], otherwise a new item will be added. Please note that it will be possible to edit an order containing items with the same SKUs only if the setting “Possibility of adding the same SKUs to the order as different items” is enabled.

    POST /api/v5/orders/{externalId}/edit

  • Destructive

    Cancellation of bonus operations on the Loyalty Program

    To access the method, the following permission is required order_write. The method cancels the actions performed with bonuses in the order. In case of cancellation, the customer will get back the bonuses redeemed in the order while the accrued bonuses will be redeemed. If there are only redeemed or only accrued bonuses in the order, then only the performed operation will be cancelled.

    POST /api/v5/orders/loyalty/cancel-bonus-operations

  • Destructive

    Payment removing

    To access the method, the following permission is required order_write. Method allows to remove the payment.

    POST /api/v5/orders/payments/{id}/delete

  • Destructive

    Cancellation of the integrated delivery

    To access the method, the following permission is required order_write. This method allows to cancel the integrated delivery for a specific order. If there is no integrated delivery in the order or the order contains the integrated delivery which was cancelled or cannot be cancelled, an error returns. Note to the force parameter: if the value is trueand an error occurs, when trying to cancel the delivery in the delivery service, we mark such delivery as deleted in our system. If the value is false, the delivery status won't be changed to the cancellation status and an error message will be returned explaining why the delivery couldn't be cancelled in the delivery service.

    POST /api/v5/orders/{externalId}/delivery/cancel

Simla API / Orders picking

  • Read

    Getting the list of packs matched the specified filter

    To access the method, the following permission is required order_read.

    GET /api/v5/orders/packs

  • Read

    Getting the history of order packing

    To access the method, the following permission is required order_read. The result is returned per-page. In the field pagination there is an information about the pagination. More information about the work with history you can find in other article (https://docs.simla.com/en/Developers/API/APIFeatures/WorkingHistoryAPI).

    GET /api/v5/orders/packs/history

  • Read

    Getting information on pack

    To access the method, the following permission is required order_read.

    GET /api/v5/orders/packs/{id}

  • Write

    Pack creation

    To access the method, the following permission is required order_write. The method creates a pack and returns its internal ID. The creation of the pack is not allowed for cancelled SKUs and services. There will be an error message in this case.

    POST /api/v5/orders/packs/create

  • Write

    Pack editing

    To access the method, the following permission is required order_write. For the shipped order: reduction in the quantity of products in the pack pack[quantity] is not available and increase in the quantity will lead to the automatic shipment change of the pickup date of the pack pack[shipmentDate] is not available

    POST /api/v5/orders/packs/{id}/edit

  • Destructive

    Pack removing

    To access the method, the following permission is required order_write. Deleting the pack for the shipped order is not available.

    POST /api/v5/orders/packs/{id}/delete

Simla API / Payments

  • Read

    Checking the invoice

    To access the method, the following permission is required payments_read. Method allows to check invoice parameters before debiting

    POST /api/v5/payment/check

  • Read

    Get the invoice

    To access the method, the following permission is required payments_read.

    GET /api/v5/payment/invoice/{invoiceUuid}

  • Write

    Creating an invoice

    To access the method, the following permission is required payments_write. Method allows to create link to pay for the specified payment

    POST /api/v5/payment/create-invoice

  • Write

    Import the invoice

    To access the method, the following permission is required payments_write. The method allows importing an invoice. The fields invoice[status] and invoice[refunds][][status] can only have the value succeeded. If invoice[refunds] is specified, all internal fields (except comment) are required.

    POST /api/v5/payment/invoice/import

  • Write

    Changing the invoice

    To access the method, the following permission is required payments_write. The method allows you to change the invoice data in the system. When passing the discount amount updateInvoice[discountAmount], it is necessary to reduce the payment amount updateInvoice[amount] by the corresponding amount. This discount will be added to the order in the system as a One-time discount. Changing the payment amount updateInvoice[amount] with the specified discount updateInvoice[discountAmount] is only possible when changing the payment status updateInvoice[status] to waitingForCapture or succeeded.

    POST /api/v5/payment/update-invoice

Simla API / Data book

  • Read

    Getting of the costs groups list

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/cost-groups

  • Read

    Getting of the costs items list

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/cost-items

  • Read

    Getting the list of available country codes

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/countries

  • Read

    Getting the list of couriers

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/couriers

  • Read

    Getting the list of currencies

    To access the method, the following permission is required reference_read. The base currency has the currencies[][isBase]=true attribute. All other fields returned refer to the settings of additional currencies. If the additional currency is in automatic conversion mode currencies[][isAutoConvert]=true, the extra percent value currencies[][autoConvertExtraPercent] is also returned. If the additional currency is in manual conversion mode currencies[][isAutoConvert]=false, the values of the currency nominal currencies[][manualConvertNominal] and the conversion rate currencies[][manualConvertValue] are also returned.

    GET /api/v5/reference/currencies

  • Read

    Getting the list of delivery services

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/delivery-services

  • Read

    Getting the list of delivery types

    To access the method, the following permission is required reference_read. Use filter[codes][] to return delivery types with the specified symbolic codes. Unknown codes are ignored. Pass includeCostSettings=true (or 1) together with filter[codes][] to include cost calculation types, COD markup, regional availability and the regionWeightCostConditions and dateTimeCostConditions arrays. Without filter[codes][], the parameter returns a 400 error.

    GET /api/v5/reference/delivery-types

  • Read

    Getting a list of MessageGateway channels

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/mg-channels

  • Read

    Getting the list of order methods

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/order-methods

  • Read

    Getting the list of order types

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/order-types

  • Read

    Getting the list of payment statuses

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/payment-statuses

  • Read

    Getting the list of payment types

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/payment-types

  • Read

    Getting the list of price types

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/price-types

  • Read

    Getting the list of item statuses in order

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/product-statuses

  • Read

    Get customer mobile push notification categories

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/push-categories

  • Read

    Getting the stores list

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/sites

  • Read

    Getting store tracker settings

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/sites/{code}/tracker

  • Read

    Getting the list of order status groups

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/status-groups

  • Read

    Getting the list of order statuses

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/statuses

  • Read

    Getting the list of warehouses

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/stores

  • Read

    Subscription categories list

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/subscriptions

  • Read

    Getting ticket channel list

    To access the method, the following permission is required reference_read. Includes inactive channels. No pagination.

    GET /api/v5/reference/ticket-channels

  • Read

    Getting ticket status group list

    To access the method, the following permission is required reference_read. Includes inactive and system groups. No pagination. System groups new and complete are read-only.

    GET /api/v5/reference/ticket-status-groups

  • Read

    Getting ticket status list

    To access the method, the following permission is required reference_read. Includes inactive statuses. No pagination. Status is stored on a ticket issue. The ticket itself has no separate status.

    GET /api/v5/reference/ticket-statuses

  • Read

    Getting ticket subtopic list

    To access the method, the following permission is required reference_read. Includes inactive subtopics. No pagination.

    GET /api/v5/reference/ticket-subtopics

  • Read

    Getting ticket topic list

    To access the method, the following permission is required reference_read. Includes inactive topics. No pagination.

    GET /api/v5/reference/ticket-topics

  • Read

    Getting ticket type list

    To access the method, the following permission is required reference_read. Includes inactive types. No pagination.

    GET /api/v5/reference/ticket-types

  • Read

    Getting the list of units

    To access the method, the following permission is required reference_read.

    GET /api/v5/reference/units

  • Write

    Editing costs groups

    To access the method, the following permission is required reference_write. For a new costs group it`s necessary to point name name, character code code and color color. character code has to be unique color has to be specified in a format #RRGGBB, for example #123ABC. The list of available colors: #ffd298 #ef8e06 #bc6b01 #19976e #8453df #ff8e87 #c7cdd4 #4191ff #8a96a6 #6ce0b9 Using this method it`s not possible to change color color or a character code code of system costs groups, the meaning system is true

    POST /api/v5/reference/cost-groups/{code}/edit

  • Write

    Editing costs items

    To access the method, the following permission is required reference_write. When creating or editing a cost item, belonging to the cost group for attracting customers in fields costItem[source][...] it`s possible to specify meanings of appropriate tags. These tags will be installed by default for all costs, belonging to this item. Following meanings are available for specifying the cost item type: const - constant cost var - variable cost

    POST /api/v5/reference/cost-items/{code}/edit

  • Write

    Courier creation

    To access the method, the following permission is required reference_write.

    POST /api/v5/reference/couriers/create

  • Write

    Courier editing

    To access the method, the following permission is required reference_write.

    POST /api/v5/reference/couriers/{id}/edit

  • Write

    Currency creation

    To access the method, the following permission is required reference_write. You can only create additional currencies. Specify the conversion mode in the field currency[isAutoConvert] (true if automatic and false if manual). The automatic exchange rate is allowed to be set if the base currency belongs to one of the following currencies — Belarusian Ruble, Kazakhstani Tenge, Russian Ruble, and the Central Bank of the corresponding base currency forms the exchange rate of the target currency. When is the automatic conversion mode you can also specify the amount of the extra percent value currency[autoConvertExtraPercent]. When is the manual conversion mode, you can specify the nominal of the currency currency[manualConvertNominal] and the conversion rate currency[manualConvertValue].

    POST /api/v5/reference/currencies/create

  • Write

    Currency editing

    To access the method, the following permission is required reference_write. You can edit both the base and additional currencies, but the composition of the fields differs, which accepted for editing. When you edit the base currency, you can only change the currency itself currency[code]. When you edit additional currencies you can change all other fields except currency[code]. Specify the conversion mode in the field currency[isAutoConvert] (true if automatic and false if manual). The automatic exchange rate is allowed to be set if the base currency belongs to one of the following currencies — Belarusian Ruble, Kazakhstani Tenge, Russian Ruble, and the Central Bank of the corresponding base currency forms the exchange rate of the target currency. When is the automatic conversion mode you can also specify the amount of the extra percent value currency[autoConvertExtraPercent]. When is the manual conversion mode, you can specify the nominal of the currency currency[manualConvertNominal] and the conversion rate currency[manualConvertValue].

    POST /api/v5/reference/currencies/{id}/edit

  • Write

    Delivery service creation/editing

    To access the method, the following permission is required reference_write.

    POST /api/v5/reference/delivery-services/{code}/edit

  • Write

    Delivery type creation/editing

    To access the method, the following permission is required reference_write. For new delivery type it is necessary to specify the name name and symbolic code code. The symbolic code must be unique. In the field integrationCode you may specify the code of that integrated delivery service, which was activated in the system. Otherwise there will be an error message.

    POST /api/v5/reference/delivery-types/{code}/edit

  • Write

    Editing of information on legal entity

    To access the method, the following permission is required reference_write.

    POST /api/v5/reference/legal-entities/{code}/edit

  • Write

    Order method creation/editing

    To access the method, the following permission is required reference_write.

    POST /api/v5/reference/order-methods/{code}/edit

  • Write

    Order type creation/editing

    To access the method, the following permission is required reference_write.

    POST /api/v5/reference/order-types/{code}/edit

  • Write

    Payment status creation/editing

    To access the method, the following permission is required reference_write.

    POST /api/v5/reference/payment-statuses/{code}/edit

  • Write

    Payment type creation/editing

    To access the method, the following permission is required reference_write. The paymentDeliveryTypes field replaces all links to delivery types whose payment settings are not managed by an integration. Submit the complete list of these links to keep, including their cod flags. An empty array removes all such links. If the field is omitted or null, existing links and cod flags remain unchanged. Links to delivery types whose payment settings are managed by an integration remain unchanged. Attempts to change them are skipped without an error. When paymentDeliveryTypes is provided, the response includes ignoredDeliveryTypes, containing the codes of skipped integration-managed delivery types.

    POST /api/v5/reference/payment-types/{code}/edit

  • Write

    Price type creation/editing

    To access the method, the following permission is required reference_write.

    POST /api/v5/reference/price-types/{code}/edit

  • Write

    Item status creation/editing

    To access the method, the following permission is required reference_write.

    POST /api/v5/reference/product-statuses/{code}/edit

  • Write

    Create/edit customer mobile push notification category

    To access the method, the following permission is required reference_write.

    POST /api/v5/reference/push-categories/{code}/edit

  • Write

    Store creation/editing

    To access the method, the following permission is required reference_write.

    POST /api/v5/reference/sites/{code}/edit

  • Write

    Order status creation/editing

    To access the method, the following permission is required reference_write.

    POST /api/v5/reference/statuses/{code}/edit

  • Write

    Creation/editing of information on warehouse

    To access the method, the following permission is required reference_write.

    POST /api/v5/reference/stores/{code}/edit

  • Write

    Create/edit subscription category

    To access the method, the following permission is required reference_write.

    POST /api/v5/reference/subscriptions/{channel}/{code}/edit

  • Write

    Creating a ticket channel

    To access the method, the following permission is required reference_write. If code is omitted, the system generates it from the name. A supplied code must be unique.

    POST /api/v5/reference/ticket-channels/create

  • Write

    Editing a ticket channel

    To access the method, the following permission is required reference_write. Omitted fields keep their current values. If your integration stores symbolic codes, refresh its dictionary after changing code.

    POST /api/v5/reference/ticket-channels/{id}/edit

  • Write

    Creating a ticket status group

    To access the method, the following permission is required reference_write. If code is omitted, the system generates it from the name. A supplied code must be unique. Codes new and complete are reserved for system groups. color=null and color="custom" create a group without a color.

    POST /api/v5/reference/ticket-status-groups/create

  • Write

    Editing a ticket status group

    To access the method, the following permission is required reference_write. System groups new and complete cannot be modified. Their codes cannot be assigned to other groups. To clear the color, pass color=null or color="custom". Omitted fields keep their current values. If your integration stores symbolic codes, refresh its dictionary after changing code.

    POST /api/v5/reference/ticket-status-groups/{id}/edit

  • Write

    Creating a ticket status

    To access the method, the following permission is required reference_write. The status group must exist. This method does not change its data. If code is omitted, the system generates it from the name. A supplied code must be unique.

    POST /api/v5/reference/ticket-statuses/create

  • Write

    Editing a ticket status

    To access the method, the following permission is required reference_write. The last active status cannot be deactivated. Use group to move the status to another existing group. The group’s data remains unchanged. Omitted fields keep their current values. If your integration stores symbolic codes, refresh its dictionary after changing code.

    POST /api/v5/reference/ticket-statuses/{id}/edit

  • Write

    Creating a ticket subtopic

    To access the method, the following permission is required reference_write. The topic must exist. This method does not change its data. If code is omitted, the system generates it from the name. A supplied code must be unique.

    POST /api/v5/reference/ticket-subtopics/create

  • Write

    Editing a ticket subtopic

    To access the method, the following permission is required reference_write. Use topic to move the subtopic to another existing topic. The topic’s data remains unchanged. Omitted fields keep their current values. If your integration stores symbolic codes, refresh its dictionary after changing code.

    POST /api/v5/reference/ticket-subtopics/{id}/edit

  • Write

    Creating a ticket topic

    To access the method, the following permission is required reference_write. If code is omitted, the system generates it from the name. A supplied code must be unique.

    POST /api/v5/reference/ticket-topics/create

  • Write

    Editing a ticket topic

    To access the method, the following permission is required reference_write. Omitted fields keep their current values. If your integration stores symbolic codes, refresh its dictionary after changing code.

    POST /api/v5/reference/ticket-topics/{id}/edit

  • Write

    Creating a ticket type

    To access the method, the following permission is required reference_write. If code is omitted, the system generates it from the name. A supplied code must be unique. The system creates a common SLA setting with thresholds of 12 and 48 hours for the new type.

    POST /api/v5/reference/ticket-types/create

  • Write

    Editing a ticket type

    To access the method, the following permission is required reference_write. Omitted fields keep their current values. If your integration stores symbolic codes, refresh its dictionary after changing code.

    POST /api/v5/reference/ticket-types/{id}/edit

  • Write

    Unit creation/edition

    To access the method, the following permission is required reference_write.

    POST /api/v5/reference/units/{code}/edit

Simla API / Segments

  • Read

    Getting the list of customer segments

    To access the method, the following permission is required segment_read. The result is returned page by page. In the field pagination there is information on pagination. One of two values can be specified in filter[type]: dynamic – returns dynamic (automatically recalculated) segments; static – returns static (manually recalculated) segments.

    GET /api/v5/segments

Simla API / Settings

  • Read

    Getting system settings

    Getting system settings.

    GET /api/v5/settings

Simla API / Store

  • Read

    Getting the leftover stocks and purchasing prices

    To access the method, the following permission is required store_read. The method allows to receive information about the stock balance and cost price of the SKUs. If the parameter filter[details]=1 is specified, the detailed elaboration of the stock balance and cost price will be returned. The data is returned by the stores, to which the used API key has the access, or by the certain store, if the parameter filter[sites][]=site-code is specified. By default the information about both enabled and disabled products and SKUs is returned. To receive the information only about enabled products and SKUs, use the parameters filter[productActive]=1 and filter[offerActive]=1. The field offers[][site] is returned only if the data is returned by the several stores.

    GET /api/v5/store/inventories

  • Read

    Getting a list of offers that meet the specified filter

    To access the method, the following permission is required store_read. The method allows you to get information about offers. Data is returned by stores accessible to the used API key, or by a specific store if the parameter filter[sites][]=site-code is specified. By default, information is returned for both active and inactive offers. To get information only for active offers, use the parameter filter[active]. Filters filter[minPrice], filter[maxPrice] filter products by the prices of offers converted to the base currency. If, along with these filters, you specify a filter by price type filter[priceType] (to which you need to pass a symbolic code of the price type) then filtering will be carried out by the prices of offers of this price type and in the currency of this price type. The filter filter[properties][] allows you to get products by their properties. The filter must be specified in the format filter[properties][property_code_1]=value_1&filter[properties][property_code_2]=value_2. When passing group identifiers in the filter[groups][] parameter, offers related to products or services from the specified groups, as well as all their subgroups, will be returned.

    GET /api/v5/store/offers

  • Read

    Getting the list of product groups

    To access the method, the following permission is required store_read. The method allows to receive information about product groups. The data is returned by the stores, to which the used API key has the access, or by the certain stores, if the parameter filter[sites][]=site-code is specified. By default the information about both enabled and disabled product groups is returned. To receive the information only about enabled product groups use the parameter filter[active].

    GET /api/v5/store/product-groups

  • Read

    Getting the list of products and SKU

    To access the method, the following permission is required store_read. The method allows to receive information about stock balance and cost price of the SKUs. The data is returned by the stores, to which the used API key has the access, or by the certain stores, if the parameter filter[sites][]=site-code is specified. When implementing a constant transfer of changes to an external system, it is recommended to use the approach of collecting incremental changes via filter[sinceId] passing the id of the product which was received last. By default the information about both enabled and disabled products is returned. To receive the information only about enabled products and SKUs, use the parameters filter[active]. The result is returned page by page. In the field pagination there is information on pagination. Filters filter[minPrice], filter[maxPrice] filter products by the prices of offers converted to the base currency. If, along with these filters, you specify a filter by price type filter[priceType] (to which you need to pass a symbolic code of the price type) then filtering will be carried out by the prices of offers of this price type and in the currency of this price type. filter[properties][] allows to get items by its properties. Filter must be specified in format filter[properties][property_code_1]=value_1&filter[properties][property_code_2]=value_2. In the filter filter[groups] there are item group IDs specified. Filter filter[classSegment] allows to get segments of ABC/XYZ-analysis of items. Available values: abc[0..2]_xyz[0..2]. Filters filter[offerIds][], filter[offerExternalId], filter[offerXmlId] allow to get items, to which the SKUs with these id, externalId, xmlId accordingly belong

    GET /api/v5/store/products

  • Read

    Getting the list of item properties, matching the specified filter

    To access the method, the following permission is required store_read. Method allows to get information on items properties. The data is returned by the stores, to which the used API key has the access, or by the certain stores, if the parameter filter[sites][]=site-code is specified. The visible field determines the visibility of the product property for the buyer. If the field has the false value, then the property is recommended for displaying only within the system. The variative field determines whether the property is used when creating variations. If the field has the true value, then the property is used when creating the product variability. The result is returned page by page. In the field pagination there is information on pagination. Item properties can be filtered by identifiers filter[ids], name filter[name] (partial coincidence), symbolic code filter[code], visibility filter[visible] and variability filter[variative]. When passing group identifiers in the filter[groups][] parameter, properties for the specified groups as well as all child groups will be returned.

    GET /api/v5/store/products/properties

  • Read

    Getting a list of property values for products or services that match the specified filters

    To access the method, the following permission is required store_read. The method allows retrieving information about the property values of products or services. Data is returned for the stores that are accessible using the provided API key. The result is returned page by page. In the field pagination there is information on pagination. Item properties can be filtered by identifiers filter[ids], name filter[name] (partial coincidence), symbolic code filter[code], visibility filter[visible] and variability filter[variative]. When passing group identifiers in the filter[groups][] parameter, properties for the specified groups as well as all child groups will be returned.

    GET /api/v5/store/products/properties/values

  • Write

    Updating the leftover stocks and purchasing prices

    To access the method, the following permission is required store_write. The method allows to update the leftover stock and purchase prices by warehouses for SKUs. Per one query it is possible to update up to 250 SKUs. In one SKU it is possible to specify stocks up to 500 warehouses. Field offers[][stores][][available] may be integer or fractional. Using actual stock accounting, 0 should be transmitted - in case of item absence at the warehouse, and 1 - in case of presence. Each SKU should have at least one of three parameters: id, xmlId or externalId. If several or all above-mentioned parameters are specified, the search is made, first of all, by id, then by xmlId and then by externalId. If the SKU relates to a service, the transmitted data will be ignored. If found several items with the specified xmlId, then the stocks will be changed for all of them.

    POST /api/v5/store/inventories/upload

  • Write

    SKU prices updating

    To access the method, the following permission is required store_write. You may specify summarily up to 250 prices by one request.

    POST /api/v5/store/prices/upload

  • Write

    Adding a product group

    To access the method, the following permission is required store_write. This method allows to create product groups. If successful, the internal ID of the created product group is returned. To set the store, it is required to specify the store code in the productGroup[site] parameter. The active store will be searched by code. To set the parent product group, specify one of the following parameters: productGroup[parentId] or productGroup[parentExternalId]. The active product group will be searched, first of all, by the productGroup[parentId] parameter, then by productGroup[parentExternalId] and productGroup[site]. If the productGroup[active] parameter isn't specified, the default value - true will be set.

    POST /api/v5/store/product-groups/create

  • Write

    Editing a product group

    To access the method, the following permission is required store_write. This method allows to make changes to product groups. If successful, the internal ID of the modified product group is returned. The product group can be searched both by external ID (externalId) and internal ID (id) - just specify the corresponding value in the by parameter (by default, externalId). To search by external ID, you should pass the site parameter. To set the parent product group, specify one of the following parameters: productGroup[parentId] or productGroup[parentExternalId]. The active product group will be searched, first of all, by the productGroup[parentId] parameter, then by productGroup[parentExternalId] and productGroup[site].

    POST /api/v5/store/product-groups/{externalId}/edit

  • Write

    Batch adding of products and services

    To access the method, the following permission is required store_write. Up to 50 products can be transferred in total per request. In the type parameter, you can specify whether a product (product) or a service (service) is being created. By default, the product is created. Such parameters as name and catalogId must be specified for each product. Each product group must have one of the parameters: id or externalId. If several parameters are specified, the search is carried out, first of all, by id, but only within the product catalog. For services, the fields "Manufacturer" (manufacturer), "Subject to marking" (markable) and "Type of product marking" (markingProvider) are ignored.

    POST /api/v5/store/products/batch/create

  • Write

    Batch editing of products and services

    To access the method, the following permission is required store_write. Up to 50 products can be transferred in total per request. Each product must have the id parameter or the externalId and site parameters. If several or all of the above-mentioned parameters are specified, the search is made, first of all, by the id field, then by externalId and site. Only those product parameters that were passed in the request are involved in editing. When editing the product catalog, the assigned product groups, properties and options are cleared. Each product group must have one of the parameters: id or externalId. The search is carried out in the same way as for products, but only within the framework of the product catalog. If an empty array is passed in the groups parameter, the assigned product groups will be cleared. If the "Enter in the sales offer" setting is enabled for the "Image" property in the product properties, then products[][imageUrl] will be ignored. For services, the fields "Manufacturer" (manufacturer), "Subject to marking" (markable) and "Type of product marking" (markingProvider) are ignored.

    POST /api/v5/store/products/batch/edit

Simla API / Tasks

  • Read

    Getting the task list

    To access the method, the following permission is required task_read. The result is returned page by page. In the field pagination there is information on pagination. The array of task internal identifiers is being transmitted in filter[ids][]. The filter[ticketId] and filter[ticketNumber] filters return tasks linked to a ticket by its internal identifier or number respectively. An array of internal identifiers of users is passed in the filter[creators][]. An array of internal identifiers of users or groups is passed in the filter[performers][]. filter[status] allows to get tasks, which are in certain status. Available values are: completed - completed tasks; performing - uncompleted tasks. By filter filter[customer] possible to search by customer name, email and phone.

    GET /api/v5/tasks

  • Read

    Getting the task change history

    To access the method, the following permission is required task_read. Returns changes in tasks made in the specified date range (using filters filter[startDate] and filter[endDate]), or incremental changes (using filter[sinceId]). When implementing a permanent translation of changes to an external system ​it is recommended​ to use the approach with collecting incremental changes via filter[sinceId] transferring id of the last received history record. For task creation records, the full set of fields is returned in the context task. The result is returned page by page. Field pagination contains pagination information. To paginate through history records, it is necessary to use filter[sinceId]. It is not recommended to use the page parameter. You can find more details about working with history in a separate documentation article (https://docs.simla.com/en/Developers/API/APIFeatures/WorkingHistoryAPI).

    GET /api/v5/tasks/history

  • Read

    Getting information on task

    To access the method, the following permission is required task_read.

    GET /api/v5/tasks/{id}

  • Read

    Receiving comments on the task

    To access the method, the following permission is required task_read. It returns user comments on the task. By default, the response contains up to 20 entries. The result is returned page by page. The pagination field contains information about pagination.

    GET /api/v5/tasks/{id}/comments

  • Write

    Task creation

    To access the method, the following permission is required task_write. Method creates the task and returns its internal ID. If it is needed to change the task execution date, it is necessary to transmit date in Y-m-d H:i format to the task[datetime] field. Date should be in the future. In the task[performerId] field it is required to pass the internal ID of the user or group to assign the responsible user/group You can pass the task priority in the task[priority] field. Available values are: low - low priority; medium - medium priority; high - high priority. If the field is not passed, the task will automatically get the medium priority. If it is needed to relate the task with existing customer, then it is necessary to set the value of one of the following fields: task[customer][id] – customer internal ID; task[customer][externalId] – customer external ID. If the values of several fields are set, they will be processed in the ordering specified above. Customer search will be made within stores, which the used API-key has access to. If customer will not be found, relation will not be set. If it is needed to relate task with existing order, then it is necessary to set the value of one of the following fields: task[order][id] – order internal ID; task[order][externalId] – external order ID; task[order][number] – order number. If the values of several fields are set, they will be processed in the ordering specified above. Order search will be made within stores, which the used API-key has access to. If order will not be found, relation will not be set. When relating the task with existing order, task will be automatically related with customer, which the order belongs to. If it is needed to relate task with existing ticket, then it is necessary to set the value of one of the following fields: task[ticket][id] – ticket internal ID; task[ticket][externalId] – external ticket ID; task[ticket][number] – ticket number. If the values of several fields are set, they will be processed in the ordering specified above. Ticket search will be made within stores, which the used API-key has access to. If ticket will not be found, relation will not be set. When passing task[ticket][externalId] or task[ticket][number], the store symbolic code must also be passed in the site parameter. When relating the task with existing ticket, task will be automatically related with customer, which the ticket belongs to. When binding the task with customer, order, or ticket, it is necessary to specify either customer data or order and/or ticket data. When creating the task for recall you should specify phone number, which has to be called, in the task[phone] field. It is desirable to specify the symbolic code of store in task[phoneSite] field for having opportunity to make recall from the certain store phone. This opportunity depends on used telephony and its settings.

    POST /api/v5/tasks/create

  • Write

    Task editing

    To access the method, the following permission is required task_write. Method allows to edit the task If it is needed to edit the task, which was not executed and execution time was expired, it is necessary to change task execution time also. If the value of task[complete] field is set as true, when changing the task, then there is no need to change task execution time. If it is needed to edit the task execution date, it is necessary to transmit date in Y-m-d H:i format to the task[datetime] field. Date should be in the future. In the task[performerId] field it is required to pass the internal ID of the user or group to change the responsible user/group You can pass the task priority in the task[priority] field. Available values are: low - low priority; medium - medium priority; high - high priority. If it is needed to relate the task with existing customer, then it is necessary to set the value of one of the following fields: task[customer][id] – customer internal ID; task[customer][externalId] – customer external ID. If the values of several fields are set, they will be processed in the ordering specified above. Customer search will be made within stores, which the used API-key has access to. If customer will not be found, relation will not be set. If it is needed to relate task with existing order, then it is necessary to set the value of one of the following fields: task[order][id] – order internal ID; task[order][externalId] – external order ID; task[order][number] – order number. If the values of several fields are set, they will be processed in the ordering specified above. Order search will be made within stores, which the used API-key has access to. If order will not be found, relation will not be set. When relating the task with existing order, task will be automatically related with customer, which the order belongs to. If it is needed to relate task with existing ticket, then it is necessary to set the value of one of the following fields: task[ticket][id] – ticket internal ID; task[ticket][externalId] – external ticket ID; task[ticket][number] – ticket number. If the values of several fields are set, they will be processed in the ordering specified above. Ticket search will be made within stores, which the used API-key has access to. If ticket will not be found, relation will not be set. When passing task[ticket][externalId] or task[ticket][number], the store symbolic code must also be passed in the site parameter. When relating the task with existing ticket, task will be automatically related with customer, which the ticket belongs to. When binding the task with customer, order, or ticket, it is necessary to specify either customer data or order and/or ticket data. When editing the task for recall you should specify phone number, which has to be called, in the task[phone] field. It is desirable to specify the symbolic code of store in task[phoneSite] field for having opportunity to make recall from the certain store phone. This opportunity depends on used telephony and its settings.

    POST /api/v5/tasks/{id}/edit

Simla API / Telephony

  • Read

    Getting a call list

    To access the method, the following permission is required telephony_read. This method allows you to get a list of calls. If no calls were found using the specified filters, the calls array in the response will be empty.

    GET /api/v5/telephony/calls

  • Read

    Getting call recording

    To access the method, the following permission is required telephony_read. The method returns call audio recording by internal call identifier id from the response of GET /api/v5/telephony/calls. On success it returns binary audio content with proper Content-Type and Content-Disposition headers.

    GET /api/v5/telephony/calls/{id}/record

  • Read

    Getting the responsible manager

    To access the method, the following permission is required telephony_read. The method returns responsible manager for the customer with the phone number phone, that is actually Online in the system and is in the status Free. If there is no responsible manager, the field manager will be absent in the answer. If the field ignoreStatus equals to 1, there will be the field manager in the response regardless of the status of the responsible manager in the system (Online status and/or Free status). If the field details is equal to 1, there will be the following fields links, customer in the answer. Otherwise, the fields will be absent. If the customer is found, the fields links[newCustomerLink], links[newOrderLink] will be absent in answer. If the customer is not found, the fields customer, links[lastOrderLink], links[customerLink] will be absent in answer.

    GET /api/v5/telephony/manager

  • Write

    Call events

    To access the method, the following permission is required telephony_write. Manager extension code in telephony Method fixes the call events for users with extension numbers codes and/or with userIds ID, from phone number phone. codes field contains JSON array of extension codes, userIds field contains JSON array of users ID. If there are both codes and userIds fields specified, the call event will be fixed for all listed users. The field type contains the event type: in - incoming call, out - outgoing call, hangup - call completion. In case if type is equal to ​hangup​, then in the field hangupStatus you can pass the status. The field hangupStatus contains the call completion status: answered - call is received, no answered - there were no answer for the call, busy - the calling part gets the signal "busy", cancel - the call is cancelled, failed - failed to call. By default the value is answered. The field campaign contains an advertising campaign the call related with.Contains JSON, where with the fields: name - advertising campaign name and code - advertising campaign code. In case if this field is not empty, in the incoming call window there will be an information on advertising campaign. Call event can be related to the store. For this purpose it is necessary to specify the symbolic code of store in site field, or external phone number of store in externalPhone field. If both fields are specified, they will be processed in the following order: site externalPhone

    POST /api/v5/telephony/call/event

  • Write

    Calls uploading

    To access the method, the following permission is required telephony_write. The method allows to save the call history. In one request you can pass up to 50 calls. The field calls contains JSON. The field calls[][date], contains date and time of the call in the format Y-m-d H:i:s. The field calls[][type], may receive the following values: in - incoming call, out - outgoing call. The field calls[][result], may receive the following values: failed - failed, answered - answered, busy - busy, no answer - no answer, not allowed - not allowed, unknown - unknown The field calls[][externalId] contains the unique call identifier in the PABX, if there will be passed the value that is already exist the call will not be created. The field calls[][recordUrl] contains the link to the call record, e.g. http://example.com/record.mp3. Supported records format is .wav, .mp3 For call saving, calls[][userId] and calls[][code] fields should be filled. calls[][userId] field contains ID of user, who processed the call. calls[][code] field contains extension code of user, who processed the call. Field Call duration calls[][duration] must be more than Waiting time for the operator's answer calls[][durationWaiting]. If the calls[][duration] field is not transferred, there will be no player to listen the call recording at the order. If both fields are specified, they will be processed in the following order: calls[][userId] calls[][code] Call can be related to the store. For this purpose it is necessary to specify the symbolic code of store in calls[][site] field, or external phone number of store in calls[][externalPhone] field. If both fields are specified, they will be processed in the following order: calls[][site] calls[][externalPhone]

    POST /api/v5/telephony/calls/upload

Simla API / Tickets

  • Read

    get_intaro_crm_api_tickets_list_v5

    To access the method, the following permission is required ticket_read. Tickets are ordered by creation date and ID, descending. For the next page, pass pagination.nextCursor as cursor and keep the same filters. An empty cursor marks the end of the list. Record and SLA changes between requests may affect the results. The sites codes are intersected with the stores accessible to the API key. Inactive reference entries can also be used in filters. Dates use Y-m-d, with both boundary days included in full. Status, type, topic and assignee filters apply to ticket issues. Different conditions may match different issues, but both closing date bounds must match the same issue. All issues are returned. completed includes tickets without issues. Customer filters apply to customer. All specified segments and regular tags must match. For attached tags, one match is enough. Regular and attached tag filters can be combined. vip and bad are applied independently, including false. customFields supports active fields enabled for filtering. Numeric min and max bounds must be integers from 0 to 2147483647 for integer fields and to 100000000000 for numeric fields. As in other REST lists, min=0 does not restrict the lower bound, and max=0 without min selects zero and empty values. Set both bounds to 0 to match zero exactly. For date and datetime fields, specify days in Y-m-d format.

    GET /api/v5/tickets

  • Read

    Get a ticket

    To access the method, the following permission is required ticket_read. By default, the ticket is looked up by its external ID in the site store. You can omit site if the API key has access to a single store. To look up a ticket by its internal ID, pass by=id. In this case, site is not required.

    GET /api/v5/tickets/{externalId}

Simla API / Users

  • Read

    Getting the list of user groups

    To access the method, the following permission is required user_read.

    GET /api/v5/user-groups

  • Read

    Getting the list of users matched the specified filter

    To access the method, the following permission is required user_read.

    GET /api/v5/users

  • Read

    Getting information on user

    To access the method, the following permission is required user_read. Getting information on user The field user[status] contains user status in the system, it may receive the following values: free - free; busy - busy;dinner - at lunch; break - break.

    GET /api/v5/users/{id}

  • Write

    Change user status

    To access the method, the following permission is required user_write.

    POST /api/v5/users/{id}/status

Simla API / Verification

  • Read

    Checking the verification status

    To access the method, the following permission is required verification_read. The actionType field returns the type of action for which the phone is confirmed. Possible values: verify_loyalty_account - confirmation when activating participation in the Loyalty Program; verify_loyalty_account_phone - confirmation of the phone number of the participation in the Loyalty Program; confirm_loyalty_charge - redeeming bonuses in the Loyalty Program;

    GET /api/v5/verification/sms/{checkId}/status

  • Write

    Confirmation of verification

    To access the method, the following permission is required verification_write. Method for confirmation of verification

    POST /api/v5/verification/sms/confirm

Simla API / Web analytics

  • Write

    Batch uploading of web analytics clientId

    To access the method, the following permission is required web_analytics_write. The method allows uploading up to 100 tags of web analytics clientId. The clientIds field contains a JSON array. The clientId value is transferred in the mandatory field clientIds[][value]. The tag can be linked to an order or a customer. The clientIds[][order] field is used to upload to the order. To do this, you need to set the value of one of the following fields: clientIds[order][id] – internal ID of the order; clientIds[order][externalId] – external ID of the order; clientIds[order][number] – order number. To upload to the customer one of the fields is used: clientIds[customer][id] – internal ID of the customer; clientIds[customer][externalId] – external ID of the customer; If the value of several fields is set, they will be processed in the order specified above. The search by externalId/number will be performed within the store specified in the optional parameter clientIds[][site]. When adding a clientId to an order it will also be added to the clientId list of the linked customer, if not already added. If necessary, the fields of the first and last clientId of the customer are changed. The clientId setting date can be specified in the optional clientIds[][createdAt] field (if left blank, the current date will be used). The value field as well as any of the order and customer fields are mandatory.

    POST /api/v5/web-analytics/client-ids/upload

  • Write

    Batch uploading of sources

    To access the method, the following permission is required web_analytics_write. The method allows uploading up to 50 web analytics sources. The sources field contains a JSON array. Source data is transferred in the fields sources[][source], sources[][medium], sources[][campaign], sources[][keyword], sources[][content]; at least one of the fields must be transferred. The source can be linked to an order or a customer. The sources[][order] field is used to upload to the order. To do this, you need to set the value of one of the following fields: source[order][id] – internal ID of the order; source[order][externalId] – external ID of the order; source[order][number] – order number. To upload to the customer one of the fields is used: source[customer][id] – internal ID of the customer; source[customer][externalId] – external ID of the customer; If the customer does not have a source when writing the source to the order, it will be installed in the customer. The sources[][clientId] field can also be transferred with the value of the web analytics clientId: if it is found in the system, the source will be linked to the customer associated with this clientId. If the value of several fields is set, they will be processed in the order specified above. The search by externalId/number will be performed within the store specified in the optional parameter source[site]. At least one of the three fields order, customer, clientId is mandatory as well as at least one of the source fields.

    POST /api/v5/web-analytics/sources/upload

  • Write

    Batch uploading of visits

    To access the method, the following permission is required web_analytics_write. The method allows downloading up to 50 web analytics visits. The visits field contains a JSON array. The visit is linked to the client. One of the fields for this purpose is specified in the visit: visit[customer][id] – internal ID of the customer; visit[customer][externalId] – external ID of the customer; visit[][clientId] – web analytics clientId value: if it is found in the system, the source will be linked to the customer associated with this clientId. Each visit must contain a site field that points to the store associated with the visit.

    POST /api/v5/web-analytics/visits/upload

Simla API / Statistics

  • Write

    Statistics updating

    To access the method, the following permission is required analytics_write. Queues up the task to update key statistical indicators in the system. Retry timeout is 60 seconds. If calls are made more frequently, a 400 error will be returned.

    GET /api/v5/statistic/update

See How connections work for access and permissions, or browse all integrations.