_categoriesImport

Documentation: `_categoriesImport` Function

The _categoriesImport function is designed to import a batch of category data into the Shopranos platform. It handles the necessary authentication, sends a POST request with the category data to the Shopranos API, and processes the response and potential errors. The function returns a structured result indicating the outcome of the import operation.

Function Signature:

Parameters:

payload (Array of categories):

Description: An array of category objects to be sent in the POST request body. Each object should represent a category with its relevant details. This data is used by the Shopranos platform to process the import operation.

Type: Array<Object>

Example:

Return Value:

Returns:

A JSON object containing the result of the HTTP POST request to the Shopranos platform. The object includes:

StatusCode: The HTTP status code of the response from the Shopranos platform.

Content: The content of the response body from the Shopranos platform, typically containing success or error messages.

Type: Object

Example:

Function Workflow:

Retrieve Certificate:

The function retrieves a certificate required for authentication. If the certificate cannot be obtained, it logs an error and returns a JSON object indicating "NO CERTIFICATE".

Retrieve Access Token:

It then retrieves an access token for authorization. If the token is not available or is empty, it logs an error and returns a JSON object indicating "NO TOKEN".

Prepare and Send HTTP Request:

The function creates an HTTP client and configures it with the access token and base address for the Shopranos platform.

It sets the request headers, including the Authorization header with the Bearer token and x-companyid header with the company ID from the certificate.

The payload is converted to a JSON string and sent in the request body.

Handle HTTP Response:

The function sends the POST request to the specified URL and checks if the response is successful. If not, it logs an error with the status code.

It reads the response content and logs it for debugging purposes.

It then constructs a JSON object with the StatusCode and Content from the response.

Exception Handling:

If any exception occurs during the process, it logs the exception message and returns a JSON object with StatusCode set to "EXCEPTION" and the exception message as the Content.

Example Usage:

Important Considerations:

Error Handling:

Ensure proper handling of cases where the certificate or token cannot be retrieved. The function handles these errors by returning appropriate messages.

Payload Format:

The payload parameter must be an array of category objects formatted according to the Shopranos API requirements.

Catalog.Api.Features.Categories.CategoryDTO

string | null

optional

companyId

string | null

CompanyId

optional

title

string

Title

required

>= 1 characters

code

string

Code

required

>= 1 characters

alias

string | null

Alias

optional

description

string | null

Description

optional

position

integer <int32> | null

Position

optional

displayInMenu

boolean | null

DisplayInMenu

optional

displayAsList

boolean | null

DisplayAsList

optional

parentId

string | null

ParentId

optional

path

string | null

Path

optional

mediaItem

null | allOf {1}

MediaItem

optional

object (Catalog.Application.Shared.DTOs.MediaItemDTO)

optional

translation

null | allOf {1}

Translation

optional

object (Catalog.Api.Features.Categories.CategoryTranslationDTO)

optional

seoTitle

string | null

SeoTitle

optional

seoDescription

string | null

SeoDescription

optional

updateDate

string <date-time> | null

UpdateDate

optional

insertDate

string <date-time> | null

InsertDate

optional

metaTitle

string | null

MetaTitle

optional

metaDescription

string | null

MetaDescription

optional

metaKeywords

array[string] | null

MetaKeywords

optional

treeIds

array[string] | null

TreeIds

optional

link

string | null

Link

optional

status

enum<string> | enum<null>

Status

optional

Allowed values:

DraftActiveArchivedignore

Timeouts:

The HTTP client has a timeout of 120 seconds. Ensure that this is sufficient for the Shopranos platform to process the request.

By using _categoriesImport, you can automate the import of category data into the Shopranos platform, ensuring that the data is sent securely and that any issues are handled and reported appropriately.

Documentation: _categoriesImport Function#

Function Signature:#

Parameters:#

Return Value:#

Function Workflow:#

Example Usage:#

Important Considerations:#

Documentation: `_categoriesImport` Function

Function Signature:

Parameters:

Return Value:

Function Workflow:

Example Usage:

Important Considerations: