Salsifyconnector v1 | OneTeg Documentation

Version 1

Connector Overview: This page documents all 43 actions for the Salsifyconnector v1.

General (43)

PUT Add List Members

/lists/{list_id}/members

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`List Id`	Identifier for the list being updated. List ID can be found by navigating to the Salsify list; ID follows product_lists or digital_asset_lists. See List Membership Overview for how to find the list ID.
`Response Type`	N/A

Options (1)

Option Name	Description
`Member Id`	Salsify product ID for the products to be added to the list.

POST Bulk Create New Properties

/properties

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Salsify:id`	Unique identifier for property. Used in report headers, channel mapping, etc. Cannot start with salsify, =, or _. Case sensitive.
`Salsify:name`	Property name, if different from ID. Best practice is for property ID and name to match. If not specified, property name will be filled with property ID value.
`System Metadata`	Include values for any system metadata you want to set for the property. See Properties Overview for full list.
`Custom Metadata`	Set any custom metadata you want to include with the property.

POST Bulk Create Products

/products

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Product Id`	Property ID of the property that is set as the product ID role in Salsify. Product ID value cannot begin with =, _, or salsify. Must be unique, and is case sensitive.
`Product Name`	Property ID for the property that is set as the product name role in Salsify. Product name will be left blank if not included.
`Additional Properties`	Additional information to store in properties associated with the product, sent in value pairs of property_id : property_value. Property IDs that don't exist in the Salsify org will be created as default string data type. Accepts multiple property values as arrays.

POST Bulk Create Records

/records

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Record Id`	Property ID of the property that is set as the record ID role in Salsify. Record ID value cannot begin with =, _, or salsify. Must be unique, and is case sensitive.
`Record Name`	Property ID for the property that is set as the record name role in Salsify. Record name will be left blank if not included.
`Additional Properties`	Additional information to store in properties associated with the record, sent in value pairs of property_id : property_value. Property IDs that don't exist in the Salsify org will be created with a default string data type. Accepts multiple property values as arrays.

DELETE Bulk Delete Products

/products

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Product Id`	Unique value that identifies product and stored in the property that holds the product identifier role in Salsify. Send as an array of product ID values; property id label is not sent.

DELETE Bulk Delete Properties

/properties

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Salsify:id`	Unique identifier for each property, sent as an array.

DELETE Bulk Delete Records

/records

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Record Id`	Unique value that identifies records and stored in the property that holds the record identifier role in Salsify. Send as an array of record ID values; property id label is not sent.

GET Bulk Read Digital Assets

/digital_assets

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Filter`	Limit the scope of digital assets returned from the endpoint. Details on how to build filters are available here
`Page`	Page number
`Per Page`	Number of results per page
`Response Type`	N/A

GET Bulk Read Products

/products

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Filter`	Limit the scope of products returned from the endpoint. Details on how to build filters are available here
`Page`	Page number
`Per Page`	Number of results per page
`Response Type`	N/A

GET Bulk Read Records

/records

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Filter`	Limit the scope of records returned from the endpoint. Details on how to build filters are available here
`Page`	Page number
`Per Page`	Number of results per page
`Record Type`	Limit the scope to a specific record type
`Response Type`	N/A

PUT Bulk Update Products

/products

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Product Id`	Value to identify product, stored in property with unique product identifier role in your Salsify organization.
`Properties`	Properties can be added in value pairs. {property_id} : {property_value} where property_id is a Salsify property, and property_value is the corresponding property value. If property_id does not exist in org, property will be created.

PUT Bulk Update Records

/records

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Record Id`	Value to identify record, stored in property with unique record identifier role in your Salsify organization.
`Properties`	Properties can be added in value pairs. {property_id} : {property_value} where property_id is a Salsify property, and property_value is the corresponding property value. If property_id does not exist in org, property will be created.

PUT Bulk Upsert Digital Assets

/{organization_id}/digital_assets/_upsert

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Organization Id`	The Salsify organization's unique identifier. Visit your Salsify organization and pull from the URL path, immediately following /orgs/.
`Response Type`	N/A

Options (4)

Option Name	Description
`Salsify:id`	The identifier to use for the asset. A randomly generated ID is assigned if not specified.
`Salsify:url`	An HTTP(S) URL of a public image on the Internet.
`Salsify:name`	Digital asset name. The filename is used if not specified.
`Additional Metadata`	Additional optional metadata can be added in value pairs. {metadata_id} : {metadata_value} where metadata_id is a Salsify property, and metadata_value is the corresponding property value. If metadata_id does not exist in org, property will be created.

PUT Bulk Upsert Products

/products/_upsert

