Skip to content
English
Go to brandwizard.io
  • There are no suggestions because the search field is empty.

Catalog company link API

Contents:

In this documentation, you can find descriptions of the methods of the BrandWizard API in the Catalog company link section.

 

 

Method GET/public/v1/ccl/

  • Description: Get a list of objects of communication of companies with directories.

  • Request Parameters:

    Parameter Type Required? Description
    brand_ids
    array[integer]
    		 No List of brand IDs
    catalog_ids
    array[number]
    		 No List of catalog IDs
    catalog_type
    		 string No

    Catalog type:

    • map – Maps, Social networks, Catalogs
    • navigator – Navigators
    city_ids array[integer] No List of city IDs
    company_group_ids
    		 array[integer] No List of company group IDs
    company_ids array[integer] No List of company IDs
    count
    		 integer No Number of results for paginated return
    need_action boolean No CCL status "action required"
    page integer No Page number within the pagination result set
    status string No

    Status:

    • sended – Sent
    • action_needed – Action required
    • synced – Synchronized
    • access_transfer_required – Access transfer required
  • Response Fields: 

Field

 Type 

Description
count integer Number of results
next string Link to the next page
previous string Link to the previous page
results id integer Company–catalog link ID
company id integer Company ID
name string Company name
code string Company code
address country string Country where the company is located
country_code string Country code
region string Region
city string City
street string Street
housenumber string House number
postcode string Postal code
description string Additional information about the company's location
lat number Latitude coordinates
lon number Longitude coordinates
categories id integer Category ID
name string Category name
is_main boolean Main category: Yes/No
brand id integer Brand ID
name string Brand name
catalog string Catalog
origin_url string Unique company links in the catalog
control_panel_status string Control panel status: 
• synced 
• sent
rating number Company rating in the catalog (only for major catalogs and Google Maps, excluding GMB)
state_status string State status: 
• send 
• on_moderation 
• unsupported_region 
• sync
verification_status string Verification status: 
• not_verified 
• wait_verify
need_action boolean Action required to link the company: Yes/No

 

Method GET/public/v1/ccl/{id}/

  • Description: Get a list of objects of communication of companies with directories.

  • Request Parameters:

    Parameter Type Required? Description
    id
    integer
    		 Yes Company–catalog link ID
  • Response Fields: 
Field Type Description
id integer Company–catalog link ID
company id integer Company ID
name string Company name
code string Company code
address country string Country where the company is located
country_code string Country code
region string Region
city string City
street string Street
housenumber string House number
postcode string Postal code
description string Additional information about the company's location
lat number Latitude coordinates
lon number Longitude coordinates
categories id integer Category ID
name string Category name
is_main boolean Main category: Yes/No
brand id integer Brand ID
name string Brand name
catalog string Catalog
origin_url string Unique company links in the catalog
control_panel_status string Control panel status: 
• synced 
• sent
rating number Company rating in the catalog (only for major catalogs and Google Maps, excluding GMB)
state_status string State status: 
• send 
• on_moderation 
• unsupported_region 
• sync
verification_status string Verification status: 
• not_verified 
• wait_verify
need_action boolean Action required to link the company: Yes/No

 

 

Method GET/public/v1/ccl/{id}/check/

  • Description: Check the company connection with the catalog.

  • Request Parameters:

    Parameter Type Required? Description
    id
    integer
    		 Yes Company–catalog link ID
  • Response Fields: 
Field Type Description
id integer Company–catalog link ID
company id integer Company ID
name string Company name
code string Company code
address country string Country where the company is located
country_code string Country code
region string Region
city string City
street string Street
housenumber string House number
postcode string Postal code
description string Additional information about the company's location
lat number Latitude coordinates
lon number Longitude coordinates
categories id integer Category ID
name string Category name
is_main boolean Main category: Yes/No
brand id integer Brand ID
name string Brand name
catalog string Catalog
origin_url string Unique company links in the catalog
control_panel_status string Control panel status: 
• synced 
• sent
rating number Company rating in the catalog (only for major catalogs and Google Maps, excluding GMB)
state_status string State status: 
• send 
• on_moderation 
• unsupported_region 
• sync
verification_status string Verification status: 
• not_verified 
• wait_verify
need_action boolean Action required to link the company: Yes/No

 

 

