Skip to main content

Product Image

Tasks related to product integration that operate under channel_app_template.app.tasks:

1. Insert Images​

It retrieves the ProductImages that need to be inserted for the first time on the sales side in Akinon and sends this data to the command found in channel.commands.product_images.SendInsertedImages. This command creates the product's image information in the sales channel.

If desired, the image data can be enriched with the parameter values listed below.

The parameters and their descriptions for the insert_product_images service within the ImageService are as follows:

NOTE

Parameters for the insert_product_images service within the Image Service:

  • is_sync: Indicates whether the status is obtained immediately when the product is sent to the sales channel. It specifies whether the process is Synchronous or Asynchronous.

classSendInsertedImages(integration, objects=None, batch_request=None, kwargs)​

get_data()

This function prepares the data to be sent in a request to transfer the product image information from Omnitron to the sales channel. The response should return a list containing ProductImage.

validated_data(data)

It takes the response returned by the get_data function as a parameter. If validation is needed on the product images to be sent to the sales channel, it will be used for that purpose. If no validation is required, the provided data should be returned.

transform_data(data)

It takes the response returned by the validated_data function as a parameter. It is used if changes need to be made to the data before sending it to the sales channel. It returns the final version of the data to be sent.

send_request(transformed_data)

It takes the response returned by the transform_data function as a parameter. This function uses the received data as the endpoint where the request will be sent to the sales channel. It should return either the response or the data that comes with the response.

normalize_response(data, validated_data, transformed_data, response)

This function is where we gather and finalize the data used to send our product images to the sales channel in the insert_images step. The response returned by this function will be directly used in the insert_product_images function.

If the process is asynchronous, the remote_batch_id returned from the sales channel should be processed in the batch_request.

remote_batch_id = response.get("remote_batch_request_id") self.batch_request.remote_batch_id = remote_batch_id
return "", report, data
NOTE

The response returned in this section should consist of three parts:

  1. response_data: This is the processed version of the data returned from the sales channel. Its type can be either a string or a list. If there is no data to be used in the returned response, an empty string is sufficient. If the returned response is to be used, it must be of type list, with each element being of type BatchRequestResponseDto.
  2. report: These are the error reports generated while processing the response from the sales channel.
  3. data: This is the first parameter received by our function, which is the response obtained from the get_data function.

Example return:

return response_data, report, data

2. Update Images​

It retrieves the ProductImages that need to be updated on the sales side in Akinon and sends this data to the command found in channel.commands.product_images.SendUpdatedImages. This command updates the image information of the product in the sales channel.

If desired, the image data can be enriched with the parameter values listed below.

The parameters and their descriptions for the update_product_images service within the ImageService are as follows:

NOTE

Parameters for the insert_product_images service within the Image Service:

  • is_sync: Indicates whether the status is obtained immediately when the product is sent to the sales channel. It specifies whether the process is Synchronous or Asynchronous.

class SendUpdatedImages(integration, objects=None, batch_request=None, kwarg)​

get_data()

This function prepares the data to be sent in a request to transfer the updated image information of the products from Omnitron to the sales channel. The response should return a list containing ProductImage.

validated_data(data)

It takes the response returned by the get_data function as a parameter. If validation is required on the product images to be sent to the sales channel, it will be used for that purpose. If no validation is needed, the provided data should be returned.

transform_data(data)

It takes the response returned by the validated_data function as a parameter. It is used if changes need to be made to the data before sending it to the sales channel. It returns the final version of the data to be sent.

send_request(transformed_data)

It takes the response returned by the transform_data function as a parameter. This function uses the received data as the endpoint where the request will be sent to the sales channel. It should return either the response or the data that comes with the response.

NOTE

In this section, since the response to be returned will be sent to the normalize_response function, it is important to pay attention to data types when returning the data.

normalize_response(data, validated_data, transformed_data, response)

This function is where we gather and finalize the data used to send our product images to the sales channel in the update_images step. The response returned by this function will be directly used in the insert_product_images function.

If the process is asynchronous, the remote_batch_id returned from the sales channel should be processed in the batch_request.

remote_batch_id = response.get("remote_batch_request_id") 
self.batch_request.remote_batch_id = remote_batch_id
return "", report, data
NOTE

