# Salsify

## **Locating the API keys & Organisation ID**

#### **API Key**

1\.       Log into Salsify (<https://app.salsify.com/users/sign_in>)

2\.       Click on your **profile name** -> **My profile**

![](https://15515196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LbJ1eMq5M51cIpU163R%2Fuploads%2Fg7zgj02CTMXw3uqsq8Ip%2F2022-03-16%20at%202.50%20PM.png?alt=media\&token=2947b55d-32a4-4710-9ebb-fe4a5a224bff)

3\.       Click on **API Access** and then click on **Show API Keys**, you'll have your API key!

![](https://15515196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LbJ1eMq5M51cIpU163R%2Fuploads%2FacVt7LeBYxred17bLxbT%2F2022-03-16%20at%202.49%20PM.png?alt=media\&token=9debaabc-85a7-412b-8934-ab9112666f55)

**Organisation ID**

After you login to Salsify, the organisation ID can be found in the URL.

![The portion in red underline.](https://15515196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LbJ1eMq5M51cIpU163R%2Fuploads%2FVbYLju4Fm3pC3qy4PvJf%2Fimage.png?alt=media\&token=1d987119-a6bb-48a3-9bca-7550ff375472)

In here the red underlined portion is the Organisation ID.\
\
URL would resemble something like:\
<https://app.salsify.com/app/orgs/><mark style="color:red;">**s-9693c0b9-550e-xxxx-xxxx-xxxxxxxx**</mark>/products?content\_locales \[] =en-GB

The part in red is your Organisation ID.

## **Snapshot**

| Features                        | Details   |
| ------------------------------- | --------- |
| Release Status                  | Released  |
| Source API Version              | v1.0      |
| Table Selection                 | Yes       |
| Column Selection                | No        |
| Edit Integrations               | Yes       |
| Replication Type Selection      | No        |
| Authentication Parameters       | API Key   |
| Replication Type                | Full Load |
| Replication Key                 | -         |
| Suggested Replication Frequency | 1 hr      |

## **Salsify Tables**

Source documentation: <https://developers.salsify.com/reference>

**1.       Product**\
Purpose: To get all your products and their related information.\
Replication: Full Load\
Replication Key: NA\
\
**Fields**

<table data-header-hidden><thead><tr><th width="270"></th><th></th></tr></thead><tbody><tr><td><p> </p><p><strong>Name</strong></p><p> </p></td><td><p> </p><p><strong>Data Type</strong></p><p> </p></td></tr><tr><td>ProductID</td><td>STRING</td></tr><tr><td>ProductName</td><td>STRING</td></tr><tr><td>Imagery_en_GB</td><td>STRING</td></tr><tr><td>Brand</td><td>STRING</td></tr><tr><td>BrandFamily</td><td>STRING</td></tr><tr><td>BrandManager</td><td>STRING</td></tr><tr><td>CartonCBM</td><td>STRING</td></tr><tr><td>CartonDimensionsHeight</td><td>STRING</td></tr><tr><td>CartonDimensionsLength</td><td>STRING</td></tr><tr><td>CartonDimensionsWidth</td><td>STRING</td></tr><tr><td>CartonsGrossWeight</td><td>STRING</td></tr><tr><td>CartonsPerPalletEuro</td><td>STRING</td></tr><tr><td>CartonsPerPalletStandard</td><td>STRING</td></tr><tr><td>CategoryL1Name</td><td>STRING</td></tr><tr><td>CategoryL2Name</td><td>STRING</td></tr><tr><td>CategoryL3Name</td><td>STRING</td></tr><tr><td>Composition</td><td>STRING</td></tr><tr><td>ControlledRestricted</td><td>STRING</td></tr><tr><td>DutyPercentageAU</td><td>STRING</td></tr><tr><td>DutyPercentageCA</td><td>STRING</td></tr><tr><td>DutyPercentageEU</td><td>STRING</td></tr><tr><td>DutyPercentageJP</td><td>STRING</td></tr><tr><td>DutyPercentageUK</td><td>STRING</td></tr><tr><td>DutyPercentageUS</td><td>STRING</td></tr><tr><td>HazardousDG</td><td>STRING</td></tr><tr><td>HsCodeAU</td><td>STRING</td></tr><tr><td>HsCodeCA</td><td>STRING</td></tr><tr><td>HsCodeEU</td><td>STRING</td></tr><tr><td>HsCodeJP</td><td>STRING</td></tr><tr><td>HsCodeUK</td><td>STRING</td></tr><tr><td>HsCodeUS</td><td>STRING</td></tr><tr><td>IndividualProductPackagingNW</td><td>STRING</td></tr><tr><td>IsAdultProduct</td><td>STRING</td></tr><tr><td>ItemHeight</td><td>STRING</td></tr><tr><td>ItemHeightUnit</td><td>STRING</td></tr><tr><td>ItemLength</td><td>STRING</td></tr><tr><td>ItemLengthUnit</td><td>STRING</td></tr><tr><td>ItemWeight</td><td>STRING</td></tr><tr><td>ItemWeightUnit</td><td>STRING</td></tr><tr><td>ItemWidth</td><td>STRING</td></tr><tr><td>ItemWidthUnit</td><td>STRING</td></tr><tr><td>MOQ</td><td>STRING</td></tr><tr><td>NonDomesticSuppliers</td><td>STRING</td></tr><tr><td>PackageHeight</td><td>STRING</td></tr><tr><td>PackageHeightUnit</td><td>STRING</td></tr><tr><td>PackageLength</td><td>STRING</td></tr><tr><td>PackageLengthUnit</td><td>STRING</td></tr></tbody></table>

&#x20;

**2.       Product Images**\
Purpose: To get all your product images along with product names.\
Replication: Full Load\
Replication Key: NA\
\
**Fields**

| <p> </p><p>        <strong>Name</strong></p><p> </p> | <p> </p><p>     <strong>Data Type</strong></p><p> </p> |
| ---------------------------------------------------- | ------------------------------------------------------ |
| salsify\_id                                          | STRING                                                 |
| salsify\_name                                        | STRING                                                 |
| salsify\_url                                         | STRING                                                 |
| salsify\_source\_url                                 | STRING                                                 |
| salsify\_asset\_resource\_type                       | STRING                                                 |
| salsify\_asset\_height                               | INTEGER                                                |
| salsify\_asset\_width                                | INTEGER                                                |
| salsify\_asset\_size                                 | INTEGER                                                |
| salsify\_etag                                        | STRING                                                 |
| salsify\_created\_at                                 | TIMESTAMP                                              |
| salsify\_updated\_at                                 | TIMESTAMP                                              |
| ProductID                                            | STRING                                                 |
| salsify\_asset\_height\_st                           | STRING                                                 |
| salsify\_asset\_width\_st                            | STRING                                                 |
| salsify\_asset\_size\_st                             | STRING                                                 |

\ <br>

**3.       Attribute**\
Purpose: To get all your attributes related to all the products.\
Replication: Full Load\
Replication Key: NA\
\
**Fields**

| <p> </p><p><strong>Name</strong></p><p> </p> | <p> </p><p><strong>Data Type</strong></p><p> </p> |
| -------------------------------------------- | ------------------------------------------------- |
| salsify\_id                                  | STRING                                            |
| salsify\_name                                | STRING                                            |
| salsify\_data\_type                          | STRING                                            |
| salsify\_is\_facetable                       | STRING                                            |
| salsify\_attribute\_group                    | STRING                                            |
| salsify\_position                            | STRING                                            |
| salsify\_help\_text                          | STRING                                            |
| salsify\_searchable                          | STRING                                            |
| salsify\_manage\_permissions                 | STRING                                            |
| salsify\_read\_permissions                   | STRING                                            |
| salsify\_type                                | STRING                                            |
| salsify\_formula                             | STRING                                            |
| salsify\_entity\_types                       | STRING                                            |
| salsify\_localizable                         | STRING                                            |
| salsify\_entity\_scope                       | STRING                                            |

**4.       Attribute Values**\
Purpose: To get all your attribute values for all the products.\
Replication: Full Load\
Replication Key: NA\
\
**Fields**

<table data-header-hidden><thead><tr><th width="298"></th><th></th></tr></thead><tbody><tr><td><p> </p><p><strong>Name</strong></p><p> </p></td><td><p> </p><p><strong>Data Type</strong></p><p> </p></td></tr><tr><td>salsify_id</td><td>STRING</td></tr><tr><td>salsify_name</td><td>STRING</td></tr><tr><td>salsify_attribute_id</td><td>STRING</td></tr><tr><td>salsify_parent_id</td><td>STRING</td></tr><tr><td>salsify_localized_name_de_DE</td><td>STRING</td></tr><tr><td>salsify_localized_name_en_GB</td><td>STRING</td></tr><tr><td>salsify_localized_name_en_US</td><td>STRING</td></tr><tr><td>salsify_localized_name_es_ES</td><td>STRING</td></tr><tr><td>salsify_localized_name_es_MX</td><td>STRING</td></tr><tr><td>salsify_localized_name_fr_FR</td><td>STRING</td></tr><tr><td>salsify_localized_name_it_IT</td><td>STRING</td></tr><tr><td>salsify_localized_name_ja_JP</td><td>STRING</td></tr><tr><td>salsify_localized_name_pl_PL</td><td>STRING</td></tr><tr><td>salsify_localized_name_sv_SE</td><td>STRING</td></tr></tbody></table>

&#x20;
