RetailCRM REST API

API

GET /api/api-versions Getting the list of available api versions

Getting the list of available api versions

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

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`versions`	`array`	Available API versions

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

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.

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`credentials[]`	`array of strings`	`deprecated` Available API methods
`scopes[]`	`array of strings`	Permissions allowed for the key
`siteAccess`	`string`	Stores access mode. Possible values: `access_full` - access to all stores; `access_selective` - access to a particular store. Available stores are listed at field `sitesAvailable`
`sitesAvailable[]`	`array of strings`	Available stores

Cost

GET /api/v5/costs Getting of the cost list, adequate for the given filter

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.

Parameters

Parameter	Type	Format	Description
`limit`	`integer`	`{not blank}[20\|50\|100]}`	Quantity of elements in the answer (20 by default)
`page`	`integer`	`{not blank}{range: {>=1}}}`	Number of page with the results (1 by default)
`filter`	`object (CostFilterData)`
`filter[ids][]`	`array of integers`		Costs ID
`filter[costItems][]`	`array of strings`		Array of symbolic codes of costs items
`filter[sites][]`	`array of strings`		Array of symbolic codes of stores related with cost
`filter[createdBy][]`	`array of integers`		Array of users ID, which created the cost
`filter[orderNumber]`	`string`	`{length: {max: 255}}`	Number of order related with cost
`filter[costGroups][]`	`array of strings`		Array of symbolic codes of costs groups
`filter[users][]`	`array of integers`		Array of users ID related with cost
`filter[comment]`	`string`	`{length: {max: 1000}}`	Comment
`filter[orderIds][]`	`array of integers`		Array of order internal ID
`filter[orderExternalIds][]`	`array of strings`		Array of order external ID
`filter[createdAtFrom]`	`DateTime`	`Y-m-d`	Cost creation date (from)
`filter[createdAtTo]`	`DateTime`	`Y-m-d`	Cost creation date (to)
`filter[dateFrom]`	`DateTime`	`Y-m-d`	Cost period (from)
`filter[dateTo]`	`DateTime`	`Y-m-d`	Cost period (to)
`filter[minSumm]`	`integer`		Cost minimum sum
`filter[maxSumm]`	`integer`		Cost maximum sum

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`pagination`	`object (PaginationResponse)`	Pagination
`pagination[limit]`	`integer`	Quantity of elements in the answer
`pagination[totalCount]`	`integer`	Total quantity of found elements
`pagination[currentPage]`	`integer`	Current issuance page
`pagination[totalPageCount]`	`integer`	Total quantity of issuance pages
`costs[]`	`array of objects (Cost)`	Cost
`costs[][currency]`	`string`	Currency
`costs[][source]`	`object (SerializedSource)`	Customer source data
`costs[][source][source]`	`string`	Source
`costs[][source][medium]`	`string`	Medium
`costs[][source][campaign]`	`string`	Campaign
`costs[][source][keyword]`	`string`	Keyword
`costs[][source][content]`	`string`	Ad content
`costs[][id]`	`integer`	Cost ID
`costs[][dateFrom]`	`DateTime`	Date (from)
`costs[][dateTo]`	`DateTime`	Date (to)
`costs[][summ]`	`float`	Sum (in base currency)
`costs[][costItem]`	`string`	Cost item code
`costs[][comment]`	`string`	Comment
`costs[][createdAt]`	`DateTime`	Created at
`costs[][createdBy]`	`string`	User ID
`costs[][order]`	`object (Order)`	Order
`costs[][order][id]`	`integer`	Order ID
`costs[][order][number]`	`string`	Order number
`costs[][order][externalId]`	`string`	Order external ID
`costs[][userId]`	`integer`	User ID related with cost
`costs[][sites][]`	`array of strings`	Symbolic codes of stores, for which the expense is incurred

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v5/costs/create Creation of the cost

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.

Parameters

Parameter	Type	Description
`site`	`string`	Symbolic code of store. Is specified in case of relation to order by externalId or number
`cost`	`object (SerializedCost)`	The data about cost
`cost[dateFrom]`	`DateTime`	Date (from)
`cost[dateTo]`	`DateTime`	Date (to)
`cost[summ]`	`float`	Sum (in base currency)
`cost[comment]`	`string`	Comment
`cost[costItem]`	`string`	Cost item code
`cost[order]`	`object (SerializedEntityOrder)`	Order
`cost[order][id]`	`integer`	Order internal ID
`cost[order][externalId]`	`string`	Order external ID
`cost[order][number]`	`string`	Order number
`cost[userId]`	`integer`	ID of user related with cost
`cost[sites]`	`array`	Symbolic codes of stores, for which the expense is incurred
`cost[source]`	`object (SerializedSource)`	Customer source data
`cost[source][source]`	`string`	Source
`cost[source][medium]`	`string`	Medium
`cost[source][campaign]`	`string`	Campaign
`cost[source][keyword]`	`string`	Keyword
`cost[source][content]`	`string`	Ad content

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`id`	`integer`	ID of created cost

HTTP statuses

Status code	Description
`201`	The new cost is successfully created
`400`	Error of cost creation

POST /api/v5/costs/delete Batch removing of costs

Batch removing of costs

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

Method allows to remove batch up to 50 costs.

Parameters

Parameter	Type	Format	Description
`ids[]`	`array of integers`		Identifiers of removing costs

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`count`	`integer`	Quantity of removed costs
`notRemovedIds[]`	`array of integers`	Identifiers of not removed costs

HTTP statuses

Status code	Description
`200`	Costs have been successfully deleted
`400`	Error on batch removing of costs

POST /api/v5/costs/upload Batch loading of costs

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].

Parameters

Parameter	Type	Description
`costs[]`	`array of objects (SerializedCost)`	The data about cost
`costs[][dateFrom]`	`DateTime`	Date (from)
`costs[][dateTo]`	`DateTime`	Date (to)
`costs[][summ]`	`float`	Sum (in base currency)
`costs[][comment]`	`string`	Comment
`costs[][costItem]`	`string`	Cost item code
`costs[][order]`	`object (SerializedEntityOrder)`	Order
`costs[][order][id]`	`integer`	Order internal ID
`costs[][order][externalId]`	`string`	Order external ID
`costs[][order][number]`	`string`	Order number
`costs[][userId]`	`integer`	ID of user related with cost
`costs[][sites]`	`array`	Symbolic codes of stores, for which the expense is incurred
`costs[][source]`	`object (SerializedSource)`	Customer source data
`costs[][source][source]`	`string`	Source
`costs[][source][medium]`	`string`	Medium
`costs[][source][campaign]`	`string`	Campaign
`costs[][source][keyword]`	`string`	Keyword
`costs[][source][content]`	`string`	Ad content

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`uploadedCosts[]`	`array of integers`	Identifiers of uploaded costs

HTTP statuses

Status code	Description
`201`	All costs were successfully uploaded
`400`	The array of costs isn't transferred or array of costs is too large
`460`	In load time there were errors. A part of costs isn't loaded

GET /api/v5/costs/{id} Getting of cost information

Getting of cost information

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

Parameters

