Syndigoconnector v1.0 | OneTeg Documentation

Version 1.0

Connector Overview: This page documents all 34 actions for the Syndigoconnector v1.0.

Asset Operations (5)

GET v1.0 Asset Find Products

/api/search/assetsearch/productInfo

Retrieve product information for a specific asset using search criteria. Use this action to look up product details based on asset ID and data owner.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Assetid`	The unique identifier of the asset to search for.
`Dataowner`	The data owner associated with the asset.
`Content-type`	The media type of the request body, typically set to 'application/json'.
`Response Type`	The response format expected from the API (e.g. application/json).

GET v1.0 Asset Get Binary

/79af2856-c7bc-4736-86d3-6fa8d087a028

Download the binary file of an asset. Use this action to retrieve the actual file content for a given file type and size.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filetype`	The file extension or format of the binary to retrieve (e.g., 'jpg', 'png').
`Size`	The desired size variant of the binary, such as 'original' or 'thumbnail'.
`Response Type`	The response format expected from the API (e.g. application/json).

POST v1.0 Asset Search ByName

/api/search/assetsearch

Search for assets by name using a flexible query. Use this action when you need to find assets matching a name pattern with pagination and sorting.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Skip`	The number of records to skip for pagination.
`Take`	The number of records to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Dataowner`	The data owner to filter the search by.
`Orderby`	The property to order the results by (e.g., 'Name').
`Desc`	Whether to sort in descending order (true) or ascending (false).
`Namesearchval`	The name value or pattern to search for.

POST v1.0 Asset Upload Binary

/api/asset/upload

Upload a binary file as an asset. Use this action to add a new asset file to the system.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Dataowner`	The data owner to associate with the uploaded asset.
`Filename`	The name of the file being uploaded, including its extension.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	The binaries of the file

POST v1.0 Asset Upload By URL - ex_105d

/api/asset/transfer

Upload an asset by transferring it from an external URL. Use this action when the binary file is hosted elsewhere and needs to be imported.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Dataowner`	The data owner to associate with the transferred asset.
`Filename`	The desired file name for the asset after transfer.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Additional transfer options, such as source URL or authentication details.

Data Quality Operation (2)

POST v2.0 Product Data Quality

/api/importexport/DataQuality

Check the data quality of a single product against a specified vocabulary. Use this action to validate product data completeness and correctness.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vocabularyid`	The identifier of the vocabulary to validate against.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Dataowner`	The data owner of the product being validated.
`Identifiervalue`	The value of the product identifier to check.
`Identifiername`	The name of the identifier field (e.g., 'GTIN').
`Targetpartyalias`	The target party alias for the quality check.

POST v2.0 Product Data Quality Bulk

/api/importexport/DataQuality/Bulk

Perform data quality checks on multiple products in bulk. Use this action to validate a set of products against a vocabulary.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vocabularyid`	The identifier of the vocabulary used for validation.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Dataowner`	The data owner for the bulk validation.
`Targetpartyalias`	The target party alias to apply to all products in the batch.

GDSN Operations (2)

GET v1.0 Company Get Party TargetMarket Prefs-WIP- Need good response

/Api/company/0642243f-73e6-4f04-9037-a118112c2e99/preferences/party/e86c0a76-6c71-447c-81ed-32f387bf3d1d

Retrieve target market preferences for a specific party within a company. Use this action to view the configured preferences for a given party.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT v1.0 Product Create Catalog Item - ex_107d

/gc/party/catalogitem/create

Create a catalog item for a product under a specific company. Use this action to add a product to a party's catalog.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Companyid`	The identifier of the company that owns the catalog.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Productids`	A list of product identifiers to include in the catalog item.
`Filter`	A filter string to select products for the catalog item.

Get Started / Setup (6)

GET v0 Generate Auth Token via Params

/api/auth

Generate an authentication token using query parameters. Use this action to obtain a token for API access when you have credentials.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Username`	The username for authentication.
`Secret`	The secret or password associated with the username.
`Response Type`	The response format expected from the API (e.g. application/json).

POST v0 Generate Auth Token via Payload

/api/auth/authenticate

Generate an authentication token by sending credentials in the request body. Use this action to securely obtain a token without exposing credentials in the URL.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Username`	The username for authentication.
`Secret`	The secret or password associated with the username.

POST v0 Vocab Search

/api/search/customervocabularysourcesearch

