clientapi_atrocore.ProductApi

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

Method	HTTP request	Description
add_relation_for_product	POST /Product/{link}/relation	Add relation for Product
create_product_item	POST /Product	Create a record of the Product
delete_product_item	DELETE /Product/{id}	Delete a record of the Product
follow_product	PUT /Product/{id}/subscription	Follow the Product stream
get_linked_items_for_product_item	GET /Product/{id}/{link}	Returns linked entities for the Product
get_list_of_product_items	GET /Product	Returns a collection of Product records
get_product_item	GET /Product/{id}	Returns a record of the Product
link_product	POST /Product/{id}/{link}	Link Product to Entities
mass_delete_product	POST /Product/action/massDelete	Mass delete of Product data
mass_update_product	PUT /Product/action/massUpdate	Mass update of Product data
remove_relation_for_product	DELETE /Product/{link}/relation	Remove relation for Product
unfollow_product	DELETE /Product/{id}/subscription	Unfollow the Product stream
unlink_product	DELETE /Product/{id}/{link}	Unlink Product from Entities
update_product_item	PUT /Product/{id}	Update a record of the Product

add_relation_for_product

bool add_relation_for_product(link, ids, foreign_ids)

Add relation for Product

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.ProductApi(api_client)
    link = 'link_example' # str | 
    ids = ['ids_example'] # List[str] | 
    foreign_ids = ['foreign_ids_example'] # List[str] | 

    try:
        # Add relation for Product
        api_response = api_instance.add_relation_for_product(link, ids, foreign_ids)
        print("The response of ProductApi->add_relation_for_product:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->add_relation_for_product: %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_item

Product create_product_item(create_product_item_request)

Create a record of the Product

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_product_item_request import CreateProductItemRequest
from clientapi_atrocore.models.product import Product
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.ProductApi(api_client)
    create_product_item_request = clientapi_atrocore.CreateProductItemRequest() # CreateProductItemRequest | 

    try:
        # Create a record of the Product
        api_response = api_instance.create_product_item(create_product_item_request)
        print("The response of ProductApi->create_product_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->create_product_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_product_item_request	CreateProductItemRequest

Return type

Product

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_item

bool delete_product_item(id)

Delete a record of the Product

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.ProductApi(api_client)
    id = 'id_example' # str | 

    try:
        # Delete a record of the Product
        api_response = api_instance.delete_product_item(id)
        print("The response of ProductApi->delete_product_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->delete_product_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

FollowAccount200Response follow_product(id)

Follow the Product 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.ProductApi(api_client)
    id = 'id_example' # str | 

    try:
        # Follow the Product stream
        api_response = api_instance.follow_product(id)
        print("The response of ProductApi->follow_product:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->follow_product: %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_item

GetLinkedItemsForAccountItem200Response get_linked_items_for_product_item(id, link, language=language)

Returns linked entities for the Product

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.ProductApi(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 Product
        api_response = api_instance.get_linked_items_for_product_item(id, link, language=language)
        print("The response of ProductApi->get_linked_items_for_product_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->get_linked_items_for_product_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_items

GetListOfProductItems200Response get_list_of_product_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)

Returns a collection of Product records

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_list_of_product_items200_response import GetListOfProductItems200Response
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.ProductApi(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: amount, assignedUser, assignedUserId, assignedUserName, associatedMainProducts, associatedMainProductsIds, associatedRelatedProduct, associatedRelatedProductIds, attachmentsIds, attachmentsNames, attachmentsTypes, brand, brandId, brandName, callsIds, callsNames, catalog, catalogId, catalogName, categories, categoriesColumns, categoriesIds, categoriesNames, children, childrenIds, childrenNames, classifications, classificationsIds, classificationsNames, contents, contentsIds, contentsNames, createdAt, createdBy, createdById, createdByName, data, deleted, ean, filterCreateImportJob, filterUpdateImportJob, followersIds, followersNames, hasChildren, hierarchyRoute, hierarchySortOrder, id, inheritedFields, isActive, isFollowed, isInheritAssignedUser, isInheritOwnerUser, isInheritTeams, isRoot, longDescription, longDescriptionDeDe, mainImageId, mainImageName, mainImagePathsData, modifiedAt, modifiedAtExpanded, modifiedBy, modifiedById, modifiedByName, mpn, name, nameDeDe, ownerUser, ownerUserId, ownerUserName, packaging, packagingId, packagingName, parents, parentsIds, parentsNames, price, priceConverted, priceCurrency, productAssets, productAssetsIds, productAssets_asset, productAssets_assetIds, productAssets_assetNames, productAttributeValues, productAttributeValuesIds, productAttributeValues_attribute, productAttributeValues_attributeIds, productAttributeValues_attributeNames, productChannels, productChannelsIds, productChannels_channel, productChannels_channelIds, productChannels_channelNames, productSerie, productSerieId, productSerieName, productStatus, scope, sku, sortOrder, sorting, tag, taskStatus, tax, taxId, taxName, teams, teamsIds, teamsNames, 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 Product records
        api_response = api_instance.get_list_of_product_items(language=language, select=select, where=where, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
        print("The response of ProductApi->get_list_of_product_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->get_list_of_product_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: amount, assignedUser, assignedUserId, assignedUserName, associatedMainProducts, associatedMainProductsIds, associatedRelatedProduct, associatedRelatedProductIds, attachmentsIds, attachmentsNames, attachmentsTypes, brand, brandId, brandName, callsIds, callsNames, catalog, catalogId, catalogName, categories, categoriesColumns, categoriesIds, categoriesNames, children, childrenIds, childrenNames, classifications, classificationsIds, classificationsNames, contents, contentsIds, contentsNames, createdAt, createdBy, createdById, createdByName, data, deleted, ean, filterCreateImportJob, filterUpdateImportJob, followersIds, followersNames, hasChildren, hierarchyRoute, hierarchySortOrder, id, inheritedFields, isActive, isFollowed, isInheritAssignedUser, isInheritOwnerUser, isInheritTeams, isRoot, longDescription, longDescriptionDeDe, mainImageId, mainImageName, mainImagePathsData, modifiedAt, modifiedAtExpanded, modifiedBy, modifiedById, modifiedByName, mpn, name, nameDeDe, ownerUser, ownerUserId, ownerUserName, packaging, packagingId, packagingName, parents, parentsIds, parentsNames, price, priceConverted, priceCurrency, productAssets, productAssetsIds, productAssets_asset, productAssets_assetIds, productAssets_assetNames, productAttributeValues, productAttributeValuesIds, productAttributeValues_attribute, productAttributeValues_attributeIds, productAttributeValues_attributeNames, productChannels, productChannelsIds, productChannels_channel, productChannels_channelIds, productChannels_channelNames, productSerie, productSerieId, productSerieName, productStatus, scope, sku, sortOrder, sorting, tag, taskStatus, tax, taxId, taxName, teams, teamsIds, teamsNames, 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

GetListOfProductItems200Response

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_item

Product get_product_item(id, language=language)

Returns a record of the Product

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.product import Product
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.ProductApi(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 Product
        api_response = api_instance.get_product_item(id, language=language)
        print("The response of ProductApi->get_product_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->get_product_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

Product

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

bool link_product(id, link, link_account_request)

Link Product 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.ProductApi(api_client)
    id = 'id_example' # str | 
    link = 'link_example' # str | 
    link_account_request = clientapi_atrocore.LinkAccountRequest() # LinkAccountRequest | 

    try:
        # Link Product to Entities
        api_response = api_instance.link_product(id, link, link_account_request)
        print("The response of ProductApi->link_product:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->link_product: %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

bool mass_delete_product(link_account_request)

Mass delete of Product 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.ProductApi(api_client)
    link_account_request = clientapi_atrocore.LinkAccountRequest() # LinkAccountRequest | 

    try:
        # Mass delete of Product data
        api_response = api_instance.mass_delete_product(link_account_request)
        print("The response of ProductApi->mass_delete_product:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->mass_delete_product: %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

bool mass_update_product(mass_update_account_request)

Mass update of Product 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.ProductApi(api_client)
    mass_update_account_request = clientapi_atrocore.MassUpdateAccountRequest() # MassUpdateAccountRequest | 

    try:
        # Mass update of Product data
        api_response = api_instance.mass_update_product(mass_update_account_request)
        print("The response of ProductApi->mass_update_product:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->mass_update_product: %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

bool remove_relation_for_product(link, ids, foreign_ids)

Remove relation for Product

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.ProductApi(api_client)
    link = 'link_example' # str | 
    ids = ['ids_example'] # List[str] | 
    foreign_ids = ['foreign_ids_example'] # List[str] | 

    try:
        # Remove relation for Product
        api_response = api_instance.remove_relation_for_product(link, ids, foreign_ids)
        print("The response of ProductApi->remove_relation_for_product:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->remove_relation_for_product: %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

bool unfollow_product(id)

Unfollow the Product 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.ProductApi(api_client)
    id = 'id_example' # str | 

    try:
        # Unfollow the Product stream
        api_response = api_instance.unfollow_product(id)
        print("The response of ProductApi->unfollow_product:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->unfollow_product: %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

bool unlink_product(id, link, ids)

Unlink Product 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.ProductApi(api_client)
    id = 'id_example' # str | 
    link = 'link_example' # str | 
    ids = ['ids_example'] # List[str] | 

    try:
        # Unlink Product from Entities
        api_response = api_instance.unlink_product(id, link, ids)
        print("The response of ProductApi->unlink_product:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->unlink_product: %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_item

Product update_product_item(id, create_product_item_request)

Update a record of the Product

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.create_product_item_request import CreateProductItemRequest
from clientapi_atrocore.models.product import Product
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.ProductApi(api_client)
    id = 'id_example' # str | 
    create_product_item_request = clientapi_atrocore.CreateProductItemRequest() # CreateProductItemRequest | 

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

Parameters

Name	Type	Description	Notes
id	str
create_product_item_request	CreateProductItemRequest

Return type

Product

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

ProductApi.md

Latest commit

History

ProductApi.md

File metadata and controls

clientapi_atrocore.ProductApi

add_relation_for_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_product_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_product_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

follow_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_linked_items_for_product_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_list_of_product_items

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_product_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

link_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_delete_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mass_update_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_relation_for_product

Example

Parameters