Parameter	Type	Format	Description
`id`	`string`		Cost ID

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`cost`	`object (Cost)`	Cost
`cost[currency]`	`string`	Currency
`cost[source]`	`object (SerializedSource)`	Customer source data
`cost[source][source]`	`string`	Source
`cost[source][medium]`	`string`	Medium
`cost[source][campaign]`	`string`	Campaign
`cost[source][keyword]`	`string`	Keyword
`cost[source][content]`	`string`	Ad content
`cost[id]`	`integer`	Cost ID
`cost[dateFrom]`	`DateTime`	Date (from)
`cost[dateTo]`	`DateTime`	Date (to)
`cost[summ]`	`float`	Sum (in base currency)
`cost[costItem]`	`string`	Cost item code
`cost[comment]`	`string`	Comment
`cost[createdAt]`	`DateTime`	Created at
`cost[createdBy]`	`string`	User ID
`cost[order]`	`object (Order)`	Order
`cost[order][id]`	`integer`	Order ID
`cost[order][number]`	`string`	Order number
`cost[order][externalId]`	`string`	Order external ID
`cost[userId]`	`integer`	User ID related with cost
`cost[sites][]`	`array of strings`	Symbolic codes of stores, for which the expense is incurred

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`404`	Cost is not found

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

Cost removing

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

Parameters

Parameter	Type	Format	Description
`id`	`string`		Cost ID

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The cost was successfully deleted
`400`	Error on cost removing
`404`	Cost is not found

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

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.

Parameters

Parameter	Type	Description
`site`	`string`	Symbolic code of store. Is specified in case of relation to order by externalId or number
`cost`	`object (SerializedCost)`	The data about cost
`cost[dateFrom]`	`DateTime`	Date (from)
`cost[dateTo]`	`DateTime`	Date (to)
`cost[summ]`	`float`	Sum (in base currency)
`cost[comment]`	`string`	Comment
`cost[costItem]`	`string`	Cost item code
`cost[order]`	`object (SerializedEntityOrder)`	Order
`cost[order][id]`	`integer`	Order internal ID
`cost[order][externalId]`	`string`	Order external ID
`cost[order][number]`	`string`	Order number
`cost[userId]`	`integer`	ID of user related with cost
`cost[sites]`	`array`	Symbolic codes of stores, for which the expense is incurred
`cost[source]`	`object (SerializedSource)`	Customer source data
`cost[source][source]`	`string`	Source
`cost[source][medium]`	`string`	Medium
`cost[source][campaign]`	`string`	Campaign
`cost[source][keyword]`	`string`	Keyword
`cost[source][content]`	`string`	Ad content

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`id`	`integer`	Cost ID

HTTP statuses

Status code	Description
`200`	Data of the cost is successfully changed
`400`	Error of cost changing

Custom fields

GET /api/v5/custom-fields Getting the list of custom fields

Getting the list of custom fields

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

Parameters

Parameter	Type	Format	Description
`limit`	`choice`	`{not blank}[20\|50\|100\|250]}`
`page`	`string`	`{not blank}{range: {>=1}}}`
`filter`	`object (CustomFieldFilter)`
`filter[name]`	`string`		Name
`filter[code]`	`string`		Symbolic code
`filter[type]`	`string`	`{choice of [boolean\|date\|datetime\|dictionary\|email\|integer\|multiselect_dictionary\|numeric\|string\|text]}`	Field type
`filter[viewMode]`	`string`	`{choice of [editable\|miss\|not_editable]}`	Field view in the form
`filter[viewModeMobile]`	`string`	`{choice of [editable\|miss\|not_editable]}`	Field view in mobile application
`filter[displayArea]`	`string`	`{choice of [address\|customer\|delivery\|dimensions\|empty\|legal_details\|main_data\|payment\|shipment]}`	Display area
`filter[entity]`	`string`	`[customer\|loyalty_account\|order]`	Fields for the table
`filter[inFilter]`	`choice`	`[0\|1]`	Available in filter

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`pagination`	`object (PaginationResponse)`	Pagination
`pagination[limit]`	`integer`	Quantity of elements in the answer
`pagination[totalCount]`	`integer`	Total quantity of found elements
`pagination[currentPage]`	`integer`	Current issuance page
`pagination[totalPageCount]`	`integer`	Total quantity of issuance pages
`customFields[]`	`array of objects (CustomFieldApiDocModel)`
`customFields[][name]`	`string`	Name
`customFields[][code]`	`string`	Symbolic code
`customFields[][required]`	`boolean`	Mandatory
`customFields[][inFilter]`	`boolean`	Available in filter
`customFields[][inList]`	`boolean`	Available in list
`customFields[][inGroupActions]`	`boolean`	Available in group actions
`customFields[][type]`	`string`	Field type
`customFields[][entity]`	`string`	Fields for the table
`customFields[][default]`	`string`	`deprecated` Default value
`customFields[][ordering]`	`integer`	Sorting
`customFields[][displayArea]`	`string`	Display area
`customFields[][viewMode]`	`string`	Field view in the form
`customFields[][viewModeMobile]`	`string`	Field view in mobile application
`customFields[][dictionary]`	`string`	Related dictionary
`customFields[][defaultTyped]`	`custom handler result for (mixed)`	Typed value by default

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

GET /api/v5/custom-fields/dictionaries Getting the list of custom directory

Getting the list of custom directory

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

Parameters

Parameter	Type	Format	Description
`limit`	`choice`	`{not blank}[20\|50\|100\|250]}`
`page`	`string`	`{not blank}{range: {>=1}}}`
`filter`	`object (CustomDictionaryFilter)`
`filter[name]`	`string`		Name
`filter[code]`	`string`		Symbolic code

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`pagination`	`object (PaginationResponse)`	Pagination
`pagination[limit]`	`integer`	Quantity of elements in the answer
`pagination[totalCount]`	`integer`	Total quantity of found elements
`pagination[currentPage]`	`integer`	Current issuance page
`pagination[totalPageCount]`	`integer`	Total quantity of issuance pages
`customDictionaries[]`	`array of objects (CustomDictionary)`	Directory
`customDictionaries[][name]`	`string`	Name
`customDictionaries[][code]`	`string`	Symbolic code
`customDictionaries[][elements][]`	`array of objects (SerializedCustomDictionaryElement)`	Directory element
`customDictionaries[][elements][][name]`	`string`	Name
`customDictionaries[][elements][][code]`	`string`	Symbolic code
`customDictionaries[][elements][][ordering]`	`integer`	Sorting

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

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

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.

Parameters

Parameter	Type	Format	Description
`customDictionary`	`object (SerializedCustomDictionary)`
`customDictionary[name]`	`string`	`{not blank}`	Name
`customDictionary[code]`	`string`	`{match: \|^[a-z][\w_-]+$\|}`	Symbolic code
`customDictionary[elements][]`	`array of objects (SerializedCustomDictionaryElement)`	`{not blank}`	Directory element
`customDictionary[elements][][name]`	`string`		Name
`customDictionary[elements][][code]`	`string`		Symbolic code
`customDictionary[elements][][ordering]`	`integer`		Sorting

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`code`	`string`	Symbolic code

HTTP statuses

Status code	Description
`201`	Directory has been successfully created
`400`	Error on query execution

GET /api/v5/custom-fields/dictionaries/{code} Getting information on directory

Getting information on directory

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

Parameters

Parameter	Type	Format	Description
`code`	`string`		Symbolic code

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`customDictionary`	`object (CustomDictionary)`	Directory
`customDictionary[name]`	`string`	Name
`customDictionary[code]`	`string`	Symbolic code
`customDictionary[elements][]`	`array of objects (SerializedCustomDictionaryElement)`	Directory element
`customDictionary[elements][][name]`	`string`	Name
`customDictionary[elements][][code]`	`string`	Symbolic code
`customDictionary[elements][][ordering]`	`integer`	Sorting

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`404`	Directory not found

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

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.

Parameters