Upserts allow you to update and create a product in the same call.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Product Id`	Value to identify product, stored in property with unique product identifier role in your Salsify organization.
`Properties`	Properties can be added in value pairs. {property_id} : {property_value} where property_id is a Salsify property, and property_value is the corresponding property value. If property_id does not exist in org, property will be created.

PUT Bulk Upsert Properties

/{organization_id}/properties/_upsert

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Organization Id`	The Salsify organization's unique identifier. Visit your Salsify organization and pull from the URL path, immediately following /orgs/
`Response Type`	N/A

Options (4)

Option Name	Description
`Salsify:id`	Unique identifier for property. Used in report headers, channel mapping, etc. Cannot start with salsify, =, or _. Case sensitive.
`Salsify:name`	Property name, if different from ID. Best practice is for property ID and name to match. If not specified, property name will be filled with property ID value.
`Salsify:system Metadata`	Include values for any system metadata you want to set for the property. See Properties Overview for full list.
`Salsify:custom Metadata`	Set any custom metadata you want to include with the property.

PUT Bulk Upsert Records

/records/_upsert

Upsert allows you to update and create a record in the same call.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Record Id`	Value to identify record, stored in property with unique record identifier role in your Salsify organization.
`Properties`	Properties can be added in value pairs. {property_id} : {property_value} where property_id is a Salsify property, and property_value is the corresponding property value. If property_id does not exist in org, a property with that id will be created.

POST Create Multiple Digital Assets

/digital_assets

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Salsify:source Url`	A public-facing HTTP(S) URL for the digital asset file.
`Salsify:id`	The identifier to use for the asset. A randomly generated ID is assigned if not specified.
`Salsify:name`	Digital asset name. The filename is used if not specified.
`Additional Metadata`	Additional optional metadata (system or custom) can be added in value pairs. {metadata_id} : {metadata_value} where metadata_id is a Salsify property, and metadata_value is the corresponding property value. If metadata_id does not exist in org, property will be created.

POST Create Product1

/products/

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Prod A`	N/A
`Product id`	N/A
`Product name`	N/A

POST Create Record

/records/

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Record Name`	Property ID for the property that is set as the record name role in Salsify. Record name will be left blank if not included.
`Additional Properties`	Additional information to store in properties associated with the record, sent in value pairs of property_id : property_value. Property IDs that don't exist in the Salsify org will be created as default string data type. Accepts multiple property values as arrays.

POST Create a Digital Asset & Metadata

/{organization_id}/digital_assets

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Organization Id`	The Salsify organization's unique identifier. Visit your Salsify organization and pull from the URL path, immediately following /orgs/
`Response Type`	N/A

Options (3)

Option Name	Description
`Salsify:source Url`	An HTTP(S) URL of a public image on the Internet.
`Salsify:id`	The identifier to use for the asset. A randomly generated ID is assigned if not specified.
`Additional Metadata`	Additional optional metadata (system or custom) can be added in value pairs. {metadata_id} : {metadata_value} where metadata_id is a Salsify property, and metadata_value is the corresponding property value. If metadata_id does not exist in org, property will be created.

POST Create a Mount Point

/imports/upload_mounts

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Authorization: bearer`	User API Key
`Content-type`	N/A
`Response Type`	N/A

POST Creating a JSON Import from a Mount Point

/imports

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Authorization: bearer:`	User API Key
`Content-type`	N/A
`Response Type`	N/A

DELETE Delete List Members

/lists/{list_id}/members

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`List Id`	Identifier for the list being updated. List ID can be found by navigating to the Salsify list; ID follows product_lists or digital_asset_lists
`Response Type`	N/A

DELETE Delete Multiple Digital Assets

/digital_assets

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

DELETE Delete Product

/products/{product_id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Product Id`	Unique value that identifies product and stored in the property that holds the product identifier role in Salsify. Send as an array of product ID values; property id label is not sent.
`Response Type`	N/A

DELETE Delete Property

