1. Prerequisites and Additional Steps and Helper Utilities
Log into Salsify Portal with the correct credentials for Products, Records, Properties, and all the required data.
To check already uploaded Digital Assets and their properties, from the top menu select Digital Assets and click View All.
You can click on any asset to check its properties.
Getting org_id
Org_id can be retrieved by logging into the Salsify Portal. Org_Id appears in the search bar.
2. Authentication & Token creation
To call any Salsify APIs, you must provide your authorization token.
The auth token is specific to a user account (not an individual Salsify workspace). Treat this token as you would your password -- don't send it to anyone, and make sure to store// it in a safe place.
The Salsify API uses authentication tokens to allow access to the API. You can generate a personal token in the Salsify application on the My Profile page.
3. Connector Action & Tests
|
Action Name / Method |
Create Digital Asset and Metadata |
Local Tests |
Dev Tests |
Q/A Tests |
||
|---|---|---|---|---|---|---|
|
Action Description |
Create Digital Asset and Metadata on Salsify |
|
|
|
||
|
Test Case |
Create asset on salsify with its metadata |
Pass |
Pass |
|
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
|
|
|
Organization ID |
String |
Organization Id (s-b6cc4ae3-8bf7-418f-a29e…) |
|
|
|
|
|
Source URL |
String |
Any image URL (https://images.pexels.com/photos/774735/pexels-photo-774735.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=750&w=1260) |
|
|
|
|
|
Asset Photographer |
String |
Name of asset photographer (Test) |
|
|
|
|
|
Salsify ID |
String |
New salsify id |
|
|
|
|
|
File Name |
String |
New salsify name |
|
|
|
Digital Asset Created on Salsify Portal
|
Action Name / Method |
Create Multiple Digital Asset and Metadata |
||
|---|---|---|---|
|
Action Description |
Create Multiple Digital Asset and Metadata on Salsify |
||
|
Test Case |
Create assets on salsify with its metadata |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id (s-b6cc4ae3-8bf7-418f-a29e…) |
|
|
Source URL |
String |
Any image URL (https://images.pexels.com/photos/774735/pexels-photo-774735.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=750&w=1260) |
|
|
Salsify ID |
String |
New salsify id |
|
|
File Name |
Strings |
New salsify name |
|
Action Name / Method |
Read Digital Asset and Metadata |
||
|---|---|---|---|
|
Action Description |
Read Digital Asset and Metadata from Salsify |
||
|
Test Case |
Read asset from salsify with its metadata |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id (s-b6cc4ae3-8bf7-418f-a29e…) |
|
|
Asset ID |
String |
Id of asset |
|
Action Name / Method |
Update Digital Asset and Metadata |
||
|---|---|---|---|
|
Action Description |
Update Digital Asset and Metadata on Salsify |
||
|
Test Case |
Update asset and its metadata on salsify |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id (s-b6cc4ae3-8bf7-418f-a29e…) |
|
|
Salsify Id |
String |
Id of asset |
|
|
Source URL |
String |
Any image URL (https://images.pexels.com/photos/774735/pexels-photo-774735.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=750&w=1260) |
|
|
Asset Use |
String |
e.g Testing |
|
|
Salsify Name |
String |
New salsify name |
Name of asset updated
|
Action Name / Method |
Update Multiple Digital Asset and Metadata |
||
|---|---|---|---|
|
Action Description |
Update Multiple Digital Asset and Metadata on Salsify |
||
|
Test Case |
Update multiple assets and its metadata on salsify |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id (s-b6cc4ae3-8bf7-418f-a29e…) |
|
|
Salsify Id |
String |
Id of asset |
|
|
Source URL |
String |
Any image URL (https://images.pexels.com/photos/774735/pexels-photo-774735.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=750&w=1260) |
|
|
Asset Use |
String |
e.g Testing |
|
|
Salsify Name |
String |
New salsify name |
|
Action Name / Method |
Bulk Upsert Digital Assets |
||
|---|---|---|---|
|
Action Description |
You can add and update multiple digital assets within one call by sending the digital asset URLs, properties and/or metadata as an array of digital asset data. |
||
|
Test Case |
Update multiple assets and its metadata on salsify |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id (s-b6cc4ae3-8bf7-418f-a29e…) |
|
|
Salsify Id |
String |
Id of asset |
|
|
Source URL |
String |
Any image URL (https://images.pexels.com/photos/774735/pexels-photo-774735.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=750&w=1260) |
|
|
Salsify Name |
String |
New salsify name |
|
Action Name / Method |
Delete Digital Assets |
||
|---|---|---|---|
|
Action Description |
Use to permanently delete digital asset from Salsify. |
||
|
Test Case |
Delete a single asset from Salsify. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id (s-b6cc4ae3-8bf7-418f-a29e…) |
|
|
Salsify Id |
String |
Id of asset |
|
Action Name / Method |
Create Product |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Create product on Salsify with metadata. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id (s-bxxx4ae3-xxxx-xxxf-a29e…) |
|
|
Product Id |
String |
Id of product |
|
|
Product Name |
String |
Name of product |
|
|
Material |
String |
Plastic |
|
|
Tags |
String |
Headphones |
|
Action Name / Method |
Bulk Create Product |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Create multiple products on Salsify with metadata. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id (s-xxxxxx-8bf7-xxxx-xxxx…) |
|
|
Product Id |
String |
Id of product |
|
|
Product Name |
String |
Name of product |
|
|
Material |
String |
Plastic |
|
|
Tags |
String |
Headphones |
|
|
Short Description |
String |
Description text |
|
Action Name / Method |
Read Product Record |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Read product details from Salsify with metadata. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id (s-xxxxxx-8bf7-xxxx-xxxx…) |
|
|
Salsify Id |
String |
Id of product |
|
Action Name / Method |
Update Product |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Update product on Salsify with metadata. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id (s-xxxxxx-8bf7-xxxxx-xxxxx…) |
|
|
Product Id |
String |
Id of product |
|
|
Product Name |
String |
Name of product |
|
|
Property Name |
String |
any property |
|
|
Property Value |
String |
property value |
|
|
Brand |
String |
Test |
|
Action Name / Method |
Bulk Update Products |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Update products on Salsify with metadata. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id |
|
|
Product Id |
String |
Id of product |
|
|
Product Name |
String |
Name of product |
|
|
Brand |
String |
Test |
|
|
Short Description |
String |
Description of product |
|
|
Tags |
String |
Headphones |
|
Action Name / Method |
Bulk Upsert Products |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Upsert products on Salsify with metadata. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id (s-xxxxxx-xxxx-xxxx-xxxx…) |
|
|
Product Id |
String |
Id of product |
|
|
Product Name |
String |
Name of product |
|
|
Brand |
String |
Test |
|
|
Short Description |
String |
Description of product |
|
Action Name / Method |
Delete Product |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Delete product from Salsify with metadata. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id |
|
|
Product ID |
String |
Id of product |
|
Action Name / Method |
Create Record |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Create record on Salsify with metadata. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id |
|
|
Product Id |
String |
Id of product |
|
|
Record Name |
String |
Name of product |
|
|
Record Id |
String |
Id of product |
|
|
Material |
String |
Plastic |
|
|
Tags |
String |
Headphones |
|
Action Name / Method |
Bulk Create Record |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Create multiple record on Salsify with metadata. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id (s-b6cc4ae3-8bf7-418f-a29e…) |
|
|
Record Name |
String |
Name of product |
|
|
Record Id |
String |
Id of product |
|
|
Material |
String |
Plastic |
|
|
Tags |
String |
Headphones |
|
|
Short Description |
String |
Description text |
|
Action Name / Method |
Read Record |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Read record (product) details from Salsify with metadata. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id |
|
|
Salsify ID |
String |
Id of product |
|
Action Name / Method |
Read Record Types |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Read record types (product) details from Salsify with metadata. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id |
|
Action Name / Method |
Update Record |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Update record on Salsify with metadata. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id (s-b6cc4ae3-8bf7-418f-a29e…) |
|
|
Record Name |
String |
Name of product |
|
|
Product Id |
String |
Id of product |
|
|
Brand |
String |
Plastic |
|
Action Name / Method |
Bulk Update Records |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Update multiple record on Salsify with metadata. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id |
|
|
Record Name |
String |
Name of product |
|
|
Record Id |
String |
Id of product |
|
|
Brand |
String |
Plastic |
|
|
Short Description |
String |
Description text |
|
|
Tags |
String |
headphones |
|
Action Name / Method |
Delete Record |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Delete record (product) details from Salsify with metadata. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id |
|
|
Record ID |
String |
Id of product |
|
Action Name / Method |
Bulk Upsert Records |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Upsert multiple record on Salsify with metadata. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id |
|
|
Record Name |
String |
Name of product |
|
|
Record Id |
String |
Id of product |
|
|
Brand |
String |
Plastic |
|
|
Short Description |
String |
Description text |
|
Action Name / Method |
Create Property |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Create new property to store values in. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id |
|
|
Salsify ID |
String |
test_ID |
|
|
Postion |
String |
null |
|
|
Data Type |
String |
string |
|
|
Help Text |
String |
This is a test property |
|
|
Manage Permission |
String |
null |
|
|
Attribute Group |
String |
General |
|
|
Salsify Name |
String |
test_name |
|
|
Type |
String |
string |
|
|
Hidden Permission |
String |
null |
|
|
System Metadata |
String |
null |
|
|
Custom Metadata |
String |
null |
|
|
Read Permission |
String |
null |
|
Action Name / Method |
Bulk Create New Properties |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Create new properties to store values in. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id (s-b6cc4ae3-8bf7-418f-a29e…) |
|
|
Salsify ID |
String |
test_ID |
|
|
Postion |
String |
null |
|
|
Data Type |
String |
string |
|
|
Help Text |
String |
This is a test property |
|
|
Manage Permission |
String |
null |
|
|
Attribute Group |
String |
General |
|
|
Salsify Name |
String |
test_name |
|
|
Type |
String |
string |
|
|
Hidden Permission |
String |
null |
|
|
System Metadata |
String |
null |
|
|
Custom Metadata |
String |
null |
|
|
Read Permission |
String |
null |
|
Action Name / Method |
Bulk Upsert Properties |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Create and update properties and property metadata simultaneously in the same call. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id (s-b6cc4ae3-8bf7-418f-a29e…) |
|
|
Salsify ID |
String |
test_ID |
|
|
Postion |
String |
null |
|
|
Data Type |
String |
string |
|
|
Help Text |
String |
This is a test property |
|
|
Manage Permission |
String |
null |
|
|
Attribute Group |
String |
General |
|
|
Salsify Name |
String |
test_name |
|
|
Type |
String |
string |
|
|
Hidden Permission |
String |
null |
|
|
System Metadata |
String |
null |
|
|
Custom Metadata |
String |
null |
|
|
Read Permission |
String |
null |
|
Action Name / Method |
Read Property |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Read property data |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id |
|
|
Salsify ID |
String |
Id of product |
|
Action Name / Method |
Update Property |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Update property and its values. |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id |
|
|
Salsify ID |
String |
Id of product |
|
|
Help Text |
String |
Amazon Unique Identifier |
|
|
Entity Types |
String |
Entity types |
|
|
Created At |
String |
created date |
|
|
System Id |
String |
system id |
|
|
Updated At |
String |
updated date |
|
Action Name / Method |
Delete Property |
||
|---|---|---|---|
|
Action Description |
|||
|
Test Case |
Delete property data |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Organization ID |
String |
Organization Id |
|
|
Property ID |
String |
Id of property |
4. Connection Settings and Configuration
|
Settings Parameters |
Value |
Description |
Required (Y/N) |
Default Value |
|---|---|---|---|---|
|
Connector |
Salsify |
Connector Name |
Y |
Salsify |
|
Authentication |
TOKEN |
Authentication Type |
Y |
TOKEN |
|
Endpoint |
Endpoint required for performing CRUD on Excel APIs. |
Y |
|
|
|
Auth Token |
Access Token |
Enter the access token that we get from Salsify Credentials. |
Y |
|
