Skip to main content

Syndigo

The Syndigo Commerce Experience Suite provides a comprehensive cloud-based PIM.

Connecting Syndigo​

Credentials​

Several of the credentials you will need are all available in your My Account > API Settings page. These include the Data Owner Id, the Username and the Secret.

Click on your personal account icon in the upper-right of Syndigo, and then click My Account in the dropdown. That will bring you to the My Account page. Click on API Settings on the left to get to the page above.

Attributes​

In addition to your credentials you need to supply an attributes files from Syndigo that will provide the information required for introspection of you API. You can download either a Data View or a legacy Recipient Requirement Set.

Warning

If your supplied attribute file does not match the data returned from Syndigo you may end up with errors when fetching data from Syndigo via TakeShape. This is the case when a required field is suddenly missing, or when the type of a field has changed.

First, go to the Products > Active Products page. On this page you do not need to select any products.

Click the Download button from the top menu.

Click Direct Download and then click Next.

Click Attribute Spreadsheet and then click Next.

Select one of either a Recipient Requirement Set or Data View Requirement Set. You do not need to make any other selections on this screen. Click Next.

One the next page you can simply click Export to export the pre-selected file.

Finally, unzip your export and upload the provided .xlsx file to the

Recipient ID​

You'll also need to supply a Recipient ID with your service connection. This ensures that the service only requests properties that are described in the uploaded attributes. Please note, that your attributes upload should correspond to the Recipient ID you set here.

To get the id, you can go to Connections > Connected Recipients in Syndigo and then click on the recipient you want to use. The id is the UUID toward the end of the URL for this page, e.g., https://platform.syndigo.com/distribute/recipient/9d3411f7-a9fe-41f1-94e0-345c12b056f8/profile -> 9d3411f7-a9fe-41f1-94e0-345c12b056f8.

Service Connection​

Now, in TakeShape, add a Syndigo service to your project. On the configuration page you'll need to enter the Data Viewer ID, API Username and Secret from the previous sections. You will also upload the .xlsx file you unzipped, which will be verified.

When you click Save your credentials will be encrypted and used to authenticate with Syndigo.

Queries​

searchProducts​

The Syndigo service provides only one query, searchProducts. This corresponds to the Product Search and Retrieve REST endpoints in Syndigo.

Most parameters are supported in a format similar to Syndigo itself. Parameters noted below have special behaviors provided for convenience or safety.

  • publicationStatus

This field supports an enum of statuses documented here as well as a special value None that can be specified to eliminate any PublicationFilter values. The default value is Synchronized which offers the most type safety — Synchronized values should match the types and requiredness specified in your uploaded attributes file. Other statuses may lead to type errors in responses.