/properties/{salsify:id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Salsify:id`	Unique identifier for the property. Used in report headers, channel mapping, etc.
`Response Type`	N/A

DELETE Delete Record

/records/{product_id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Record Id`	Unique value that identifies records and stored in the property that holds the record identifier role in Salsify.
`Response Type`	N/A

GET Get Export Status

/export_runs/{export_id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Export Id`	The ID for the export you want to retrieve status for. Found in the response from Start Export Run POST call.
`Response Type`	N/A

GET Getting the Status of an Import Run

/imports/runs/{import_run_id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Import Run Id`	the ID of the import run to retrieve status for
`Authorization: bearer`	User API Key
`Content-type`	N/A
`Response Type`	N/A

GET Read Digital Asset Metadata

/digital_assets/{asset_id}

Where a user has permission and the digital asset exists, complete digital asset JSON object is returned with its most current information.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Id`	Digital asset unique identifier.
`Response Type`	N/A

GET Read Product Record

/products/{salsify:id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Salsify:id`	Salsify product ID
`Response Type`	N/A

GET Read Property

/properties/{salsify:id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Salsify:id`	Unique identifier for the property. Used in report headers, channel mapping, etc.
`Response Type`	N/A

GET Read Record

/records/{salsify:id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Salsify Id`	Salsify record ID for uniquely identifying a record.
`Response Type`	N/A

GET Read Record Types

/record_types

Used to query for all available record types.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

POST Refresh Digital Assets

/<org_ID>/digital_assets/refresh

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Salsify:id`	The identifier to use for the asset.
`Response Type`	N/A

POST Start Export Run

/export_runs

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (9)

Option Name	Description
`Entity Type`	Defines the type of entity you want to export. Allowed Values: all product digital_asset attribute attribute_value
`Format`	Format file is output in. If not specified, default format for all entity_types is xlsx. Note that for entity_type all, the only valid output formats are json and jsonl. Allowed Values: json jsonl csv xlsx
`Compress`	If true is specified, returns a compressed file in gzip format. (.gz)
`Include All Columns`	Returns all content properties for product entities, or all custom metadata stored with digital asset entities. Default is true. Use properties to define the scope for false.
`Include All Content Locales`	If true, the export run will include data for every content locale; otherwise it will include data for the channel's content locale
`Properties`	For exports where include_all_columns is false, specify property IDs for properties to be included in the export and formatted as a single value of single quote and comma-separated values. ie. "'Property ID 1','Property ID 2',Property ID 3'"
`Filter`	Limit the scope of entities included in export file based on filter specifications. Details on how to build filters are available here
`Sort Order`	Sorts results in either ascending or descending order by. Allowed Values: asc desc
`Sort Property`	Sorts results by the values stored in the Salsify Property ID specified.

POST Starting an Import Run

/imports/{import_id}/runs

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Import Id`	Identifier for the import run either created manually in the application for a csv/excel import or generated with a mount point creation.
`Authorization: bearer`	User API Key
`Content-type`	N/A
`Response Type`	N/A

PUT Update Digital Asset Metadata

/digital_assets/{salsify:id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Salsify:id`	The identifier for the digital asset you want to replace.
`Response Type`	N/A

Options (2)

Option Name	Description
`Source Url`	Public-facing, non-login URL for the location of the digital asset you want to replace the current asset with. Don't include if you aren't making an update to the digital asset's source.
`Additional Custom Metadata`	Additional optional custom metadata can be added in value pairs. {metadata_id} : {metadata_value} where metadata_id is a Salsify property, and metadata_value is the corresponding property value. If metadata_id does not exist in org, property will be created.

PUT Update Multiple Digital Assets

/digital_assets

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Salsify:id`	The identifier to use for the asset. A randomly generated ID is assigned if not specified.
`Source Url`	An HTTP(S) URL of a public image on the Internet.
`Salsify:name`	Digital asset name. The filename is used if not specified.
`Additional Metadata`	Additional optional metadata can be added in value pairs. {metadata_id} : {metadata_value} where metadata_id is a Salsify property, and metadata_value is the corresponding property value. If metadata_id does not exist in org, property will be created.

PUT Update Product

/products/{product_id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Product Id`	Unique value that identifies product and stored in the property that holds the product identifier role in Salsify. Send as an array of product ID values; property id label is not sent.
`Response Type`	N/A

Options (2)

Option Name	Description
`Product Id`	Value to identify product, stored in property with unique product identifier role in your Salsify organization.
`Properties`	Properties can be added in value pairs. {property_id} : {property_value} where property_id is a Salsify property, and property_value is the corresponding property value. If property_id does not exist in org, property will be created.

PUT Update Property

/properties/{salsify:id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Salsify:id`	Unique identifier for the property. Used in report headers, channel mapping, etc.
`Response Type`	N/A

Options (1)

Option Name	Description
`Metadata Id`	Property metadata can be added in value pairs. {metadata_id} : {metadata_value} where metadata_id is the metadata id being associated with the Salsify property, and metadata_value is the corresponding metadata value. If metadata_id does not exist in org, metadata property will be created.

PUT Update Record

/records/{record_id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Record Id`	Value to identify record, stored in property with unique record identifier role in your Salsify organization.
`Response Type`	N/A

Options (1)

Option Name	Description
`Properties`	Properties can be added in value pairs. {property_id} : {property_value} where property_id is a Salsify property, and property_value is the corresponding property value. If property_id does not exist in the org, the property will be auto-created. The record_id must also be included in the body parameters.

PUT Updating an Import to Point at a New Mount Point

/imports/{import_id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Import Id`	Identifier for the import run either created manually in the App for a csv/excel import or generated with a mount point creation.
`Authorization: bearer`	User API Key
`Content-type`	N/A
`Response Type`	N/A