Parameter	Type	Format	Description
`customDictionary`	`object (SerializedCustomDictionary)`
`customDictionary[name]`	`string`	`{not blank}`	Name
`customDictionary[elements][]`	`array of objects (SerializedCustomDictionaryElement)`	`{not blank}`	Directory element
`customDictionary[elements][][name]`	`string`		Name
`customDictionary[elements][][code]`	`string`		Symbolic code
`customDictionary[elements][][ordering]`	`integer`		Sorting

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`code`	`string`	Symbolic code

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution
`404`	Directory not found

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

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.

Parameters

Parameter	Type	Format	Description
`customField`	`object (SerializedCustomFieldApiDocModel)`
`customField[name]`	`string`	`{not blank}`	Name
`customField[type]`	`string`	`{not blank}[boolean\|date\|datetime\|dictionary\|email\|integer\|multiselect_dictionary\|numeric\|string\|text]}`	Field type
`customField[entity]`	`choice`	`{not blank}[customer\|loyalty_account\|order]}`	Fields for the table
`customField[code]`	`string`	`{match: \|^[a-z][\w_]+$\|}`	Symbolic code
`customField[ordering]`	`integer`	`{range: {>=0}}`	Sorting
`customField[displayArea]`	`string`	`[address\|customer\|delivery\|dimensions\|legal_details\|main_data\|payment\|shipment]`	Display area
`customField[viewMode]`	`string`	`[editable\|miss\|not_editable]`	Field view in the form
`customField[viewModeMobile]`	`string`	`[editable\|miss\|not_editable]`	Field view in mobile application
`customField[required]`	`boolean`		Mandatory
`customField[inFilter]`	`boolean`		Available in filter
`customField[inList]`	`boolean`		Available in list
`customField[inGroupActions]`	`boolean`		Available in group actions
`customField[default]`	`string`		`deprecated` Default value
`customField[dictionary]`	`string`		Related dictionary
`customField[defaultTyped]`	`custom handler result for (mixed)`		Typed value by default
`entity`	`string`		Field for the table

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`code`	`string`	Symbolic code

HTTP statuses

Status code	Description
`201`	Custom field has been successfully created
`400`	Error on query execution

GET /api/v5/custom-fields/{entity}/{code} Getting information on custom fields

Getting information on custom fields

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

Parameters

Parameter	Type	Format	Description
`code`	`string`		Symbolic code
`entity`	`string`		Field for the table

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`customField`	`object (CustomFieldApiDocModel)`
`customField[name]`	`string`	Name
`customField[code]`	`string`	Symbolic code
`customField[required]`	`boolean`	Mandatory
`customField[inFilter]`	`boolean`	Available in filter
`customField[inList]`	`boolean`	Available in list
`customField[inGroupActions]`	`boolean`	Available in group actions
`customField[type]`	`string`	Field type
`customField[entity]`	`string`	Fields for the table
`customField[default]`	`string`	`deprecated` Default value
`customField[ordering]`	`integer`	Sorting
`customField[displayArea]`	`string`	Display area
`customField[viewMode]`	`string`	Field view in the form
`customField[viewModeMobile]`	`string`	Field view in mobile application
`customField[dictionary]`	`string`	Related dictionary
`customField[defaultTyped]`	`custom handler result for (mixed)`	Typed value by default

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`404`	Custom field not found

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

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

Parameters

Parameter	Type	Format	Description
`customField`	`object (SerializedCustomFieldApiDocModel)`
`customField[name]`	`string`	`{not blank}`	Name
`customField[ordering]`	`integer`	`{not blank}{range: {>=0}}}`	Sorting
`customField[displayArea]`	`string`	`[address\|customer\|delivery\|dimensions\|legal_details\|main_data\|payment\|shipment]`	Display area
`customField[viewMode]`	`string`	`[editable\|miss\|not_editable]`	Field view in the form
`customField[viewModeMobile]`	`string`	`[editable\|miss\|not_editable]`	Field view in mobile application
`customField[required]`	`boolean`		Mandatory
`customField[inFilter]`	`boolean`		Available in filter
`customField[inList]`	`boolean`		Available in list
`customField[inGroupActions]`	`boolean`		Available in group actions
`customField[default]`	`string`		`deprecated` Default value
`customField[defaultTyped]`	`custom handler result for (mixed)`		Typed value by default
`entity`	`string`		Field for the table

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`code`	`string`	Symbolic code

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution
`404`	Custom field not found

Customers

GET /api/v5/customers Getting the list of customers matched the specified filter

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.

Parameters

