Skip to main content

CRM API

CRM Status

Standard REST API endpoints:

GET    /api/v1/manager-core/crm-status
POST /api/v1/manager-core/crm-status
PUT /api/v1/manager-core/crm-status/{id}
DELETE /api/v1/manager-core/crm-status/{id}

CRM Categories

Get Categories

GET /api/v1/manager-core/crm/categories

Store Category

POST /api/v1/manager-core/crm/categories

Request Body:

ParameterTypeRequiredValidation
namestringYesmax:255
slugstringYesmax:255, unique
iconstringNomax:255
typeintegerYesinteger (CRM type enum)

CRM Items

List Items

GET /api/v1/manager-core/crm/{categorySlug}

Parameters:

  • categorySlug (path) - Category slug (e.g., partners, suppliers)

Query Parameters:

ParameterTypeRequiredValidation
qstringNoSearch query
orderobjectNoSorting (row, desc)
filterobjectNoFilter object

Create Item

POST /api/v1/manager-core/crm/{categorySlug}

Uses CrmItemStoreRequest form request.

Parameters:

  • categorySlug (path) - Category slug

Update Item Type

POST /api/v1/manager-core/crm/{type}/add-from-other

Move item from one category to another.

Request Body:

ParameterTypeRequiredValidation
idintegerYesCRM item ID

Update Item

PUT /api/v1/manager-core/crm/{type}/{id}

Parameters:

  • type (path) - Category type
  • id (path) - Item ID (can be comma-separated for batch)

Request Body: Dynamic fields based on CRM configuration


Delete Item

DELETE /api/v1/manager-core/crm/{categorySlug}

Request Body:

ParameterTypeRequiredValidation
rowsinteger/arrayYesItem ID(s) to delete

Search Items

POST /api/v1/manager-core/crm/{type}/search

Request Body:

ParameterTypeRequiredValidation
qstringNomin:3
productsarrayNoarray, min:1

Parameters:

  • type (path) - Category type

Items with Prices

GET /api/v1/manager-core/crm/{type}/has-price

Get items that have associated product prices.

Parameters:

  • type (path) - Category type

Items with Income

GET /api/v1/manager-core/crm/{type}/has-income

Get items that have income records.

Parameters:

  • type (path) - Category type

CRM Inventory

Get Inventory

GET /api/v1/manager-core/crm/{categorySlug}/inventory/{id}

Parameters:

  • categorySlug (path) - Category slug
  • id (path) - CRM item ID

Edit Inventory

POST /api/v1/manager-core/crm/{categorySlug}/inventory/edit/{id}

Request Body:

ParameterTypeRequiredValidation
product_quantitymixedYes-

CRM Contacts

Add Contact

POST /api/v1/manager-core/crm/{categorySlug}/{id}/contact

Parameters:

  • categorySlug (path) - Category slug
  • id (path) - CRM item ID

Request Body:

ParameterTypeRequiredValidation
namestringNoContact name
emailstringNoContact email
phonestringNoContact phone
first_namestringNoFirst name
last_namestringNoLast name
skypestringNoSkype
facebookstringNoFacebook
instagramstringNoInstagram
tiktokstringNoTikTok

Edit Contact

POST /api/v1/manager-core/crm/{categorySlug}/contact/{id}

Parameters:

  • categorySlug (path) - Category slug
  • id (path) - Contact ID

Request Body:

ParameterTypeRequiredValidation
namestringNoContact name
emailstringNoContact email
phonestringNoContact phone
first_namestringNoFirst name
last_namestringNoLast name
skypestringNoSkype
facebookstringNoFacebook
instagramstringNoInstagram
tiktokstringNoTikTok
defaultbooleanNoSet as default contact

CRM Export

GET /api/v1/manager-core/crm/{type}/export/{exportType}

Parameters:

  • type (path) - Category type
  • exportType (path) - Export format: xlsx, xls, ods, pdf, csv

CRM Custom Fields

GET    /api/v1/manager-core/crm-custom-field-values
POST /api/v1/manager-core/crm-custom-field-values
PUT /api/v1/manager-core/crm-custom-field-values/{id}
DELETE /api/v1/manager-core/crm-custom-field-values/{id}

Partner Catalogs

Check Catalog Format

POST /api/v1/manager-core/crm/partners/catalogs/check

Check if a catalog file format is valid.

Parameters:

  • file (body) - Catalog file

List Catalogs

GET /api/v1/manager-core/crm/partners.catalogs

Create Catalog

POST /api/v1/manager-core/crm/partners.catalogs

Request Body:

ParameterTypeRequiredValidation
partner_idintegerYesPartner CRM ID
namestringYesCatalog name
filefileYesCatalog file

Get Catalog

GET /api/v1/manager-core/crm/partners.catalogs/{id}

Update Catalog

PUT /api/v1/manager-core/crm/partners.catalogs/{id}

Delete Catalog

DELETE /api/v1/manager-core/crm/partners.catalogs/{id}

List Catalog Products

GET /api/v1/manager-core/crm/catalogs.products

Create Catalog Product

POST /api/v1/manager-core/crm/catalogs.products

Update Catalog Product

PUT /api/v1/manager-core/crm/catalogs.products/{id}

Delete Catalog Product

DELETE /api/v1/manager-core/crm/catalogs.products/{id}