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

_productsImport

Documentation: _productsImport Function#

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

Function Signature:#

Parameters:#

payload (Array of products):
Description: An array of product objects to be sent in the POST request body. Each object should represent a product with its relevant attributes. The 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 product objects formatted according to the Shopranos API requirements.
ProductDTO
id
string  | null 
optional
companyId
string  | null 
optional
title
string  | null 
optional
vatRate
number <double> | null 
optional
vatCode
string  | null 
optional
reducedVatCode
string  | null 
optional
reducedVatRate
number <double> | null 
optional
brandId
string  | null 
optional
status
enum<string> 
optional
Allowed values:
DraftActiveArchivedignore
priceCategoryId
string  | null 
optional
productVariants
array[object (ProductVariantDTO) {7}]  | null 
optional
id
string  | null 
optional
productId
string  | null 
optional
gtin
string  | null 
optional
mpn
string  | null 
optional
price
number <double> | null 
optional
msrp
number <double> | null 
optional
sku
string  | null 
optional
mediaItems
array[object (MediaItemDTO) {9}]  | null 
optional
id
string  | null 
optional
companyId
string  | null 
read-onlyoptional
galleryId
string  | null 
optional
link
string  | null 
optional
position
integer <int32> | null 
optional
alt
string  | null 
optional
mediaType
enum<string> 
optional
Allowed values:
ImageVideoAttachmentignore
width
integer <int32> | null 
optional
height
integer <int32> | null 
optional
categoryId
string  | null 
optional
tags
array[string] | null 
optional
sourceTags
array[string] | null 
optional
searchAttributes
array[string] | null 
optional
pathCategories
array[string] | null 
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 _productsImport, you can automate the import of product 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:04:59
Previous
_executeInsertQueriesInTransaction
Next
_categoriesImport
Built with