v1
latestOpenAPI 3.1.02026-07-22802,2441.7 MBIntegration Info
Information about the data provided by each integration.
get/integrations/{integration_type}
Path parameters
integration_type'wms' | 'freight' | 'cart' | 'carrier' | 'erp' required
The type of integration to filter by.
Query parameters
Filter integrations by name. Supports eq, neq, in, and nin (e.g. integration_name[in]=shipbob,packiyo).
{
"eq": "shipbob"
}actionsstring[]
A comma separated list of actions an integration must support to be included (e.g. get_orders,get_inventory).
Headers
x-trackstar-api-keystring required
Example:<x-trackstar-api-key>
Your organization-level Trackstar API key.
Response
Successful response
Example response
{
"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",
"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"
]
}
]
}