Method GET/public/v1/ccl/brand_catalogs/

  • Description: Get a list of brand links to catalogs.
  • Request Parameters:
Parameter Type Required? Description
count
 integer No Number of results for paginated return
page integer No Page number within the pagination result set

  • Response Fields: 

    Field Type Description
    count integer Number of results
    next string Link to the next page
    previous string Link to the previous page
    results id integer Result ID
    brand id integer Brand ID
    name string Brand name
    features string Features
    catalog id integer Catalog ID
    logo string Catalog logo
    name string Name
    icon string Icon
    content_short string Short catalog description
    content string Full catalog description
    contact string Contact person's phone number
    email string Contact person's email
    avg_page_view number Average number of views
    avg_session_time number Average time spent (sec.)
    traffic integer Data processed by the site from all sources over a specific period. Value entered manually based on site data
    weight integer Catalog weight. Value used to sort catalogs when displaying aggregated company data across all catalogs
    website string Catalog name used in code (for filtering, etc.)
    is_copy_origin_url boolean Duplicate origin_url: Yes/No
    is_copy_action_needed boolean Duplicate Need Action status: Yes/No
    is_copy_is_oauth boolean Duplicate OAUTH: Yes/No
    is_oauth boolean Supports OAUTH authorization: Yes/No
    origin_id string Unique company identifier in the catalog
    origin_url string Unique company link in the catalog
    extra string Additional information
    location string Address
    collect_reviews boolean Reviews collected: Yes/No

 

 

Method POST/public/v1/ccl/brand_catalogs/

  • Description: Add a brand link to a catalog.
  • Request Parameters: None.

  • Request body:

Field Type Description
origin_id string Unique company identifier in the catalog
origin_url string Unique company link in the catalog
extra string Additional information
location string Address
collect_reviews boolean Reviews collected: Yes/No
  • Response Fields: 
Field Type Description
id integer Company–catalog link ID
brand id integer Company ID
name string Company name
features string Features
catalog id integer Catalog ID
logo string Catalog logo
name string Name
icon string Icon
content_short string Short catalog description
content string Full catalog description
contact string Contact person's phone number
email string Contact person's email
avg_page_view number Average number of views
avg_session_time number Average time spent (sec.)
traffic integer Data processed by the site from all sources over a specific period (entered manually based on site data)
weight integer Catalog weight (value used to sort catalogs when displaying aggregated company data across all catalogs)
website string Catalog name used in code (for filtering, etc.)
is_copy_origin_url boolean Duplicate origin_url: Yes/No
is_copy_action_needed boolean Duplicate Need Action status: Yes/No
is_copy_is_oauth boolean Duplicate OAUTH: Yes/No
is_oauth boolean Supports OAUTH authorization: Yes/No
origin_id string Unique company identifier in the catalog
origin_url string Unique company link in the catalog
extra string Additional information
location string Address
collect_reviews boolean Reviews collected: Yes/No

 

 

Method GET/public/v1/ccl/brand_catalogs/{brand}/

  • Description: Get the brand link to the catalog.
  • Request Parameters:
Parameter Type Required? Description
brand
 integer Yes Brand name
  • Response Fields: 
Field Type Description
id integer Company–catalog link ID
brand id integer Brand ID
name string Brand name
features string Features
catalog id integer Catalog ID
logo string Catalog logo
name string Name
icon string Icon
content_short string Short catalog description
content string Full catalog description
contact string Contact person's phone number
email string Contact person's email
avg_page_view number Average number of views
avg_session_time number Average time spent (sec.)
traffic integer Data processed by the site from all sources over a specific period (entered manually based on site data)
weight integer Catalog weight (value used to sort catalogs when displaying aggregated company data across all catalogs)
website string Catalog name used in code (for filtering, etc.)
is_copy_origin_url boolean Duplicate origin_url: Yes/No
is_copy_action_needed boolean Duplicate Need Action status: Yes/No
is_copy_is_oauth boolean Duplicate OAUTH: Yes/No
is_oauth boolean Supports OAUTH authorization: Yes/No
origin_id string Unique company identifier in the catalog
origin_url string Unique company link in the catalog
extra string Additional information
location string Address
collect_reviews boolean Reviews collected: Yes/No

 

 

