Syndigo Connector v1.0
1. Prerequisites and Additional Steps, Developer Key

After login user will be redirected to the dashboard page.

To access products, from left menu click on Products > Active products

To access assets, from left menu click on Assets > All Assets.

2. Connector Action & Tests
Action Name / Method | Search Product By Id | ||
---|---|---|---|
Action Description | You can search products by using different variance of basic data available to you such as date, IDs, and attributes. The Platform offers a variety of Search APIs for various circumstances, allowing you to carry out the necessary Search operations. You can change the param values of skipCount, takeCount, vocabularyId, useLens, locale, and shouldIncludeMissingVocabularyAttributes according to your requirements. | ||
Test Case | Search product by Id | ||
Request Body Name | Parameter | Type | Description (Example) |
|
|
| |
| vocabularyId | String | If a valid companyId is provided, vocabularyId is not Required |
| companyId | String | If a valid vocabularyId is provided, companyId is not Required |
| skipCount | Integer | Used in combination with takeCount to paginate large numbers of product records. Quantity of records to skip before you start taking products. Whatever value is used for the takeCount, add to skipCount for the subsequent call |
| takeCount | Integer | Sets quantity of results to return at one time. Used for parsing large numbers of product records |
| locale | enum | Stores the value passed in a language specific variant. Facilitates different values in different langugages on the same attribute. Defaults to en-US. |

Action Name / Method | Upload Asset Binary | ||
---|---|---|---|
Action Description | To upload asset binary data | ||
Test Case | Upload asset | ||
Request Body Name | Parameter | Type | Description (Example) |
| dataOwner | String | The same as company ID representing your company. |
| fileName | String | Desired file name to be used in CXH. Do not recommend using the following characters & % < > ! / \ | , $ @ |
| File binary data | File/Folder | Binary content of the asset file to be uploaded. |

Action Name / Method | Add new product | ||
---|---|---|---|
Action Description | Add new product | ||
Test Case | Upload asset | ||
Request Body Name | Parameter | Type | Description (Example) |
| companyId | String | The same as company ID representing your company. |
ProductsToImport |
|
| Contains an a array of Products |
ImportMode |
|
| CreateOrUpdate: create product if does not exist or updates existing product. |
ProductIdentifierValue |
| String | The unique identifier of the product that you are creating or updating. |
PackageType |
| enum | Used mainly for GDSN when managing product hierarchy |
Values |
| Array | Contains all attribute values to be imported or updated. |
ErrorMode |
| enum | Ignore will ignore any error encountered and continue the operation. Fail will prevent any information from the payload from being committed. If you have one product out of 50 in an import with an error, no products will be imported or updated. All will fail. |

3- Connection Settings and Configuration
Settings Parameters | Value | Description | Required (Y/N) | Default Value |
---|---|---|---|---|
Connector | Syndigo | Connector Name | Y | Syndigo |
username | test_user |
| Y | test_user |
secret | test_secret |
|
| test_secret |
Host Name | Endpoint required for performing CRUD | Y |
