Request an Integration
curl --request POST \
--url https://production.trackstarhq.com/integration-requests \
--header 'Content-Type: application/json' \
--header 'x-trackstar-api-key: <x-trackstar-api-key>' \
--data '
{
"integration_type": "carrier",
"integration_name": "integration_name",
"flows": [
"read_orders",
"read_inventory"
],
"integration_contact_email": "integration_contact_email",
"brand_name": "brand_name",
"brand_contact_email": "brand_contact_email",
"api_docs_url": "api_docs_url",
"api_docs_via_email": true,
"prod_creds_url": "prod_creds_url",
"sandbox_creds_url": "sandbox_creds_url",
"notes": "notes"
}
'import requests
url = "https://production.trackstarhq.com/integration-requests"
payload = {
"integration_type": "carrier",
"integration_name": "integration_name",
"flows": ["read_orders", "read_inventory"],
"integration_contact_email": "integration_contact_email",
"brand_name": "brand_name",
"brand_contact_email": "brand_contact_email",
"api_docs_url": "api_docs_url",
"api_docs_via_email": True,
"prod_creds_url": "prod_creds_url",
"sandbox_creds_url": "sandbox_creds_url",
"notes": "notes"
}
headers = {
"x-trackstar-api-key": "<x-trackstar-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-trackstar-api-key': '<x-trackstar-api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
integration_type: 'carrier',
integration_name: 'integration_name',
flows: ['read_orders', 'read_inventory'],
integration_contact_email: 'integration_contact_email',
brand_name: 'brand_name',
brand_contact_email: 'brand_contact_email',
api_docs_url: 'api_docs_url',
api_docs_via_email: true,
prod_creds_url: 'prod_creds_url',
sandbox_creds_url: 'sandbox_creds_url',
notes: 'notes'
})
};
fetch('https://production.trackstarhq.com/integration-requests', 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/integration-requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'integration_type' => 'carrier',
'integration_name' => 'integration_name',
'flows' => [
'read_orders',
'read_inventory'
],
'integration_contact_email' => 'integration_contact_email',
'brand_name' => 'brand_name',
'brand_contact_email' => 'brand_contact_email',
'api_docs_url' => 'api_docs_url',
'api_docs_via_email' => true,
'prod_creds_url' => 'prod_creds_url',
'sandbox_creds_url' => 'sandbox_creds_url',
'notes' => 'notes'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://production.trackstarhq.com/integration-requests"
payload := strings.NewReader("{\n \"integration_type\": \"carrier\",\n \"integration_name\": \"integration_name\",\n \"flows\": [\n \"read_orders\",\n \"read_inventory\"\n ],\n \"integration_contact_email\": \"integration_contact_email\",\n \"brand_name\": \"brand_name\",\n \"brand_contact_email\": \"brand_contact_email\",\n \"api_docs_url\": \"api_docs_url\",\n \"api_docs_via_email\": true,\n \"prod_creds_url\": \"prod_creds_url\",\n \"sandbox_creds_url\": \"sandbox_creds_url\",\n \"notes\": \"notes\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-trackstar-api-key", "<x-trackstar-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://production.trackstarhq.com/integration-requests")
.header("x-trackstar-api-key", "<x-trackstar-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"integration_type\": \"carrier\",\n \"integration_name\": \"integration_name\",\n \"flows\": [\n \"read_orders\",\n \"read_inventory\"\n ],\n \"integration_contact_email\": \"integration_contact_email\",\n \"brand_name\": \"brand_name\",\n \"brand_contact_email\": \"brand_contact_email\",\n \"api_docs_url\": \"api_docs_url\",\n \"api_docs_via_email\": true,\n \"prod_creds_url\": \"prod_creds_url\",\n \"sandbox_creds_url\": \"sandbox_creds_url\",\n \"notes\": \"notes\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.trackstarhq.com/integration-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-trackstar-api-key"] = '<x-trackstar-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"integration_type\": \"carrier\",\n \"integration_name\": \"integration_name\",\n \"flows\": [\n \"read_orders\",\n \"read_inventory\"\n ],\n \"integration_contact_email\": \"integration_contact_email\",\n \"brand_name\": \"brand_name\",\n \"brand_contact_email\": \"brand_contact_email\",\n \"api_docs_url\": \"api_docs_url\",\n \"api_docs_via_email\": true,\n \"prod_creds_url\": \"prod_creds_url\",\n \"sandbox_creds_url\": \"sandbox_creds_url\",\n \"notes\": \"notes\"\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"error": "<string>",
"detail": {
"<location>": {
"<field_name>": [
"<string>"
]
}
}
}Admin API Reference
Request an Integration
Ask us to build an integration we don’t support yet. We open a ticket and follow up with you.
POST
/
integration-requests
Request an Integration
curl --request POST \
--url https://production.trackstarhq.com/integration-requests \
--header 'Content-Type: application/json' \
--header 'x-trackstar-api-key: <x-trackstar-api-key>' \
--data '
{
"integration_type": "carrier",
"integration_name": "integration_name",
"flows": [
"read_orders",
"read_inventory"
],
"integration_contact_email": "integration_contact_email",
"brand_name": "brand_name",
"brand_contact_email": "brand_contact_email",
"api_docs_url": "api_docs_url",
"api_docs_via_email": true,
"prod_creds_url": "prod_creds_url",
"sandbox_creds_url": "sandbox_creds_url",
"notes": "notes"
}
'import requests
url = "https://production.trackstarhq.com/integration-requests"
payload = {
"integration_type": "carrier",
"integration_name": "integration_name",
"flows": ["read_orders", "read_inventory"],
"integration_contact_email": "integration_contact_email",
"brand_name": "brand_name",
"brand_contact_email": "brand_contact_email",
"api_docs_url": "api_docs_url",
"api_docs_via_email": True,
"prod_creds_url": "prod_creds_url",
"sandbox_creds_url": "sandbox_creds_url",
"notes": "notes"
}
headers = {
"x-trackstar-api-key": "<x-trackstar-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-trackstar-api-key': '<x-trackstar-api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
integration_type: 'carrier',
integration_name: 'integration_name',
flows: ['read_orders', 'read_inventory'],
integration_contact_email: 'integration_contact_email',
brand_name: 'brand_name',
brand_contact_email: 'brand_contact_email',
api_docs_url: 'api_docs_url',
api_docs_via_email: true,
prod_creds_url: 'prod_creds_url',
sandbox_creds_url: 'sandbox_creds_url',
notes: 'notes'
})
};
fetch('https://production.trackstarhq.com/integration-requests', 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/integration-requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'integration_type' => 'carrier',
'integration_name' => 'integration_name',
'flows' => [
'read_orders',
'read_inventory'
],
'integration_contact_email' => 'integration_contact_email',
'brand_name' => 'brand_name',
'brand_contact_email' => 'brand_contact_email',
'api_docs_url' => 'api_docs_url',
'api_docs_via_email' => true,
'prod_creds_url' => 'prod_creds_url',
'sandbox_creds_url' => 'sandbox_creds_url',
'notes' => 'notes'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://production.trackstarhq.com/integration-requests"
payload := strings.NewReader("{\n \"integration_type\": \"carrier\",\n \"integration_name\": \"integration_name\",\n \"flows\": [\n \"read_orders\",\n \"read_inventory\"\n ],\n \"integration_contact_email\": \"integration_contact_email\",\n \"brand_name\": \"brand_name\",\n \"brand_contact_email\": \"brand_contact_email\",\n \"api_docs_url\": \"api_docs_url\",\n \"api_docs_via_email\": true,\n \"prod_creds_url\": \"prod_creds_url\",\n \"sandbox_creds_url\": \"sandbox_creds_url\",\n \"notes\": \"notes\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-trackstar-api-key", "<x-trackstar-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://production.trackstarhq.com/integration-requests")
.header("x-trackstar-api-key", "<x-trackstar-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"integration_type\": \"carrier\",\n \"integration_name\": \"integration_name\",\n \"flows\": [\n \"read_orders\",\n \"read_inventory\"\n ],\n \"integration_contact_email\": \"integration_contact_email\",\n \"brand_name\": \"brand_name\",\n \"brand_contact_email\": \"brand_contact_email\",\n \"api_docs_url\": \"api_docs_url\",\n \"api_docs_via_email\": true,\n \"prod_creds_url\": \"prod_creds_url\",\n \"sandbox_creds_url\": \"sandbox_creds_url\",\n \"notes\": \"notes\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.trackstarhq.com/integration-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-trackstar-api-key"] = '<x-trackstar-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"integration_type\": \"carrier\",\n \"integration_name\": \"integration_name\",\n \"flows\": [\n \"read_orders\",\n \"read_inventory\"\n ],\n \"integration_contact_email\": \"integration_contact_email\",\n \"brand_name\": \"brand_name\",\n \"brand_contact_email\": \"brand_contact_email\",\n \"api_docs_url\": \"api_docs_url\",\n \"api_docs_via_email\": true,\n \"prod_creds_url\": \"prod_creds_url\",\n \"sandbox_creds_url\": \"sandbox_creds_url\",\n \"notes\": \"notes\"\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"error": "<string>",
"detail": {
"<location>": {
"<field_name>": [
"<string>"
]
}
}
}Headers
Your organization-level Trackstar API key.
Example:
"<x-trackstar-api-key>"
Body
application/json
Available options:
wms, cart, carrier Example:
"carrier"
Example:
"integration_name"
The flows you need from this integration. For wms, one of: read_inventory, read_products, read_orders, read_inbounds, read_returns, read_warehouses, create_order, cancel_order, create_product, create_inbound, create_return. For cart and carrier, the action names that type supports. Pass "not_sure" if you do not know yet, and we will follow up. Call GET /integration-requests/flows for the current list.
Minimum array length:
1Example:
["read_orders", "read_inventory"]
Example:
"integration_contact_email"
Example:
"brand_name"
Example:
"brand_contact_email"
Example:
"api_docs_url"
Example:
true
Example:
"prod_creds_url"
Example:
"sandbox_creds_url"
Example:
"notes"
Response
Successful response
Example:
true