clientapi_atrocore.ProductChannelApi

All URIs are relative to https://demo.atropim.com/api/v1

Method	HTTP request	Description
add_relation_for_product_channel	POST /ProductChannel/{link}/relation	Add relation for ProductChannel
create_product_channel_item	POST /ProductChannel	Create a record of the ProductChannel
delete_product_channel_item	DELETE /ProductChannel/{id}	Delete a record of the ProductChannel
follow_product_channel	PUT /ProductChannel/{id}/subscription	Follow the ProductChannel stream
get_linked_items_for_product_channel_item	GET /ProductChannel/{id}/{link}	Returns linked entities for the ProductChannel
get_list_of_product_channel_items	GET /ProductChannel	Returns a collection of ProductChannel records
get_product_channel_item	GET /ProductChannel/{id}	Returns a record of the ProductChannel
link_product_channel	POST /ProductChannel/{id}/{link}	Link ProductChannel to Entities
mass_delete_product_channel	POST /ProductChannel/action/massDelete	Mass delete of ProductChannel data
mass_update_product_channel	PUT /ProductChannel/action/massUpdate	Mass update of ProductChannel data
remove_relation_for_product_channel	DELETE /ProductChannel/{link}/relation	Remove relation for ProductChannel
unfollow_product_channel	DELETE /ProductChannel/{id}/subscription	Unfollow the ProductChannel stream
unlink_product_channel	DELETE /ProductChannel/{id}/{link}	Unlink ProductChannel from Entities
update_product_channel_item	PUT /ProductChannel/{id}	Update a record of the ProductChannel

add_relation_for_product_channel

bool add_relation_for_product_channel(link, ids, foreign_ids)

Add relation for ProductChannel

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ProductChannelApi(api_client)
    link = 'link_example' # str | 
    ids = ['ids_example'] # List[str] | 
    foreign_ids = ['foreign_ids_example'] # List[str] | 

    try:
        # Add relation for ProductChannel
        api_response = api_instance.add_relation_for_product_channel(link, ids, foreign_ids)
        print("The response of ProductChannelApi->add_relation_for_product_channel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductChannelApi->add_relation_for_product_channel: %s\n" % e)

Parameters

Name	Type	Description	Notes
link	str
ids	List[str]
foreign_ids	List[str]

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_product_channel_item

ProductChannel create_product_channel_item(create_product_channel_item_request)

