HomeWiki
HomeWiki
  1. Datapump
  2. SDK
  3. Import
  • Back to home
  • 2. Connectivity
  • Introduction
  • Custom Script
  • Playground
  • Database Explorer
  • Log Stream
  • Direct Communication
  • Softone
    • Getting Started
  • Datapump
    • Getting Started
    • Crons
    • Legacy Windows Support
    • SDK
      • DB
        • _executeQuery
        • _executeStoreProcedure
        • _executeInsertQuery
        • _executeInsertQueriesInTransaction
      • Import
        • _productsImport
        • _categoriesImport
        • _brandsImport
        • _attributesImport
        • _attributeSetsImport
        • _unitsImport
        • _quantityImport
        • _customersImport
        • _contactsImport
        • _callsImport
        • _eventsImport
        • _tasksImport
        • _ordersImport
        • _usersImport
        • _customerSourceTagsImport
        • _productSourceTagsImport
      • Log
        • _logDebug
        • _logInfo
        • _logWarn
        • _logError
      • Web Requests
        • _httpGetJson
        • _httpPostJson
        • _httpPutJson
        • _httpDeleteJson
        • _httpPatchJson
      • Variables
        • _saveVariable
        • _getVariable
        • _deleteVariable
      • Blob
        • _blobConnect
        • _blobExists
        • _blobGet
        • _blobFind
      • Utils
        • _encodeBase64
        • _sleep
        • _getLastSyncDate
        • _updateLastSyncDate
        • _resetLastSyncDate
  1. Datapump
  2. SDK
  3. Import

_attributesImport

Documentation: _attributesImport Function#

The _attributesImport function is designed to import a batch of attribute data into the Shopranos platform. It manages authentication, sends a POST request with the attribute data to the Shopranos API, and handles responses and errors. The function returns a structured result indicating the outcome of the import operation.

Function Signature:#

Parameters:#

payload (Array of attributes):
Description: An array of attribute objects to be sent in the POST request body. Each object should represent an attribute 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:#

1.
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".
2.
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".
3.
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.
4.
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.
5.
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 attribute objects formatted according to the Shopranos API requirements.
Catalog.Api.Features.Attributes.AttributeDTO
id
string  | null 
Id
optional
companyId
string  | null 
CompanyId
optional
name
string 
Name
required
>= 0 characters<= 150 characters
code
string 
Code
required
>= 1 characters
description
string  | null 
Description
optional
usedAsFilter
boolean  | null 
UsedAsFilter
optional
displayOnProduct
boolean  | null 
DisplayOnProduct
optional
displayOnList
boolean  | null 
DisplayOnList
optional
displayOnCompare
boolean  | null 
DisplayOnCompare
optional
type
enum<string>  | enum<null> 
Type
optional
Allowed values:
TextItemsColorSize
slug
string  | null 
Slug
optional
position
integer <int32> | null 
Position
optional
status
enum<string>  | enum<null> 
Status
optional
Allowed values:
DraftActiveArchivedignore
updateDate
string <date-time> | null 
UpdateDate
optional
insertDate
string <date-time> | null 
InsertDate
optional
items
array[object (Catalog.Api.Features.Attributes.AttributeItemDTO) {7}]  | null 
Items
optional
id
string  | null 
Id
optional
code
string  | null 
Code
optional
colorCode
string  | null 
ColorCode
optional
value
string  | null 
Value
optional
position
integer <int32> | null 
Position
optional
slug
string  | null 
Slug
optional
translation
null  | allOf {1} 
Translation
optional
translation
null  | allOf {1} 
Translation
optional
object (Catalog.Api.Features.Attributes.AttributeTranslationDTO) 
optional
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 _attributesImport, you can automate the import of attribute data into the Shopranos platform, ensuring that the data is sent securely and that any issues are handled and reported appropriately.
Modified at 2024-08-23 08:08:03
Previous
_brandsImport
Next
_attributeSetsImport
Built with