Method PUT/public/v1/ccl/brand_catalogs/{brand}/

  • Description: Update brand link to catalog.
  • Request Parameters:
Parameter Type Required? Description
brand
 integer Yes Brand name
  • Request body:
Field Type  Description
origin_id string Unique company identifier in the catalog
origin_url string Unique company link in the catalog
extra string Additional information
location string Address
collect_reviews boolean Reviews collected: Yes/No

  • Response Fields: 

    Field Type  Description
    id integer Company–catalog link ID
    brand id integer Brand ID
    name string Brand name
    features string Features
    catalog id integer Catalog ID
    logo string Catalog logo
    name string Name
    icon string Icon
    content_short string Short catalog description
    content string Full catalog description
    contact string Contact person's phone number
    email string Contact person's email
    avg_page_view number Average number of views
    avg_session_time number Average time spent (sec.)
    traffic integer Data processed by the site from all sources over a specific period (entered manually based on site data)
    weight integer Catalog weight (value used to sort catalogs when displaying aggregated company data across all catalogs)
    website string Catalog name used in code (for filtering, etc.)
    is_copy_origin_url boolean Duplicate origin_url: Yes/No
    is_copy_action_needed boolean Duplicate Need Action status: Yes/No
    is_copy_is_oauth boolean Duplicate OAUTH: Yes/No
    is_oauth boolean Supports OAUTH authorization: Yes/No
    origin_id string Unique company identifier in the catalog
    origin_url string Unique company link in the catalog
    extra string Additional information
    location string Address
    collect_reviews boolean Reviews collected: Yes/No

 

 

Method PATCH/public/v1/ccl/brand_catalogs/{brand}/

  • Description: Update brand link to catalog.
  • Request Parameters:
Parameter Type Required? Description
brand
 integer Yes Brand name
  • Request body:
Field Type  Description
origin_id string Unique company identifier in the catalog
origin_url string Unique company link in the catalog
extra string Additional information
location string Address
collect_reviews boolean Reviews collected: Yes/No

  • Response Fields: 

    Field Type  Description
    id integer Company–catalog link ID
    brand id integer Brand ID
    name string Brand name
    features string Features
    catalog id integer Catalog ID
    logo string Catalog logo
    name string Name
    icon string Icon
    content_short string Short catalog description
    content string Full catalog description
    contact string Contact person's phone number
    email string Contact person's email
    avg_page_view number Average number of views
    avg_session_time number Average time spent (sec.)
    traffic integer Data processed by the site from all sources over a specific period (entered manually based on site data)
    weight integer Catalog weight (value used to sort catalogs when displaying aggregated company data across all catalogs)
    website string Catalog name used in code (for filtering, etc.)
    is_copy_origin_url boolean Duplicate origin_url: Yes/No
    is_copy_action_needed boolean Duplicate Need Action status: Yes/No
    is_copy_is_oauth boolean Duplicate OAUTH: Yes/No
    is_oauth boolean Supports OAUTH authorization: Yes/No
    origin_id string Unique company identifier in the catalog
    origin_url string Unique company link in the catalog
    extra string Additional information
    location string Address
    collect_reviews boolean Reviews collected: Yes/No

 

 

Method DELETE/public/v1/ccl/brand_catalogs/{brand}/

  • Description: Remove brand link from catalog.
  • Request Parameters:
Parameter Type Required? Description
brand
 integer Yes Brand name
  • Response Fields: None.

 

 

Method GET/public/v1/ccl/statistic/

  • Description: Get statistics on the relationship of companies with directories.
  • Request Parameters: None.
  • Response Fields:
Field Type Description
all integer Total number of company–catalog links
sync_count integer Number of synchronized companies
sended_count integer Number of sent companies (company data sent to the catalog)
action_needed_count integer Number of companies requiring action to be linked to the catalog
confirmation_count integer Number of verified companies