Parameter	Type	Format	Description
`limit`	`integer`	`{not blank}[20\|50\|100]}`	Quantity of elements in the answer (20 by default)
`page`	`integer`	`{not blank}{range: {>=1}}}`	Number of page with the results (1 by default)
`filter`	`object (CustomerFilterData)`
`filter[ids][]`	`array of integers`		Array of customers ID
`filter[externalIds][]`	`array of strings`		Array of customers externalID
`filter[name]`	`string`	`{length: {max: 255}}`	Customer
`filter[city]`	`string`	`{length: {max: 255}}`	City
`filter[region]`	`string`	`{length: {max: 255}}`	Region
`filter[sites][]`	`array of strings`		Stores
`filter[managers][]`	`array of integers`		Managers
`filter[managerGroups][]`	`array of strings`		Manager groups
`filter[notes]`	`string`		Notes
`filter[vip]`	`boolean`		VIP customer
`filter[bad]`	`boolean`		BAD customer
`filter[discountCardNumber]`	`string`	`{length: {max: 255}}`	Discount card number
`filter[attachments]`	`integer`	`[1\|2\|3]`	Attachments
`filter[tasksCounts]`	`integer`	`[1\|2\|3]`	Tasks
`filter[email]`	`string`	`{length: {max: 255}}`	E-mail
`filter[contragentName]`	`string`	`{length: {max: 255}}`	Full name
`filter[contragentTypes][]`	`array of strings`	`{choice of [enterpreneur\|individual\|legal-entity]}`	Contractor types
`filter[contragentInn]`	`string`	`{match: /\d+/}`	VAT
`filter[contragentKpp]`	`string`	`{match: /\d+/}`	IEC
`filter[contragentBik]`	`string`	`{match: /\d+/}`	BIC
`filter[contragentCorrAccount]`	`string`	`{match: /\d+/}`	Corresponding account
`filter[contragentBankAccount]`	`string`	`{match: /\d+/}`	Bank account
`filter[classSegment]`	`string`	`{match: /^(monetary\|recency\|frequency)[0-2]_(recency\|frequency\|monetary)[0-2]$/}`	Segment
`filter[minOrdersCount]`	`integer`		Orders count (from)
`filter[maxOrdersCount]`	`integer`		Orders count (to)
`filter[minAverageSumm]`	`integer`		Average items per cart (from)
`filter[maxAverageSumm]`	`integer`		Average items per cart (to)
`filter[minTotalSumm]`	`integer`		Total sum (from)
`filter[maxTotalSumm]`	`integer`		Total sum (to)
`filter[minCostSumm]`	`integer`		Amount of costs (from)
`filter[maxCostSumm]`	`integer`		Amount of costs (to)
`filter[dateFrom]`	`DateTime`	`Y-m-d`	Registration date (from)
`filter[dateTo]`	`DateTime`	`Y-m-d`	Registration date (to)
`filter[firstOrderFrom]`	`DateTime`	`Y-m-d`	First order (from)
`filter[firstOrderTo]`	`DateTime`	`Y-m-d`	First order (to)
`filter[lastOrderFrom]`	`DateTime`	`Y-m-d`	First order (from)
`filter[lastOrderTo]`	`DateTime`	`Y-m-d`	Last order (to)
`filter[customFields]`	`array`		Custom fields
`filter[sex]`	`string`	`[female\|female_with_presumable\|male\|male_with_presumable]`	Sex
`filter[isContact]`	`boolean`		The customer is a contact person
`filter[subscriptions][]`	`array of objects (CustomerFilterCustomerSubscriptionData)`		Filter by user subscriptions
`filter[subscriptions][][channel]`	`string`		Subscription category channel
`filter[subscriptions][][subscription]`	`string`		Subscription category code
`filter[subscriptions][][subscribed]`	`boolean`		Is user subscribed
`filter[online]`	`boolean`		Customer is online
`filter[segment]`	`string`		Segment
`filter[commentary]`	`string`		Operator comment
`filter[browserId]`	`string`		Device ID in Collector
`filter[mgChannels][]`	`array of integers`		Chat channels
`filter[sourceName]`	`string`	`{length: {max: 255}}`	Source
`filter[mediumName]`	`string`	`{length: {max: 255}}`	Medium
`filter[campaignName]`	`string`	`{length: {max: 255}}`	Campaign
`filter[keywordName]`	`string`		Keyword
`filter[adContentName]`	`string`		Ad content
`filter[tags][]`	`array of strings`		Tags
`filter[attachedTags][]`	`array of strings`		List of attached tags (or)
`filter[countries][]`	`array of strings`		Countries
`filter[abandonedCart]`	`boolean`
`filter[emailMarketingUnsubscribed]`	`boolean`		`deprecated` Unsubscribed from emails
`filter[mgCustomerId]`	`string`		MessageGateway Customer ID
`filter[firstWebVisitFrom]`	`DateTime`	`Y-m-d`	First visit (from)
`filter[firstWebVisitTo]`	`DateTime`	`Y-m-d`	First visit (to)
`filter[lastWebVisitFrom]`	`DateTime`	`Y-m-d`	Last visit (from)
`filter[lastWebVisitTo]`	`DateTime`	`Y-m-d`	Last visit (to)

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`pagination`	`object (PaginationResponse)`	Pagination
`pagination[limit]`	`integer`	Quantity of elements in the answer
`pagination[totalCount]`	`integer`	Total quantity of found elements
`pagination[currentPage]`	`integer`	Current issuance page
`pagination[totalPageCount]`	`integer`	Total quantity of issuance pages
`customers[]`	`array of objects (Customer)`	Customer
`customers[][type]`	`string`	Customer type
`customers[][id]`	`integer`	Customer ID
`customers[][externalId]`	`string`	Customer external ID
`customers[][isContact]`	`boolean`	The customer is a contact person (created as the contact person and has no orders)
`customers[][createdAt]`	`DateTime`	Created at
`customers[][managerId]`	`integer`	Customer manager
`customers[][vip]`	`boolean`	VIP customer
`customers[][bad]`	`boolean`	Bad customer
`customers[][site]`	`string`	Store, from which the customer came
`customers[][contragent]`	`object (CustomerContragent)`	`deprecated` Requisites (The fields of the object should be used only if the "Corporate customers" functionality is disabled)
`customers[][contragent][contragentType]`	`string`	Contragent type
`customers[][contragent][legalName]`	`string`	Legal name
`customers[][contragent][legalAddress]`	`string`	Registration address
`customers[][contragent][INN]`	`string`	TIN
`customers[][contragent][OKPO]`	`string`	RNNBO
`customers[][contragent][KPP]`	`string`	IECC
`customers[][contragent][OGRN]`	`string`	PSRN
`customers[][contragent][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`customers[][contragent][certificateNumber]`	`string`	Certificate number
`customers[][contragent][certificateDate]`	`DateTime`	Certificate date
`customers[][contragent][BIK]`	`string`	RCBIC
`customers[][contragent][bank]`	`string`	Bank
`customers[][contragent][bankAddress]`	`string`	Bank address
`customers[][contragent][corrAccount]`	`string`	Corresponding account
`customers[][contragent][bankAccount]`	`string`	Settlement account
`customers[][tags][]`	`array of objects (CustomerTagLink)`	[array] Tags
`customers[][tags][][color]`	`string`
`customers[][tags][][name]`	`string`
`customers[][tags][][colorCode]`	`string`
`customers[][tags][][attached]`	`boolean`
`customers[][firstClientId]`	`string`	First Google Analytics clientId
`customers[][lastClientId]`	`string`	Last Google Analytics clientId
`customers[][customFields]`	`array`	Associative array of custom fields
`customers[][personalDiscount]`	`double`	Personal discount
`customers[][cumulativeDiscount]`	`double`	`deprecated` Cumulative discount (Not available starting from version 8 of the system)
`customers[][discountCardNumber]`	`string`	Discount card number
`customers[][avgMarginSumm]`	`float`	Average gross profit of customer orders (in base currency)
`customers[][marginSumm]`	`float`	LTV (in base currency)
`customers[][totalSumm]`	`float`	Orders total sum (in base currency)
`customers[][averageSumm]`	`float`	Order average sum (in base currency)
`customers[][ordersCount]`	`integer`	Orders quantity
`customers[][costSumm]`	`float`	Amount of costs (in base currency)
`customers[][address]`	`object (CustomerAddress)`	Customer address
`customers[][address][id]`	`integer`	Address ID
`customers[][address][index]`	`string`	Postal code
`customers[][address][countryIso]`	`string`	Country ISO code
`customers[][address][region]`	`string`	Region
`customers[][address][regionId]`	`integer`	Region ID in Geohelper
`customers[][address][city]`	`string`	City
`customers[][address][cityId]`	`integer`	City ID in Geohelper
`customers[][address][cityType]`	`string`	Locality type
`customers[][address][street]`	`string`	Street
`customers[][address][streetId]`	`integer`	Street ID in Geohelper
`customers[][address][streetType]`	`string`	Street type
`customers[][address][building]`	`string`	Building
`customers[][address][flat]`	`string`	Flat/office
`customers[][address][floor]`	`integer`	Floor
`customers[][address][block]`	`integer`	Entrance
`customers[][address][house]`	`string`	House
`customers[][address][housing]`	`string`	Housing
`customers[][address][metro]`	`string`	Underground
`customers[][address][notes]`	`string`	Notes to address
`customers[][address][text]`	`string`	Address as string
`customers[][address][externalId]`	`string`	External ID
`customers[][address][name]`	`string`	Name
`customers[][segments][]`	`array of objects (Segment)`	[array] Segments
`customers[][segments][][id]`	`integer`	Internal ID of segment
`customers[][segments][][code]`	`string`	Symbolic code
`customers[][segments][][name]`	`string`	Segment name
`customers[][segments][][createdAt]`	`DateTime`	Segment creation date
`customers[][segments][][isDynamic]`	`boolean`	Is this segment dynamic
`customers[][segments][][customersCount]`	`integer`	Customer quantity in segment
`customers[][segments][][active]`	`boolean`	Activity state of segment
`customers[][maturationTime]`	`integer`	Maturation time, in seconds
`customers[][firstName]`	`string`	Name
`customers[][lastName]`	`string`	Surname
`customers[][patronymic]`	`string`	Middle name
`customers[][sex]`	`string`	Sex
`customers[][presumableSex]`	`string`	Guessed gender based on name
`customers[][email]`	`string`	E-mail
`customers[][emailMarketingUnsubscribedAt]`	`DateTime`	`deprecated` Date of unsubscription from emails
`customers[][customerSubscriptions][]`	`array of objects (CustomerSubscription)`	Subscriptions
`customers[][customerSubscriptions][][subscription]`	`object (Subscription)`	Subscription category
`customers[][customerSubscriptions][][subscription][id]`	`integer`	Subscription category ID
`customers[][customerSubscriptions][][subscription][channel]`	`string`	Channel
`customers[][customerSubscriptions][][subscription][name]`	`string`	Name
`customers[][customerSubscriptions][][subscription][code]`	`string`	Symbolic code
`customers[][customerSubscriptions][][subscription][active]`	`boolean`	Activity status
`customers[][customerSubscriptions][][subscription][autoSubscribe]`	`boolean`	Automatically subscribe new clients
`customers[][customerSubscriptions][][subscription][ordering]`	`integer`
`customers[][customerSubscriptions][][subscribed]`	`boolean`	Subscription activity
`customers[][customerSubscriptions][][changedAt]`	`DateTime`	Activity flag change date
`customers[][phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`customers[][phones][][number]`	`string`	Phone number
`customers[][birthday]`	`DateTime`	Birthday
`customers[][source]`	`object (SerializedSource)`	Customer source
`customers[][source][source]`	`string`	Source
`customers[][source][medium]`	`string`	Medium
`customers[][source][campaign]`	`string`	Campaign
`customers[][source][keyword]`	`string`	Keyword
`customers[][source][content]`	`string`	Ad content
`customers[][mgCustomers][]`	`array of objects (MGCustomer)`	MessageGateway customers
`customers[][mgCustomers][][id]`	`integer`	Customer ID
`customers[][mgCustomers][][externalId]`	`integer`	External ID of the MessageGateway customer
`customers[][mgCustomers][][mgChannel]`	`object (MGChannel)`	MessageGateway channel
`customers[][mgCustomers][][mgChannel][allowedSendByPhone]`	`custom handler result for (bool)`	Whether it is possible to be the first to write in this channel by phone number
`customers[][mgCustomers][][mgChannel][id]`	`integer`	ID of the channel
`customers[][mgCustomers][][mgChannel][externalId]`	`integer`	External ID of the channel
`customers[][mgCustomers][][mgChannel][type]`	`string`	Channel type
`customers[][mgCustomers][][mgChannel][active]`	`boolean`	Channel activity
`customers[][mgCustomers][][mgChannel][name]`	`string`	Channel name
`customers[][photoUrl]`	`string`	URL of photo

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v5/customers/combine Combining of customers

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).