The response returned in this section should consist of three parts:

  1. response_data: This is the processed version of the data returned from the sales channel. Its type can be either a string or a list. If there is no data to be used in the returned response, an empty string is sufficient. If the returned response is to be used, it must be of type list, with each element being of type BatchRequestResponseDto.
  2. report: These are the error reports generated while processing the response from the sales channel.
  3. data: This is the first parameter received by our function, which is the response obtained from the get_data function.

Example return:

return response_data, report, data

3. Check Images​

It retrieves the asynchronously updated or newly created BatchRequest with an unknown status for the sales side in Akinon and sends this data to the command found in channel.commands.product_images.CheckImages. This command allows for checking the creation or update status of the product's image information in the sales channel.

If desired, the image data can be enriched with the parameter values listed below.

The get_image_batch_requests function within the ImageService is used.

classCheckImages(integration, objects=None, batch_request=None, kwargs)​

get_data()

This function prepares the data to be sent in a request to check the status of the image information that has been sent to the sales channel. The response should return a list containing BatchRequest.

validated_data(data)

It takes the response returned by the get_data function as a parameter. This is used if there needs to be a validation on the product image data that has been sent to the sales channel. If no validation is required, it should return the provided data as a parameter.

transform_data(data)

It takes the response returned by the validated_data function as a parameter. This is used if changes need to be made to the data before sending it to the sales channel. It returns the final version of the data to be sent.

send_request(transformed_data)

It takes the response returned by the transform_data function as a parameter. This function is where the received data is sent to the relevant endpoint of the sales channel. It should return the response or the data received with the response.

NOTE

In this section, since the response to be returned will be passed to the normalize_response function, it is important to pay attention to data types when returning the data.

normalize_response(data, validated_data, transformed_data, response)

This function collects the data used to query the sales channel for the processing status of our product images during the get_image_batch_requests step, and prepares the final response. The response returned by this function will be directly used in the get_image_batch_requests function.

NOTE

The response returned in this section should consist of three parts:

  1. response_data: This is the processed version of the data returned from the sales channel. Its type can be either a string or a list. If there is no data to be used in the returned response, an empty string is sufficient. If data is to be used, it must be a list and each element must be of type BatchRequestResponseDto.
  2. report: These are the error reports generated while processing the response returned from the sales channel.
  3. data: This is the first parameter received by our function, which is the response obtained from the get_data function.

Example return:

return response_data, report, data

Source Code​

Source Code of the channel.commands.product_images Item:

from typing import List, Tuple, Any

from channel_app.channel.commands.product_images import (
    SendUpdatedImages as AppSendUpdatedImages,
    SendInsertedImages as AppSendInsertedImages,
    CheckImages as AppCheckImages,
)
from channel_app.core.data import (
    ErrorReportDto, BatchRequestResponseDto
)
from omnisdk.omnitron.models import ProductImage, BatchRequest

class SendUpdatedImages(AppSendUpdatedImages):
    param_sync = True

    def get_data(self) -> List[ProductImage]:
        raise NotImplementedError

    def validated_data(self, data) -> object:
        raise NotImplementedError

    def transform_data(self, data) -> object:
        raise NotImplementedError

    def send_request(self, transformed_data) -> object:
        raise NotImplementedError

    def normalize_response(self, data, validated_data, transformed_data,
                           response) -> Tuple[List[BatchRequestResponseDto],
                                              ErrorReportDto, Any]:
        raise NotImplementedError

class SendInsertedImages(AppSendInsertedImages):
    param_sync = True

    def get_data(self) -> List[ProductImage]:
        raise NotImplementedError

    def validated_data(self, data) -> object:
        raise NotImplementedError

    def transform_data(self, data) -> object:
        raise NotImplementedError

    def send_request(self, transformed_data) -> object:
        raise NotImplementedError

    def normalize_response(self, data, validated_data, transformed_data,
                           response) -> Tuple[List[BatchRequestResponseDto],
                                              ErrorReportDto, Any]:
        raise NotImplementedError

class CheckImages(AppCheckImages):
    def get_data(self) -> BatchRequest:
        raise NotImplementedError

    def validated_data(self, data):
        raise NotImplementedError

    def transform_data(self, data) -> object:
        raise NotImplementedError

    def send_request(self, transformed_data) -> object:
        raise NotImplementedError

    def normalize_response(self, data, validated_data, transformed_data,
                           response) -> Tuple[List[BatchRequestResponseDto],
                                              ErrorReportDto, Any]:
        raise NotImplementedError