Search customer vocabulary sources with pagination and filtering. Use this action to find vocabulary sources matching certain criteria.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Skip`	The number of records to skip for pagination.
`Take`	The number of records to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Dataowner`	The data owner to filter the vocabulary search by.
`Archived`	Whether to include archived vocabulary sources (true) or only active ones (false).

GET v2.0 Custom Vocab Get

/api/importexport/CustomerVocabulary/0642243f-73e6-4f04-9037-a118112c2e99

Retrieve details of a specific custom vocabulary by its identifier. Use this action to view the configuration of an existing vocabulary.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT v2.0 Custom Vocab Put

/api/importexport/CustomerVocabulary/0642243f-73e6-4f04-9037-a118112c2e99

Update or create a custom vocabulary. Use this action to modify the attributes of an existing vocabulary or define a new one.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Shouldincludemissingvocabularyattributes`	Whether to include attributes that are missing from the current vocabulary definition.
`Id`	The unique identifier of the vocabulary to update.
`Dataowner`	The data owner associated with the vocabulary.
`Partition`	The partition key for the vocabulary.
`Type`	The type or classification of the vocabulary.

PUT v2.0 Custom Vocab Put -WIP-

/api/importexport/CustomerVocabulary/<use vocabulary guid here>

Create or update a custom vocabulary using the provided GUID in the endpoint path. Use this action to manage customer-specific vocabulary definitions.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Shouldincludemissingvocabularyattributes`	Whether to include attributes that are missing from the current vocabulary definition.
`Id`	The unique identifier of the vocabulary to update.
`Dataowner`	The data owner associated with the vocabulary.
`Partition`	The partition key for the vocabulary.
`Type`	The type or classification of the vocabulary.

Hierarchy Operations

POST v1.0 PackagingSearch

/api/product/PackagingHierarchy/packagingtree

Search the packaging hierarchy tree to retrieve packaging structures. Use this action to explore parent-child packaging relationships.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Includeparents`	Specify whether to include parent nodes in the search results.
`Parentlevels`	Define the number of parent levels to include in the hierarchy tree.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Productid`	Provide a specific product identifier to filter the packaging tree for that product.
`Dataowner`	The data owner associated with the vocabulary.

Marketplace Operations & Flow (3)

GET v2.0 Marketplace Get-WIP- Need good Response

/api/ImportExport/Marketplace/ff2d577a-4d39-42bd-9fd5-5f44c6a8eb28

Retrieve marketplace details for a fixed marketplace GUID. Use this action to fetch configuration or status of a predefined marketplace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vocabularyid`	Filter the marketplace response to a specific vocabulary by providing its identifier.
`Companyid`	The identifier of the company that owns the catalog.
`Response Type`	The response format expected from the API (e.g. application/json).

POST v2.0 Marketplace Post

/api/importexport/marketplace

Create a new marketplace entry by submitting data to the import/export marketplace endpoint. Use this action to add a marketplace for data exchange.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vocabularyid`	Associate the new marketplace with a specific vocabulary by providing its identifier.
`Companyid`	The identifier of the company that owns the catalog.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Additional transfer options, such as source URL or authentication details.

POST v2.0 Product Search Marketplace -WIP- Need good Response

/api/importexport/marketplace/search