Parameters

Parameter	Type	Format	Description
`resultCustomer`	`object (SerializedCustomerReference)`	`{not blank}`	Customer, in which the combining will be made
`resultCustomer[id]`	`integer`	`{not blank}{range: {>=1, <=4294967295}}}`	Customer internal ID
`customers[]`	`array of objects (SerializedCustomerReference)`
`customers[][id]`	`integer`	`{not blank}{range: {>=1, <=4294967295}}}`	Customer internal ID

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v5/customers/create Customer creation

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.

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].

Parameters

Parameter	Type	Description
`site`	`string`	Symbolic code of store
`customer`	`object (SerializedCustomer)`
`customer[externalId]`	`string`	Customer external ID
`customer[isContact]`	`boolean`	The customer is a contact person (created as the contact person and has no orders)
`customer[createdAt]`	`DateTime`	Created at
`customer[vip]`	`boolean`	VIP customer
`customer[bad]`	`boolean`	Bad customer
`customer[contragent]`	`object (CustomerContragent)`	`deprecated` Requisites (The fields of the object should be used only if the "Corporate customers" functionality is disabled)
`customer[contragent][contragentType]`	`string`	Contragent type
`customer[contragent][legalName]`	`string`	Legal name
`customer[contragent][legalAddress]`	`string`	Registration address
`customer[contragent][INN]`	`string`	TIN
`customer[contragent][OKPO]`	`string`	RNNBO
`customer[contragent][KPP]`	`string`	IECC
`customer[contragent][OGRN]`	`string`	PSRN
`customer[contragent][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`customer[contragent][certificateNumber]`	`string`	Certificate number
`customer[contragent][certificateDate]`	`DateTime`	Certificate date
`customer[contragent][BIK]`	`string`	RCBIC
`customer[contragent][bank]`	`string`	Bank
`customer[contragent][bankAddress]`	`string`	Bank address
`customer[contragent][corrAccount]`	`string`	Corresponding account
`customer[contragent][bankAccount]`	`string`	Settlement account
`customer[customFields]`	`array`	Associative array of custom fields
`customer[personalDiscount]`	`double`	Personal discount
`customer[discountCardNumber]`	`string`	Discount card number
`customer[address]`	`object (CustomerAddress)`	Customer address
`customer[address][index]`	`string`	Postal code
`customer[address][countryIso]`	`string`	Country ISO code
`customer[address][region]`	`string`	Region
`customer[address][regionId]`	`integer`	Region ID in Geohelper
`customer[address][city]`	`string`	City
`customer[address][cityId]`	`integer`	City ID in Geohelper
`customer[address][cityType]`	`string`	Locality type
`customer[address][street]`	`string`	Street
`customer[address][streetId]`	`integer`	Street ID in Geohelper
`customer[address][streetType]`	`string`	Street type
`customer[address][building]`	`string`	Building
`customer[address][flat]`	`string`	Flat/office
`customer[address][floor]`	`integer`	Floor
`customer[address][block]`	`integer`	Entrance
`customer[address][house]`	`string`	House
`customer[address][housing]`	`string`	Housing
`customer[address][metro]`	`string`	Underground
`customer[address][notes]`	`string`	Notes to address
`customer[address][text]`	`string`	Address as string
`customer[firstName]`	`string`	Name
`customer[lastName]`	`string`	Surname
`customer[patronymic]`	`string`	Middle name
`customer[email]`	`string`	E-mail
`customer[emailMarketingUnsubscribedAt]`	`DateTime`	`deprecated` Date of unsubscription from emails
`customer[phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`customer[phones][][number]`	`string`	Phone number
`customer[birthday]`	`DateTime`	Birthday
`customer[photoUrl]`	`string`	URL of photo
`customer[managerId]`	`integer`	Customer manager
`customer[sex]`	`string`	Sex
`customer[source]`	`object (SerializedSource)`	Customer source
`customer[source][source]`	`string`	Source
`customer[source][medium]`	`string`	Medium
`customer[source][campaign]`	`string`	Campaign
`customer[source][keyword]`	`string`	Keyword
`customer[source][content]`	`string`	Ad content
`customer[mgCustomerId]`	`object (MGCustomer)`	MessageGateway customer ID
`customer[subscribed]`	`boolean`	The status of subscription to marketing mailings
`customer[tags][]`	`array of strings`	Tags to be set to customer
`customer[attachedTag]`	`string`	Attached tag
`customer[browserId]`	`string`	Device ID in Collector

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`id`	`integer`	Internal ID of created customer

HTTP statuses

Status code	Description
`201`	The customer is created
`400`	Error on customer creation

POST /api/v5/customers/fix-external-ids The mass recording of customers external ID

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.

Parameters

Parameter	Type	Format	Description
`customers[]`	`array of objects (FixExternalRow)`		Uploaded objects IDs
`customers[][id]`	`integer`	`{not blank}{range: {>=1, <=2147483647}}}`	Internal ID
`customers[][externalId]`	`string`	`{not blank}`	External ID

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

GET /api/v5/customers/history Getting the customer change history

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.

Parameters

Parameter	Type	Format	Description
`limit`	`integer`	`{not blank}[20\|50\|100]}`	Quantity of elements in the answer (20 by default)
`page`	`integer`	`{not blank}{range: {>=1}}}`	Number of page with the results (1 by default)
`filter`	`object (CustomerHistoryFilterV4Type)`
`filter[customerId]`	`integer`	`{range: {>=0, <=4294967295}}`	Customer ID
`filter[sinceId]`	`integer`	`{range: {>=0, <=4294967295}}`	Starting with customers history ID
`filter[customerExternalId]`	`string`	`{length: {max: 255}}`	Customer external ID
`filter[startDate]`	`DateTime`	`Y-m-d H:i:s`	Start DateTime of change
`filter[endDate]`	`DateTime`	`Y-m-d H:i:s`	End DateTime of change

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`generatedAt`	`DateTime`	Time of response formation
`history[]`	`array of objects (CustomerHistory)`
`history[][id]`	`integer`	Internal identifier of entry in the history
`history[][createdAt]`	`DateTime`	Date of making change
`history[][created]`	`boolean`	Notes that the entity is created
`history[][deleted]`	`boolean`	Notes that the entity is deleted
`history[][source]`	`string`	Date of making change
`history[][user]`	`object (User)`	User
`history[][user][id]`	`integer`	User ID
`history[][field]`	`string`	Name of changed field
`history[][oldValue]`	`custom handler result for (mixed)`	Old value of field
`history[][newValue]`	`custom handler result for (mixed)`	New value of field
`history[][apiKey]`	`object (ApiKey)`	Information about api key used for making this change
`history[][apiKey][current]`	`boolean`	The change was made with the api key currently in use
`history[][apiKey][id]`	`integer`	Api key ID
`history[][customer]`	`object (Customer)`	Customer
`history[][customer][id]`	`integer`	Customer ID
`history[][customer][externalId]`	`string`	Customer external ID
`history[][customer][site]`	`string`	Store, from which the customer came
`history[][address]`	`object (CustomerAddressWithIsMain)`	Customer address
`history[][address][id]`	`integer`	Customer address ID
`history[][address][externalId]`	`string`	External ID
`history[][address][name]`	`string`	Name
`history[][address][isMain]`	`boolean`	Customer address is main
`history[][combinedTo]`	`object (Customer)`	Information about the customer that was created after combining with the current customer
`history[][subscription]`	`object (Subscription)`	Subscription category
`history[][subscription][channel]`	`string`	Channel
`history[][subscription][name]`	`string`	Name
`history[][subscription][code]`	`string`	Symbolic code
`pagination`	`object (PaginationResponse)`	Pagination
`pagination[limit]`	`integer`	Quantity of elements in the answer
`pagination[totalCount]`	`integer`	Total quantity of found elements
`pagination[currentPage]`	`integer`	Current issuance page
`pagination[totalPageCount]`	`integer`	Total quantity of issuance pages

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

GET /api/v5/customers/notes Getting the notes

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.

Parameters

Parameter	Type	Format	Description
`limit`	`integer`	`{not blank}[20\|50\|100]}`	Quantity of elements in the answer (20 by default)
`page`	`integer`	`{not blank}{range: {>=1}}}`	Number of page with the results (1 by default)
`filter`	`object (CustomerNoteFilter)`
`filter[ids]`	`array of integers`		Notes ID
`filter[customerIds]`	`array of integers`		Customers internal ID
`filter[customerExternalIds]`	`array of strings`		Customers external ID
`filter[managerIds]`	`array of integers`		Managers ID
`filter[text]`	`string`		Note text
`filter[createdAtFrom]`	`string`		Date/time of creation (from)
`filter[createdAtTo]`	`string`		Date/time of creation (to)

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`pagination`	`object (PaginationResponse)`	Pagination
`pagination[limit]`	`integer`	Quantity of elements in the answer
`pagination[totalCount]`	`integer`	Total quantity of found elements
`pagination[currentPage]`	`integer`	Current issuance page
`pagination[totalPageCount]`	`integer`	Total quantity of issuance pages
`notes[]`	`array of objects (CustomerNote)`	Note
`notes[][customer]`	`object (SerializedEntityCustomer)`	Customer
`notes[][customer][site]`	`string`	Symbolic code of store
`notes[][customer][id]`	`integer`	Customer internal ID
`notes[][customer][externalId]`	`string`	Customer external ID
`notes[][customer][type]`	`string`	Customer type
`notes[][managerId]`	`integer`	Manager ID
`notes[][id]`	`integer`	Note ID
`notes[][text]`	`string`	Note text
`notes[][createdAt]`	`DateTime`	Date/time of creation

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`400`	Error on query execution

POST /api/v5/customers/notes/create Note creation

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].

