Integration Info for Single Integration

Headers

x-trackstar-api-key

string

required

Your organization-level Trackstar API key.

Path Parameters

integration_type

enum<string>

required

The type of integration to filter by.

Available options:

wms,

freight,

cart

integration_name

string

required

The name of the integration to filter by.

Response

200 - application/json

data

object[]

required

Integration Info

data.available_actions

string[]

required

The actions supported by the integration.

data.description

string

required

A description of the integration.

data.install_method

enum<string>

required

How users install the integration within the Trackstar Modal.

Available options:

input,

oauth

data.integration_name

string

required

The name of the integration.

data.list_operations

object[]

required

The list operations supported by the integration.

data.list_operations.action

string

required

The action that can be performed.

data.list_operations.implemented_fields

object

required

The fields that are implemented for the action.

data.list_operations.implemented_fields.{key}

any

A Boolean indicating if the field is implemented, or an object or list with more details.

data.list_operations.url

string

required

The URL for the action.

data.logo_url

string

required

The URL of the integration's logo.

data.write_operations

object[]

required

The write operations supported by the integration.

data.write_operations.action

string

required

The action that can be performed.

data.write_operations.integration_specific_fields

object

required

data.write_operations.integration_specific_fields.properties

object

required

The integration specific fields and their definitions.

data.write_operations.integration_specific_fields.properties.{key}

any

data.write_operations.integration_specific_fields.type

string

required

The type of the integration specific fields.

data.write_operations.integration_specific_fields.required_fields

string[]

The required fields for the integration specific fields.

data.write_operations.optional_base_schema_fields

string[]

required

The optional fields for the action.

data.write_operations.required_base_schema_fields

string[]

required

The required fields for the action.

data.write_operations.url

string

required

The URL for the action.