Search for products within a marketplace using various filters and pagination controls. Use this action to find and retrieve product listings from a marketplace.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vocabularyid`	Limit the search to products belonging to a specific vocabulary.
`Companyid`	The identifier of the company that owns the catalog.
`Skipcount`	Set the number of results to skip for pagination.
`Takecount`	Define the number of results to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (16)

Option Name	Description
`Language`	Specify the language for localized search results.
`Orderby`	Choose the field by which to order the search results.
`Desc`	Set to true to sort results in descending order.
`Identifierattributes`	Provide a list of attribute names to use as product identifiers for the search.
`Identifiers`	Supply a list of identifier values to match against the identifier attributes.
`Searchstring`	Enter a free-text string to search within product attributes.
`Searchstringattributes`	Specify which attributes to search when using the search string.
`Attributefilteroperator`	Define the logical operator (e.g., 0 for AND, 1 for OR) for combining attribute filters.
`Archived`	Filter products by archived status; set to true to include only archived products.
`Onhold`	Filter products by on-hold status; set to true to include only products on hold.
`Taxonomyaliases`	Provide taxonomy aliases to restrict the search to specific taxonomies.
`Excludetaxonomyaliases`	Supply taxonomy aliases to exclude from the search results.
`Categoryaliases`	Limit the search to products within given category aliases.
`Productsourcepartyaliases`	Filter by the party aliases that supplied the products.
`Preferredproductsfilter`	Set to true to show only preferred products in the results.
`Ismyproductssearch`	Enable this to search only products owned or managed by the current user.

Other Operations (3)

GET v1.0 Get attribute details - ex_3a

/api/attribute/ef1bdb7b-dc09-464c-bc68-1c167a04b4a2

Retrieve detailed information about a specific attribute using its fixed GUID. Use this action to inspect attribute properties and configuration.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	The media type of the request body, typically set to 'application/json'.
`Response Type`	The response format expected from the API (e.g. application/json).

GET v1.0 Verify (Create Snapshot) - ex_107a

/api/product/f417b2d1-a0cf-4a10-8a63-dfef3dfb388e/Verify

Verify a product by creating a snapshot of its current state. Use this action to capture a point-in-time record for auditing or comparison.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

POST v2.0 Advance Workflow -WIP- Need good Response

/api/importexport/workflow

Advance a workflow by submitting a decision or action for a given workflow step. Use this action to move a workflow forward based on acceptance or rejection.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vocabularyid`	Specify the vocabulary identifier that scopes the workflow advancement.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Dataowner`	The data owner for the bulk validation.
`Identifiervalue`	The value of the product identifier to check.
`Identifiername`	The name of the identifier field (e.g., 'GTIN').
`Workflowidentifiertype`	Indicate the type of identifier used for the workflow (e.g., 0 for ID, 1 for alias).
`Workflowidalias`	Provide the alias of the workflow to advance if using an alias identifier.
`Workflowstepidalias`	Supply the alias of the specific workflow step to advance.
`Isaccepted`	Set to true to accept the workflow step, false to reject it.

Product Add & Update (2)

POST v2.0 Product Add & Update

/api/importexport/import

Add or update product data by submitting an import request. Use this action to create new products or modify existing ones in bulk.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Companyid`	The identifier of the company that owns the catalog.
`Vocabularyid`	The identifier of the vocabulary used for validation.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Errormode`	Define how errors are handled during import; possible values include 'StopOnError' or 'ContinueOnError'.

POST v2.0 Product Update NutritionPanel

/import

Update the nutrition panel information for a product. Use this action to modify or add nutritional data to an existing product record.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Companyid`	The identifier of the company that owns the catalog.
`Vocabularyid`	The identifier of the vocabulary used for validation.
`Response Type`	The response format expected from the API (e.g. application/json).

Product Search & Retrieve

POST v2.0 Product Search

/api/importexport/productsearch

Search for products using flexible criteria and retrieve matching product data. Use this action to find products by identifiers, attributes, or other filters.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Skipcount`	Set the number of results to skip for pagination.
`Takecount`	Define the number of results to return per page.
`Vocabularyid`	The identifier of the vocabulary used for validation.
`Uselens`	Indicates whether to use a lens (a predefined search view) for the search. Provide a Boolean value (true or false).
`Locale`	Specify the locale for localized product data in the search results, such as en-US or fr-FR.
`Shouldincludemissingvocabularyattributes`	Determines whether to include vocabulary attributes that have missing values in the results. Set to true to include them.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (11)

Option Name	Description
`Targetpartyid`	Filter products by the target party (recipient) identifier. Provide a string representing the party ID.
`Orderby`	The property to order the results by (e.g., 'Name').
`Desc`	Whether to sort in descending order (true) or ascending (false).
`Attributefilteroperator`	Specifies the operator for attribute filtering, such as AND or OR, to combine multiple attribute conditions.
`Onhold`	Filter to only include products that are on hold. Provide a Boolean value (true to filter for on hold products).
`Archived`	Whether to include archived vocabulary sources (true) or only active ones (false).
`Language`	Filter products by the language of their data. Provide a language code string (e.g., en).
`Dataowner`	The data owner associated with the vocabulary.
`Productids`	A list of product identifiers to include in the catalog item.
`Identifierattributes`	List the attribute names that serve as product identifiers for the search. Provide an array of attribute name strings.
`Identifiers`	Provide the actual identifier values to search for, corresponding to the specified identifier attributes. Supply as an array of strings.

Retailer Operations & Flow (2)

GET v2.0 Product Recipient Feedback Get

/api/importexport/ProductFeedback/RecipientFeedback

Retrieve feedback provided by recipients (retailers) on products. Use this action to view feedback that recipients have submitted about product data.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vocabularyid`	The identifier of the vocabulary used for validation.
`Response Type`	The response format expected from the API (e.g. application/json).

