Skip to main content
GET
/
integrations
/
{integration_type}
/
{integration_name}
Integration Info for Single Integration
curl --request GET \
  --url https://production.trackstarhq.com/integrations/{integration_type}/{integration_name} \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'
import requests

url = "https://production.trackstarhq.com/integrations/{integration_type}/{integration_name}"

headers = {"x-trackstar-api-key": "<x-trackstar-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-trackstar-api-key': '<x-trackstar-api-key>'}};

fetch('https://production.trackstarhq.com/integrations/{integration_type}/{integration_name}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://production.trackstarhq.com/integrations/{integration_type}/{integration_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-trackstar-api-key: <x-trackstar-api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://production.trackstarhq.com/integrations/{integration_type}/{integration_name}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-trackstar-api-key", "<x-trackstar-api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://production.trackstarhq.com/integrations/{integration_type}/{integration_name}")
.header("x-trackstar-api-key", "<x-trackstar-api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://production.trackstarhq.com/integrations/{integration_type}/{integration_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-trackstar-api-key"] = '<x-trackstar-api-key>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "integration_name": "shipbob",
      "display_name": "ShipBob",
      "install_method": "input",
      "description": "description",
      "logo_url": "https://example.com/logo.png",
      "installation_guide_url": "https://trackstar.notion.site",
      "docs": "<unknown>",
      "write_operations": [
        {
          "action": "create_order",
          "url": "POST /wms/orders",
          "required_base_schema_fields": [
            "line_items.product_id",
            "line_items.quantity"
          ],
          "optional_base_schema_fields": [
            "order_number",
            "line_items",
            "trading_partner"
          ],
          "integration_specific_fields": {
            "properties": {
              "warehouse_id": {
                "title": "warehouse_id",
                "type": "string",
                "description": "The warehouse this order was shipped from.",
                "example": "",
                "enum": [
                  "N/A - Connect an account to see options"
                ]
              }
            },
            "type": "object",
            "required_fields": [
              "warehouse_id"
            ]
          }
        }
      ],
      "list_operations": [
        {
          "action": "get_inventory",
          "url": "GET /wms/inventory",
          "implemented_fields": {
            "onhand": true,
            "lots": [
              {
                "lot_id": true,
                "expiration_date": true,
                "onhand": true,
                "warehouse_id": true
              }
            ],
            "substitute_skus": false,
            "inventory_by_warehouse_id": {
              "key": {
                "committed": true,
                "fulfillable": true,
                "onhand": true,
                "awaiting": true,
                "unfulfillable": true,
                "sellable": true
              }
            },
            "sellable": true,
            "created_date": true,
            "fulfillable": true,
            "trackstar_created_date": true,
            "awaiting": true,
            "name": true,
            "locations": [
              {
                "location_id": true,
                "quantity": true,
                "warehouse_id": true
              }
            ],
            "active": true,
            "committed": true,
            "measurements": false,
            "unfulfillable": true,
            "warehouse_customer_id": true,
            "trackstar_updated_date": true,
            "id": true,
            "connection_id": true,
            "external_system_url": false,
            "sku": true,
            "updated_date": true
          }
        }
      ],
      "available_actions": [
        "create_order",
        "get_inventory"
      ]
    }
  ]
}
{
"error": "<string>",
"id": "<string>"
}
{
"error": "<string>",
"detail": {
"<location>": {
"<field_name>": [
"<string>"
]
}
}
}

Headers

x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

x-trackstar-access-token
string

Optional. Pass this in to get connection-specific field information. Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Example:

"<x-trackstar-access-token>"

Path Parameters

integration_type
enum<string>
required

The type of integration to filter by.

Available options:
wms,
freight,
cart,
carrier,
erp
integration_name
string
required

The name of the integration to filter by.

Response

Successful response

data
IntegrationInfo · object[]
required

Integration Info