Integrations

The Integrations API provides you the ability to manage your Whisk Studio Integrations.

Let's first understand the Integration object and its data structure before looking at its endpoints’ description.
Integrations Object
An Integrations object is a collection of attributes that store details of each integration.
This is how the data structure of an Integrations definition looks in JSON format:
{
  "integrations": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": "INTEGRATION_TYPE_CUSTOM",
      "status": "INTEGRATION_STATUS_ENABLED",
      "created_at": "1608910441740",
      "updated_at": "1608910441740"
    },
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": "INTEGRATION_TYPE_SALSIFY",
      "status": "INTEGRATION_STATUS_ENABLED",
      "created_at": "1609768210609",
      "updated_at": "1609846831662"
    },
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": "INTEGRATION_TYPE_SHOPIFY",
      "status": "INTEGRATION_STATUS_ENABLED",
      "created_at": "1611242960379",
      "updated_at": "1611242960379"
    }
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": "INTEGRATION_TYPE_WORDPRESS",
      "status": "INTEGRATION_STATUS_ENABLED",
      "created_at": "1611346856098",
      "updated_at": "1611346856098"
    }
  ]
}
The following attributes define the core of an integration object:
Attribute
Type
Description
id
string
The integration identifier. The Whisk Studio Sync API needs this identifier to authorize the API calls.
type
enum
Indicates the type of integration. It supports the following values:
INTEGRATION_TYPE_CUSTOM
INTEGRATION_TYPE_SALSIFY
INTEGRATION_TYPE_SHOPIFY
INTEGRATION_TYPE_WORDPRESS 
status
enum
Indicates the current status of Integration. It supports the following values:
INTEGRATION_STATUS_DISABLED
INTEGRATION_STATUS_ENABLED
updated_at
string
The last integration update date and time in Unix format.
created_at
string
The integration creation date and time in Unix format.
Endpoints
Integrations API includes three endpoints that you can use to manage different integration types in your Whisk Studio account.

Add a new Integration Type
/whisk-studio-api-reference/integration/add-a-new-integration-type
Get Integrations Details
/whisk-studio-api-reference/integration/get-integrations-details
Update Status of an Integration Type
/whisk-studio-api-reference/integration/update-status-of-an-integration-type

Delete Products in a Batch

Add a new Integration Type

Last updated 3 weeks ago

Attribute	Type	Description
`id`	string	The integration identifier. The Whisk Studio Sync API needs this identifier to authorize the API calls.
`type`	enum	Indicates the type of integration. It supports the following values: `INTEGRATION_TYPE_CUSTOM` `INTEGRATION_TYPE_SALSIFY` `INTEGRATION_TYPE_SHOPIFY` `INTEGRATION_TYPE_WORDPRESS`
`status`	enum	Indicates the current status of Integration. It supports the following values: `INTEGRATION_STATUS_DISABLED` `INTEGRATION_STATUS_ENABLED`
`updated_at`	string	The last integration update date and time in Unix format.
`created_at`	string	The integration creation date and time in Unix format.