Create a record of the ProductChannel

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_product_channel_item_request import CreateProductChannelItemRequest
from clientapi_atrocore.models.product_channel import ProductChannel
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ProductChannelApi(api_client)
    create_product_channel_item_request = clientapi_atrocore.CreateProductChannelItemRequest() # CreateProductChannelItemRequest | 

    try:
        # Create a record of the ProductChannel
        api_response = api_instance.create_product_channel_item(create_product_channel_item_request)
        print("The response of ProductChannelApi->create_product_channel_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductChannelApi->create_product_channel_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_product_channel_item_request	CreateProductChannelItemRequest

Return type

ProductChannel

Authorization

Authorization-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_product_channel_item

bool delete_product_channel_item(id)

Delete a record of the ProductChannel

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ProductChannelApi(api_client)
    id = 'id_example' # str | 

    try:
        # Delete a record of the ProductChannel
        api_response = api_instance.delete_product_channel_item(id)
        print("The response of ProductChannelApi->delete_product_channel_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductChannelApi->delete_product_channel_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

follow_product_channel

FollowAccount200Response follow_product_channel(id)

Follow the ProductChannel stream

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.follow_account200_response import FollowAccount200Response
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ProductChannelApi(api_client)
    id = 'id_example' # str | 

    try:
        # Follow the ProductChannel stream
        api_response = api_instance.follow_product_channel(id)
        print("The response of ProductChannelApi->follow_product_channel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductChannelApi->follow_product_channel: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

FollowAccount200Response

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_linked_items_for_product_channel_item

GetLinkedItemsForAccountItem200Response get_linked_items_for_product_channel_item(id, link, language=language)

Returns linked entities for the ProductChannel

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_linked_items_for_account_item200_response import GetLinkedItemsForAccountItem200Response
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ProductChannelApi(api_client)
    id = 'id_example' # str | 
    link = 'link_example' # str | 
    language = 'language_example' # str | Set this parameter for data to be returned for a specified language (optional)

    try:
        # Returns linked entities for the ProductChannel
        api_response = api_instance.get_linked_items_for_product_channel_item(id, link, language=language)
        print("The response of ProductChannelApi->get_linked_items_for_product_channel_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductChannelApi->get_linked_items_for_product_channel_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
link	str
language	str	Set this parameter for data to be returned for a specified language	[optional]

Return type

GetLinkedItemsForAccountItem200Response

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_list_of_product_channel_items

GetListOfProductChannelItems200Response get_list_of_product_channel_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)

Returns a collection of ProductChannel records

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_list_of_product_channel_items200_response import GetListOfProductChannelItems200Response
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ProductChannelApi(api_client)
    language = 'language_example' # str | Set this parameter for data to be returned for a specified language (optional)
    select = 'name,createdAt' # str | Available fields: channel, channelId, channelName, channel_code, channel_createdAt, channel_createdBy, channel_createdById, channel_createdByName, channel_description, channel_descriptionDeDe, channel_filterCreateImportJob, channel_filterUpdateImportJob, channel_isActive, channel_locales, channel_modifiedAt, channel_modifiedBy, channel_modifiedById, channel_modifiedByName, channel_name, channel_nameDeDe, channel_type, createdAt, createdBy, createdById, createdByName, deleted, filterCreateImportJob, filterUpdateImportJob, id, isActive, isInherited, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, product, productId, productName, product_amount, product_assignedUser, product_assignedUserId, product_assignedUserName, product_brand, product_brandId, product_brandName, product_catalog, product_catalogId, product_catalogName, product_createdAt, product_createdBy, product_createdById, product_createdByName, product_data, product_ean, product_filterCreateImportJob, product_filterUpdateImportJob, product_hasChildren, product_hierarchyRoute, product_hierarchySortOrder, product_inheritedFields, product_isActive, product_isInheritAssignedUser, product_isInheritOwnerUser, product_isInheritTeams, product_isRoot, product_longDescription, product_longDescriptionDeDe, product_mainImageId, product_mainImageName, product_mainImagePathsData, product_modifiedAt, product_modifiedAtExpanded, product_modifiedBy, product_modifiedById, product_modifiedByName, product_mpn, product_name, product_nameDeDe, product_ownerUser, product_ownerUserId, product_ownerUserName, product_packaging, product_packagingId, product_packagingName, product_price, product_priceCurrency, product_productSerie, product_productSerieId, product_productSerieName, product_productStatus, product_scope, product_sku, product_sortOrder, product_sorting, product_tag, product_taskStatus, product_tax, product_taxId, product_taxName, product_uvp (optional)
    where = None # List[object] | There are a lot of filter types supported. You can learn all of them if you trace what's requested by Atro UI in the network tab in your browser console (press F12 key to open the console). (optional)
    offset = 0 # int |  (optional)
    max_size = 50 # int |  (optional)
    sort_by = 'name' # str |  (optional)
    asc = true # bool |  (optional)

    try:
        # Returns a collection of ProductChannel records
        api_response = api_instance.get_list_of_product_channel_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
        print("The response of ProductChannelApi->get_list_of_product_channel_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductChannelApi->get_list_of_product_channel_items: %s\n" % e)

Parameters

Name	Type	Description	Notes
language	str	Set this parameter for data to be returned for a specified language	[optional]
select	str	Available fields: channel, channelId, channelName, channel_code, channel_createdAt, channel_createdBy, channel_createdById, channel_createdByName, channel_description, channel_descriptionDeDe, channel_filterCreateImportJob, channel_filterUpdateImportJob, channel_isActive, channel_locales, channel_modifiedAt, channel_modifiedBy, channel_modifiedById, channel_modifiedByName, channel_name, channel_nameDeDe, channel_type, createdAt, createdBy, createdById, createdByName, deleted, filterCreateImportJob, filterUpdateImportJob, id, isActive, isInherited, modifiedAt, modifiedBy, modifiedById, modifiedByName, name, product, productId, productName, product_amount, product_assignedUser, product_assignedUserId, product_assignedUserName, product_brand, product_brandId, product_brandName, product_catalog, product_catalogId, product_catalogName, product_createdAt, product_createdBy, product_createdById, product_createdByName, product_data, product_ean, product_filterCreateImportJob, product_filterUpdateImportJob, product_hasChildren, product_hierarchyRoute, product_hierarchySortOrder, product_inheritedFields, product_isActive, product_isInheritAssignedUser, product_isInheritOwnerUser, product_isInheritTeams, product_isRoot, product_longDescription, product_longDescriptionDeDe, product_mainImageId, product_mainImageName, product_mainImagePathsData, product_modifiedAt, product_modifiedAtExpanded, product_modifiedBy, product_modifiedById, product_modifiedByName, product_mpn, product_name, product_nameDeDe, product_ownerUser, product_ownerUserId, product_ownerUserName, product_packaging, product_packagingId, product_packagingName, product_price, product_priceCurrency, product_productSerie, product_productSerieId, product_productSerieName, product_productStatus, product_scope, product_sku, product_sortOrder, product_sorting, product_tag, product_taskStatus, product_tax, product_taxId, product_taxName, product_uvp	[optional]
where	List[object]	There are a lot of filter types supported. You can learn all of them if you trace what's requested by Atro UI in the network tab in your browser console (press F12 key to open the console).	[optional]
offset	int		[optional]
max_size	int		[optional]
sort_by	str		[optional]
asc	bool		[optional]

Return type

GetListOfProductChannelItems200Response

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_product_channel_item

ProductChannel get_product_channel_item(id, language=language)

Returns a record of the ProductChannel

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.product_channel import ProductChannel
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ProductChannelApi(api_client)
    id = 'id_example' # str | 
    language = 'language_example' # str | Set this parameter for data to be returned for a specified language (optional)

    try:
        # Returns a record of the ProductChannel
        api_response = api_instance.get_product_channel_item(id, language=language)
        print("The response of ProductChannelApi->get_product_channel_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductChannelApi->get_product_channel_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
language	str	Set this parameter for data to be returned for a specified language	[optional]

Return type

ProductChannel

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

link_product_channel

bool link_product_channel(id, link, link_account_request)

Link ProductChannel to Entities

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.link_account_request import LinkAccountRequest
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ProductChannelApi(api_client)
    id = 'id_example' # str | 
    link = 'link_example' # str | 
    link_account_request = clientapi_atrocore.LinkAccountRequest() # LinkAccountRequest | 

    try:
        # Link ProductChannel to Entities
        api_response = api_instance.link_product_channel(id, link, link_account_request)
        print("The response of ProductChannelApi->link_product_channel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductChannelApi->link_product_channel: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
link	str
link_account_request	LinkAccountRequest

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

mass_delete_product_channel

bool mass_delete_product_channel(link_account_request)

Mass delete of ProductChannel data

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.link_account_request import LinkAccountRequest
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ProductChannelApi(api_client)
    link_account_request = clientapi_atrocore.LinkAccountRequest() # LinkAccountRequest | 

    try:
        # Mass delete of ProductChannel data
        api_response = api_instance.mass_delete_product_channel(link_account_request)
        print("The response of ProductChannelApi->mass_delete_product_channel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductChannelApi->mass_delete_product_channel: %s\n" % e)

Parameters

Name	Type	Description	Notes
link_account_request	LinkAccountRequest

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

mass_update_product_channel

bool mass_update_product_channel(mass_update_account_request)

Mass update of ProductChannel data

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.mass_update_account_request import MassUpdateAccountRequest
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ProductChannelApi(api_client)
    mass_update_account_request = clientapi_atrocore.MassUpdateAccountRequest() # MassUpdateAccountRequest | 

    try:
        # Mass update of ProductChannel data
        api_response = api_instance.mass_update_product_channel(mass_update_account_request)
        print("The response of ProductChannelApi->mass_update_product_channel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductChannelApi->mass_update_product_channel: %s\n" % e)

Parameters

Name	Type	Description	Notes
mass_update_account_request	MassUpdateAccountRequest

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_relation_for_product_channel

bool remove_relation_for_product_channel(link, ids, foreign_ids)

Remove relation for ProductChannel

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ProductChannelApi(api_client)
    link = 'link_example' # str | 
    ids = ['ids_example'] # List[str] | 
    foreign_ids = ['foreign_ids_example'] # List[str] | 

    try:
        # Remove relation for ProductChannel
        api_response = api_instance.remove_relation_for_product_channel(link, ids, foreign_ids)
        print("The response of ProductChannelApi->remove_relation_for_product_channel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductChannelApi->remove_relation_for_product_channel: %s\n" % e)

Parameters

Name	Type	Description	Notes
link	str
ids	List[str]
foreign_ids	List[str]

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unfollow_product_channel

bool unfollow_product_channel(id)

Unfollow the ProductChannel stream

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ProductChannelApi(api_client)
    id = 'id_example' # str | 

    try:
        # Unfollow the ProductChannel stream
        api_response = api_instance.unfollow_product_channel(id)
        print("The response of ProductChannelApi->unfollow_product_channel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductChannelApi->unfollow_product_channel: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unlink_product_channel

bool unlink_product_channel(id, link, ids)

Unlink ProductChannel from Entities

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ProductChannelApi(api_client)
    id = 'id_example' # str | 
    link = 'link_example' # str | 
    ids = ['ids_example'] # List[str] | 

    try:
        # Unlink ProductChannel from Entities
        api_response = api_instance.unlink_product_channel(id, link, ids)
        print("The response of ProductChannelApi->unlink_product_channel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductChannelApi->unlink_product_channel: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
link	str
ids	List[str]

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_product_channel_item

ProductChannel update_product_channel_item(id, create_product_channel_item_request)

Update a record of the ProductChannel

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_product_channel_item_request import CreateProductChannelItemRequest
from clientapi_atrocore.models.product_channel import ProductChannel
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ProductChannelApi(api_client)
    id = 'id_example' # str | 
    create_product_channel_item_request = clientapi_atrocore.CreateProductChannelItemRequest() # CreateProductChannelItemRequest | 

    try:
        # Update a record of the ProductChannel
        api_response = api_instance.update_product_channel_item(id, create_product_channel_item_request)
        print("The response of ProductChannelApi->update_product_channel_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductChannelApi->update_product_channel_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
create_product_channel_item_request	CreateProductChannelItemRequest

Return type

ProductChannel

Authorization

Authorization-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

ProductChannelApi.md

Latest commit

History

ProductChannelApi.md

File metadata and controls

clientapi_atrocore.ProductChannelApi

add_relation_for_product_channel

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_product_channel_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_product_channel_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

follow_product_channel

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_linked_items_for_product_channel_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_list_of_product_channel_items

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_product_channel_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

link_product_channel

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_delete_product_channel

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_update_product_channel

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_relation_for_product_channel

Example

Parameters