POST v2.0 Product Supplier Feedback Post- ex 7h

/api/importexport/ProductFeedback

Submit feedback from a retailer to a supplier about product data. Use this action to send feedback or corrections back to the supplier.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vocabularyid`	The identifier of the vocabulary used for validation.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Dataowner`	The data owner for the bulk validation.
`Identifiername`	The name of the identifier field (e.g., 'GTIN').
`Identifiervalue`	The value of the product identifier to check.

Supplier Operations & Flow (7)

GET v1.0 Get Latest Requirement Sets for Party

/gc/party/requirementset/GetLatestForParty

Retrieve the latest requirement sets for a specific party. Use this action to get the most recent requirements that apply to a supplier or retailer.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Partyid`	Specify the identifier of the party whose latest requirement sets are to be retrieved. Provide a string party ID.
`Companyid`	Specify the company identifier associated with the party. Provide a string company ID.
`Content-type`	The media type of the request body, typically set to 'application/json'.
`Response Type`	The response format expected from the API (e.g. application/json).

POST v1.0 Link Recipients

/api/product/bulkoperation

Perform a bulk operation to link recipients to products. Use this action to associate recipients with products based on a search filter.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Dataowner`	The data owner to associate with the transferred asset.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Productids`	A list of product identifiers to include in the catalog item.
`Productsearchfilter`	Define a search filter to select which products will be linked. Provide a string representing the filter criteria.
`Action`	Specify the action to perform on the selected products, such as Link or Unlink. Provide the action name as a string.

POST v1.0 Publish to Recipient

/api/publication/publishtotargetmarket

Publish product data to a specific target market (recipient). Use this action to send product information to a particular recipient.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Companyid`	The identifier of the company that owns the catalog.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Productids`	A list of product identifiers to include in the catalog item.
`Targetpartyid`	Specify the identifier of the target recipient to whom the product data should be published. Provide a string party ID.

POST v2.0 Product Recipient Feedback Post

/api/importexport/ProductFeedback/RecipientFeedback

Submit feedback from a recipient (retailer) about a product. Use this action to send recipient feedback regarding product data issues or updates.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vocabularyid`	The identifier of the vocabulary used for validation.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Dataowner`	The data owner for the bulk validation.
`Identifiername`	The name of the identifier field (e.g., 'GTIN').
`Identifiervalue`	The value of the product identifier to check.

GET v2.0 Product Supplier Feedback Get

/api/importexport/ProductFeedback

Retrieve feedback submitted by suppliers about products. Use this action to view supplier feedback on product data.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vocabularyid`	The identifier of the vocabulary used for validation.
`Response Type`	The response format expected from the API (e.g. application/json).

POST v2.0 Publish Product

/api/importexport/publication

Publish product data to one or more target markets. Use this action to send product information to specified recipients, optionally with data quality checks.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vocabularyid`	The identifier of the vocabulary used for validation.
`Usedataquality`	Indicates whether to apply data quality validation before publishing. Provide a Boolean value (true to enable quality checks).
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Dataowner`	The data owner for the bulk validation.
`Identifiervalue`	The value of the product identifier to check.
`Identifiername`	The name of the identifier field (e.g., 'GTIN').
`Targetmarkets`	Specify the target markets (recipients) to publish to. Provide an array of target market identifiers.
`Sourcepartyalias`	Provide an alias for the source party (supplier) if needed. Supply a string alias.
`Targetpartyalias`	The target party alias to apply to all products in the batch.

POST v2.0 Publish Product bulk - ex 7f -WIP

/api/importexport/publication/bulk

Publish a batch of products to Syndigo for syndication.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Vocabularyid`	The identifier of the vocabulary used for validation.
`Usedataquality`	Indicates whether to apply data quality validation before publishing. Provide a Boolean value (true to enable quality checks).
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Dataowner`	The data owner for the bulk validation.
`Identifiervalue`	The value of the product identifier to check.
`Identifiername`	The name of the identifier field (e.g., 'GTIN').
`Targetmarkets`	Specify the target markets (recipients) to publish to. Provide an array of target market identifiers.
`Sourcepartyalias`	Provide an alias for the source party (supplier) if needed. Supply a string alias.
`Targetpartyalias`	The target party alias to apply to all products in the batch.