Get Connections

GET

connections

curl --request GET \
  --url https://production.trackstarhq.com/connections \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'

{
  "data": [
    {
      "connection_id": "07b344db-0304-4866-9ae1-ac8af5292a28",
      "integration_name": "integration_name",
      "customer_id": "customer_id",
      "created_at": "2023-01-01T00:00:00Z",
      "last_used": "2023-01-01T00:00:00Z",
      "times_used": 1,
      "latest_sync": "2023-01-01T00:00:00Z",
      "sync_schedules": [
        {
          "function_name": "get_inventory",
          "latest_sync": "2023-01-01T00:00:00Z",
          "sync_frequency": 3600,
          "in_progress": false
        }
      ],
      "errors": [
        {
          "error_message": "error_message",
          "affected_endpoints": [
            {
              "endpoint": "GET /connection",
              "preventing_sync": false
            }
          ],
          "first_seen": "2023-01-01T00:00:00Z",
          "last_seen": "2023-01-01T00:00:00Z"
        }
      ],
      "available_actions": [
        "get_inventory",
        "get_products"
      ],
      "available_endpoints": [
        "get_inventory",
        "get_products"
      ],
      "integration_type": "wms",
      "webhooks_disabled": false
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}

Headers

x-trackstar-api-key

string

required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

Query Parameters

page_token

string | null

The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.

Example:

"page_token"

Response

200

application/json

Successful response

data

object[]

A list of connections for your organization.

data.connection_id

string

required

The unique ID of the connection.

Example:

""

data.integration_name

string

required

The name of the integration associated with the connection.

Example:

""

data.customer_id

string | null

required

An identifier for your end customer.

Example:

"customer_id"

data.created_at

string

required

The date the connection was created.

Example:

"2022-01-01T00:00:00Z"

data.last_used

string | null

required

The date the connection was last updated.

Example:

"2022-01-02T05:05:05Z"

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.

Example:

0

data.latest_sync

string | null

required

DEPRECATED: Use sync_schedules instead.

Example:

""

data.sync_schedules

object[]

required

A list of sync schedules for the connection.

data.errors

object[]

required

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

data.errors.error_message

string

required

The error message.

Example:

""

data.errors.affected_endpoints

object[]

required

A list of endpoints that were affected by the error and whether the error is preventing the sync from completing.

Example:

[
  {
    "endpoint": "GET /wms/inventory",
    "preventing_sync": true
  },
  {
    "endpoint": "GET /wms/orders",
    "preventing_sync": false
  }
]

data.errors.first_seen

string

required

The date the error was first seen.

Example:

""

data.errors.last_seen

string

required

The date the error was last seen.

Example:

""

data.available_actions

string[]

required

A list of actions that the integration supports.

Action supported by the integration

data.available_endpoints

string[]

required

DEPRECATED: Use available_actions instead.

Endpoint supported by the integration

data.integration_type

enum<string>

required

The type of the integration.

Available options:

wms,

freight,

cart

Example:

"wms"

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.

Example:

false

Example:

[
  {
    "connection_id": "07b344db-0304-4866-9ae1-ac8af5292a28",
    "integration_name": "integration_name",
    "customer_id": "customer_id",
    "created_at": "2023-01-01T00:00:00Z",
    "last_used": "2023-01-01T00:00:00Z",
    "times_used": 1,
    "latest_sync": "2023-01-01T00:00:00Z",
    "sync_schedules": [
      {
        "function_name": "get_inventory",
        "latest_sync": "2023-01-01T00:00:00Z",
        "sync_frequency": 3600,
        "in_progress": false
      }
    ],
    "errors": [
      {
        "error_message": "error_message",
        "affected_endpoints": [
          {
            "endpoint": "GET /connection",
            "preventing_sync": false
          }
        ],
        "first_seen": "2023-01-01T00:00:00Z",
        "last_seen": "2023-01-01T00:00:00Z"
      }
    ],
    "available_actions": ["get_inventory", "get_products"],
    "available_endpoints": ["get_inventory", "get_products"],
    "integration_type": "wms",
    "webhooks_disabled": false
  }
]

next_token

string | null

See pagination for more details.

Example:

"next_token"

total_count

integer

The number of items returned.

Example:

1

Exchange Auth Code Get Connection

curl --request GET \
  --url https://production.trackstarhq.com/connections \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'

{
  "data": [
    {
      "connection_id": "07b344db-0304-4866-9ae1-ac8af5292a28",
      "integration_name": "integration_name",
      "customer_id": "customer_id",
      "created_at": "2023-01-01T00:00:00Z",
      "last_used": "2023-01-01T00:00:00Z",
      "times_used": 1,
      "latest_sync": "2023-01-01T00:00:00Z",
      "sync_schedules": [
        {
          "function_name": "get_inventory",
          "latest_sync": "2023-01-01T00:00:00Z",
          "sync_frequency": 3600,
          "in_progress": false
        }
      ],
      "errors": [
        {
          "error_message": "error_message",
          "affected_endpoints": [
            {
              "endpoint": "GET /connection",
              "preventing_sync": false
            }
          ],
          "first_seen": "2023-01-01T00:00:00Z",
          "last_seen": "2023-01-01T00:00:00Z"
        }
      ],
      "available_actions": [
        "get_inventory",
        "get_products"
      ],
      "available_endpoints": [
        "get_inventory",
        "get_products"
      ],
      "integration_type": "wms",
      "webhooks_disabled": false
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}

Management

Sandbox

Headers

Query Parameters

Response