Get Connection - Trackstar

Headers

x-trackstar-api-key

string

required

Your organization-level Trackstar API key.

Path Parameters

connection_id

string

required

Response

200 - application/json

data

object[]

A list of connections for your organization.

data.available_actions

string[]

required

A list of actions that the integration supports.

data.available_endpoints

string[]

required

DEPRECATED: Use available_actions instead.

data.connection_id

string

required

The unique ID of the connection.

data.created_at

string

required

The date the connection was created.

data.customer_id

string | null

required

An identifier for your end customer.

data.errors

object[]

required

A list of errors for the connection. e.g. missing permissions, invalid credentials, etc.

data.integration_name

string

required

The name of the integration associated with the connection.

data.integration_type

enum<string>

required

The type of the integration.

Available options:

wms,

freight,

cart

data.last_used

string | null

required

The date the connection was last updated.

data.latest_sync

string | null

required

DEPRECATED: Use sync_schedules instead.

data.sync_schedules

object[]

required

A list of sync schedules for the connection.

data.times_used

integer | null

required

The number of times the connection has been used in a request to the Trackstar API. Equal to the number of API calls made with this connection.

data.webhooks_disabled

boolean | null

required

If True, create & update webhooks for Trackstar objects (e.g. order.created) will not be sent for this connection. Connection specific webhooks (e.g. connection.deleted) will still be sent.

next_token

string | null

See pagination for more details.

total_count

integer

The number of items returned.

API Documentation

Headers

Path Parameters

Response