Parameters

Parameter	Type	Description
`site`	`string`	Symbolic code of store
`note`	`object (SerializedCustomerNote)`	Note
`note[managerId]`	`integer`	Manager internal ID
`note[text]`	`string`	Note text
`note[customer]`	`object (SerializedEntityCustomer)`	Customer
`note[customer][id]`	`integer`	Customer internal ID
`note[customer][externalId]`	`string`	Customer external ID

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`id`	`integer`	Internal ID of created note

HTTP statuses

Status code	Description
`201`	Note has been successfully created
`400`	Error on note creation

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

Note removing

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

Parameters

Parameter	Type	Format	Description
`id`	`integer`		Note ID

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	Note has been successfully removed
`404`	Note not found

POST /api/v5/customers/upload Packet customers uploading

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.

Parameters

Parameter	Type	Description
`site`	`string`	Symbolic code of store, which includes downloadable customers
`customers[]`	`array of objects (SerializedCustomer)`
`customers[][externalId]`	`string`	Customer external ID
`customers[][isContact]`	`boolean`	The customer is a contact person (created as the contact person and has no orders)
`customers[][createdAt]`	`DateTime`	Created at
`customers[][vip]`	`boolean`	VIP customer
`customers[][bad]`	`boolean`	Bad customer
`customers[][customFields]`	`array`	Associative array of custom fields
`customers[][personalDiscount]`	`double`	Personal discount
`customers[][discountCardNumber]`	`string`	Discount card number
`customers[][address]`	`object (CustomerAddress)`	Customer address
`customers[][address][index]`	`string`	Postal code
`customers[][address][countryIso]`	`string`	Country ISO code
`customers[][address][region]`	`string`	Region
`customers[][address][regionId]`	`integer`	Region ID in Geohelper
`customers[][address][city]`	`string`	City
`customers[][address][cityId]`	`integer`	City ID in Geohelper
`customers[][address][cityType]`	`string`	Locality type
`customers[][address][street]`	`string`	Street
`customers[][address][streetId]`	`integer`	Street ID in Geohelper
`customers[][address][streetType]`	`string`	Street type
`customers[][address][building]`	`string`	Building
`customers[][address][flat]`	`string`	Flat/office
`customers[][address][floor]`	`integer`	Floor
`customers[][address][block]`	`integer`	Entrance
`customers[][address][house]`	`string`	House
`customers[][address][housing]`	`string`	Housing
`customers[][address][metro]`	`string`	Underground
`customers[][address][notes]`	`string`	Notes to address
`customers[][address][text]`	`string`	Address as string
`customers[][firstName]`	`string`	Name
`customers[][lastName]`	`string`	Surname
`customers[][patronymic]`	`string`	Middle name
`customers[][email]`	`string`	E-mail
`customers[][emailMarketingUnsubscribedAt]`	`DateTime`	`deprecated` Date of unsubscription from emails
`customers[][phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`customers[][phones][][number]`	`string`	Phone number
`customers[][birthday]`	`DateTime`	Birthday
`customers[][photoUrl]`	`string`	URL of photo
`customers[][managerId]`	`integer`	Customer manager
`customers[][sex]`	`string`	Sex
`customers[][source]`	`object (SerializedSource)`	Customer source
`customers[][source][source]`	`string`	Source
`customers[][source][medium]`	`string`	Medium
`customers[][source][campaign]`	`string`	Campaign
`customers[][source][keyword]`	`string`	Keyword
`customers[][source][content]`	`string`	Ad content
`customers[][mgCustomerId]`	`object (MGCustomer)`	MessageGateway customer ID
`customers[][subscribed]`	`boolean`	The status of subscription to marketing mailings
`customers[][tags][]`	`array of strings`	Tags to be set to customer
`customers[][attachedTag]`	`string`	Attached tag
`customers[][browserId]`	`string`	Device ID in Collector

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`uploadedCustomers[]`	`array of objects (FixExternalRow)`	Uploaded objects IDs
`uploadedCustomers[][id]`	`integer`	Internal ID
`uploadedCustomers[][externalId]`	`string`	External ID
`failedCustomers[]`	`array of objects (EntityWithExternalId)`	Non-uploaded objects IDs
`failedCustomers[][externalId]`	`string`	External ID (if available)

HTTP statuses

Status code	Description
`201`	All customers were successfully uploaded
`400`	Array of customers is not transmitted, or the array is too large
`460`	During uploading the errors occurred. The part of customers is not loaded (the response also contains an "errors" array)

GET /api/v5/customers/{externalId} Getting information on customer

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).

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.

Parameters

Parameter	Type	Format	Description
`externalId`	`string`		Customer ID

Filter parameters

Parameter Description

by

Template	`id\|externalId`
Default value	`externalId`
Description	Is specified what is transmitted in parameter externalId: internal (by=id) or external (by=externalId) customer ID. By default it is externalId.

site

Description

Symbolic code of store

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`customer`	`object (Customer)`	Customer
`customer[type]`	`string`	Customer type
`customer[id]`	`integer`	Customer ID
`customer[externalId]`	`string`	Customer external ID
`customer[isContact]`	`boolean`	The customer is a contact person (created as the contact person and has no orders)
`customer[createdAt]`	`DateTime`	Created at
`customer[managerId]`	`integer`	Customer manager
`customer[vip]`	`boolean`	VIP customer
`customer[bad]`	`boolean`	Bad customer
`customer[site]`	`string`	Store, from which the customer came
`customer[contragent]`	`object (CustomerContragent)`	`deprecated` Requisites (The fields of the object should be used only if the "Corporate customers" functionality is disabled)
`customer[contragent][contragentType]`	`string`	Contragent type
`customer[contragent][legalName]`	`string`	Legal name
`customer[contragent][legalAddress]`	`string`	Registration address
`customer[contragent][INN]`	`string`	TIN
`customer[contragent][OKPO]`	`string`	RNNBO
`customer[contragent][KPP]`	`string`	IECC
`customer[contragent][OGRN]`	`string`	PSRN
`customer[contragent][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`customer[contragent][certificateNumber]`	`string`	Certificate number
`customer[contragent][certificateDate]`	`DateTime`	Certificate date
`customer[contragent][BIK]`	`string`	RCBIC
`customer[contragent][bank]`	`string`	Bank
`customer[contragent][bankAddress]`	`string`	Bank address
`customer[contragent][corrAccount]`	`string`	Corresponding account
`customer[contragent][bankAccount]`	`string`	Settlement account
`customer[tags][]`	`array of objects (CustomerTagLink)`	[array] Tags
`customer[tags][][color]`	`string`
`customer[tags][][name]`	`string`
`customer[tags][][colorCode]`	`string`
`customer[tags][][attached]`	`boolean`
`customer[firstClientId]`	`string`	First Google Analytics clientId
`customer[lastClientId]`	`string`	Last Google Analytics clientId
`customer[customFields]`	`array`	Associative array of custom fields
`customer[personalDiscount]`	`double`	Personal discount
`customer[cumulativeDiscount]`	`double`	`deprecated` Cumulative discount (Not available starting from version 8 of the system)
`customer[discountCardNumber]`	`string`	Discount card number
`customer[avgMarginSumm]`	`float`	Average gross profit of customer orders (in base currency)
`customer[marginSumm]`	`float`	LTV (in base currency)
`customer[totalSumm]`	`float`	Orders total sum (in base currency)
`customer[averageSumm]`	`float`	Order average sum (in base currency)
`customer[ordersCount]`	`integer`	Orders quantity
`customer[costSumm]`	`float`	Amount of costs (in base currency)
`customer[address]`	`object (CustomerAddress)`	Customer address
`customer[address][id]`	`integer`	Address ID
`customer[address][index]`	`string`	Postal code
`customer[address][countryIso]`	`string`	Country ISO code
`customer[address][region]`	`string`	Region
`customer[address][regionId]`	`integer`	Region ID in Geohelper
`customer[address][city]`	`string`	City
`customer[address][cityId]`	`integer`	City ID in Geohelper
`customer[address][cityType]`	`string`	Locality type
`customer[address][street]`	`string`	Street
`customer[address][streetId]`	`integer`	Street ID in Geohelper
`customer[address][streetType]`	`string`	Street type
`customer[address][building]`	`string`	Building
`customer[address][flat]`	`string`	Flat/office
`customer[address][floor]`	`integer`	Floor
`customer[address][block]`	`integer`	Entrance
`customer[address][house]`	`string`	House
`customer[address][housing]`	`string`	Housing
`customer[address][metro]`	`string`	Underground
`customer[address][notes]`	`string`	Notes to address
`customer[address][text]`	`string`	Address as string
`customer[address][externalId]`	`string`	External ID
`customer[address][name]`	`string`	Name
`customer[segments][]`	`array of objects (Segment)`	[array] Segments
`customer[segments][][id]`	`integer`	Internal ID of segment
`customer[segments][][code]`	`string`	Symbolic code
`customer[segments][][name]`	`string`	Segment name
`customer[segments][][createdAt]`	`DateTime`	Segment creation date
`customer[segments][][isDynamic]`	`boolean`	Is this segment dynamic
`customer[segments][][customersCount]`	`integer`	Customer quantity in segment
`customer[segments][][active]`	`boolean`	Activity state of segment
`customer[maturationTime]`	`integer`	Maturation time, in seconds
`customer[firstName]`	`string`	Name
`customer[lastName]`	`string`	Surname
`customer[patronymic]`	`string`	Middle name
`customer[sex]`	`string`	Sex
`customer[presumableSex]`	`string`	Guessed gender based on name
`customer[email]`	`string`	E-mail
`customer[emailMarketingUnsubscribedAt]`	`DateTime`	`deprecated` Date of unsubscription from emails
`customer[customerSubscriptions][]`	`array of objects (CustomerSubscription)`	Subscriptions
`customer[customerSubscriptions][][subscription]`	`object (Subscription)`	Subscription category
`customer[customerSubscriptions][][subscription][id]`	`integer`	Subscription category ID
`customer[customerSubscriptions][][subscription][channel]`	`string`	Channel
`customer[customerSubscriptions][][subscription][name]`	`string`	Name
`customer[customerSubscriptions][][subscription][code]`	`string`	Symbolic code
`customer[customerSubscriptions][][subscription][active]`	`boolean`	Activity status
`customer[customerSubscriptions][][subscription][autoSubscribe]`	`boolean`	Automatically subscribe new clients
`customer[customerSubscriptions][][subscription][ordering]`	`integer`
`customer[customerSubscriptions][][subscribed]`	`boolean`	Subscription activity
`customer[customerSubscriptions][][changedAt]`	`DateTime`	Activity flag change date
`customer[phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`customer[phones][][number]`	`string`	Phone number
`customer[birthday]`	`DateTime`	Birthday
`customer[source]`	`object (SerializedSource)`	Customer source
`customer[source][source]`	`string`	Source
`customer[source][medium]`	`string`	Medium
`customer[source][campaign]`	`string`	Campaign
`customer[source][keyword]`	`string`	Keyword
`customer[source][content]`	`string`	Ad content
`customer[mgCustomers][]`	`array of objects (MGCustomer)`	MessageGateway customers
`customer[mgCustomers][][id]`	`integer`	Customer ID
`customer[mgCustomers][][externalId]`	`integer`	External ID of the MessageGateway customer
`customer[mgCustomers][][mgChannel]`	`object (MGChannel)`	MessageGateway channel
`customer[mgCustomers][][mgChannel][allowedSendByPhone]`	`custom handler result for (bool)`	Whether it is possible to be the first to write in this channel by phone number
`customer[mgCustomers][][mgChannel][id]`	`integer`	ID of the channel
`customer[mgCustomers][][mgChannel][externalId]`	`integer`	External ID of the channel
`customer[mgCustomers][][mgChannel][type]`	`string`	Channel type
`customer[mgCustomers][][mgChannel][active]`	`boolean`	Channel activity
`customer[mgCustomers][][mgChannel][name]`	`string`	Channel name
`customer[photoUrl]`	`string`	URL of photo

HTTP statuses

Status code	Description
`200`	The query was successfully executed
`404`	Customer not found (if the customer was deleted as a result of a merge, the data of the target customer will be in the "combinedTo" field)

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

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.

The fields customer[personalDiscount] and customer[discountCardNumber] are received, if they are active in the "Loyalty" module settings.

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.

Parameters

Parameter	Type	Description
`by`	`string`	Is specified what is transmitted in parameter externalId: internal (by=id) or external (by=externalId) customer ID. By default it is externalId.
`site`	`string`	Symbolic code of store
`customer`	`object (SerializedCustomer)`
`customer[externalId]`	`string`	Customer external ID
`customer[isContact]`	`boolean`	The customer is a contact person (created as the contact person and has no orders)
`customer[createdAt]`	`DateTime`	Created at
`customer[vip]`	`boolean`	VIP customer
`customer[bad]`	`boolean`	Bad customer
`customer[contragent]`	`object (CustomerContragent)`	`deprecated` Requisites (The fields of the object should be used only if the "Corporate customers" functionality is disabled)
`customer[contragent][contragentType]`	`string`	Contragent type
`customer[contragent][legalName]`	`string`	Legal name
`customer[contragent][legalAddress]`	`string`	Registration address
`customer[contragent][INN]`	`string`	TIN
`customer[contragent][OKPO]`	`string`	RNNBO
`customer[contragent][KPP]`	`string`	IECC
`customer[contragent][OGRN]`	`string`	PSRN
`customer[contragent][OGRNIP]`	`string`	PSRN of Individual entrepreneur
`customer[contragent][certificateNumber]`	`string`	Certificate number
`customer[contragent][certificateDate]`	`DateTime`	Certificate date
`customer[contragent][BIK]`	`string`	RCBIC
`customer[contragent][bank]`	`string`	Bank
`customer[contragent][bankAddress]`	`string`	Bank address
`customer[contragent][corrAccount]`	`string`	Corresponding account
`customer[contragent][bankAccount]`	`string`	Settlement account
`customer[customFields]`	`array`	Associative array of custom fields
`customer[personalDiscount]`	`double`	Personal discount
`customer[discountCardNumber]`	`string`	Discount card number
`customer[address]`	`object (CustomerAddress)`	Customer address
`customer[address][index]`	`string`	Postal code
`customer[address][countryIso]`	`string`	Country ISO code
`customer[address][region]`	`string`	Region
`customer[address][regionId]`	`integer`	Region ID in Geohelper
`customer[address][city]`	`string`	City
`customer[address][cityId]`	`integer`	City ID in Geohelper
`customer[address][cityType]`	`string`	Locality type
`customer[address][street]`	`string`	Street
`customer[address][streetId]`	`integer`	Street ID in Geohelper
`customer[address][streetType]`	`string`	Street type
`customer[address][building]`	`string`	Building
`customer[address][flat]`	`string`	Flat/office
`customer[address][floor]`	`integer`	Floor
`customer[address][block]`	`integer`	Entrance
`customer[address][house]`	`string`	House
`customer[address][housing]`	`string`	Housing
`customer[address][metro]`	`string`	Underground
`customer[address][notes]`	`string`	Notes to address
`customer[address][text]`	`string`	Address as string
`customer[firstName]`	`string`	Name
`customer[lastName]`	`string`	Surname
`customer[patronymic]`	`string`	Middle name
`customer[email]`	`string`	E-mail
`customer[emailMarketingUnsubscribedAt]`	`DateTime`	`deprecated` Date of unsubscription from emails
`customer[phones][]`	`array of objects (CustomerPhone)`	Phone numbers
`customer[phones][][number]`	`string`	Phone number
`customer[birthday]`	`DateTime`	Birthday
`customer[photoUrl]`	`string`	URL of photo
`customer[managerId]`	`integer`	Customer manager
`customer[sex]`	`string`	Sex
`customer[source]`	`object (SerializedSource)`	Customer source
`customer[source][source]`	`string`	Source
`customer[source][medium]`	`string`	Medium
`customer[source][campaign]`	`string`	Campaign
`customer[source][keyword]`	`string`	Keyword
`customer[source][content]`	`string`	Ad content
`customer[mgCustomerId]`	`object (MGCustomer)`	MessageGateway customer ID
`customer[subscribed]`	`boolean`	The status of subscription to marketing mailings
`customer[addTags][]`	`array of strings`	Tags to be added to customer
`customer[removeTags][]`	`array of strings`	Tags to be removed from customer
`customer[tags][]`	`array of strings`	Tags to be set to customer
`customer[attachedTag]`	`string`	Attached tag
`customer[browserId]`	`string`	Device ID in Collector

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)
`id`	`integer`	Customer internal ID
`state`	`string`	Customer customer (not returned by default)

HTTP statuses

Status code	Description
`200`	The customer was successfully changed
`400`	Error on customer editing

POST /api/v5/customers/{externalId}/subscriptions Subscribe/unsubscribe customer to mailings

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 customer[subscriptions].

If the field customer[subscriptions][][subscription] is not provided, a subscription or unsubscription is made for all subscription types to the channel customer[subscriptions][][channel].

The field customer[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.

Parameters

Parameter	Type	Format	Description
`by`	`string`		Is specified what is transmitted in parameter externalId: internal (by=id) or external (by=externalId) customer ID. By default it is externalId.
`site`	`string`		Symbolic code of store
`subscriptions[]`	`array of objects (SerializedSubscription)`
`subscriptions[][channel]`	`string`	`{not blank}[email\|sms\|waba]}`	Channel
`subscriptions[][subscription]`	`string`		Subscription category code
`subscriptions[][active]`	`boolean`	`{not blank}`	Subscription status
`subscriptions[][messageId]`	`integer`		Unsubscribe message ID

Response

Parameter	Type	Description
`success`	`boolean`	Query result (successful/unsuccessful)

HTTP statuses

Status code	Description
`200`	Subscription status has been successfully changed
`400`	Error on subscription status changing

Corporate customers

GET /api/v5/customers-corporate Getting the list of corporate customers matched the specified filter

Getting the list of corporate customers matched the specified filter