Management
Integration Info
API Documentation
- Management
- Sandbox
- Inventory
- Products
- Orders
- Inbound Shipments
- Shipping Methods
- Returns
- Billing
- Warehouses
- Warehouse Customers
Management
Integration Info
Information about the data provided by each integration.
GET
/
integrations
/
{integration_type}
curl --request GET \
--url https://production.trackstarhq.com/integrations/{integration_type} \
--header 'x-trackstar-api-key: <x-trackstar-api-key>'{
"data": [
{
"integration_name": "integration_name",
"install_method": "input",
"description": "description",
"logo_url": "https://example.com/logo.png",
"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",
"channel",
"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,
"unsellable": 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,
"unsellable": 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"
]
}
]
}Headers
Your organization-level Trackstar API key.
Example:
"<x-trackstar-api-key>"
Path Parameters
The type of integration to filter by.
Available options:
wms, freight, cart Example:
""
Response
200
application/json
Successful response
Integration Info
The name of the integration.
Example:
"integration_name"
How users install the integration within the Trackstar Modal.
Available options:
input, oauth Example:
"input"
A description of the integration.
Example:
"description"
The URL of the integration's logo.
Example:
"https://example.com/logo.png"
The write operations supported by the integration.
The action that can be performed.
Example:
"create_order"
The URL for the action.
Example:
"POST /wms/orders"
The required fields for the action.
Field required for the action.
Example:
[
"line_items.product_id",
"line_items.quantity"
]
The optional fields for the action.
Field optional for the action.
Example:
[
"order_number",
"line_items",
"channel",
"trading_partner"
]
The integration specific fields and their definitions.
Example:
{
"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"]
}
}
The type of the integration specific fields.
Example:
"object"
The required fields for the integration specific fields.
Field required for the integration specific fields.
Example:
["warehouse_id"]
The list operations supported by the integration.
The action that can be performed.
Example:
"get_inventory"
The URL for the action.
Example:
"GET /wms/inventory"
The fields that are implemented for the action.
A Boolean indicating if the field is implemented, or an object or list with more details.
Example:
{
"onhand": true,
"unsellable": 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,
"unsellable": 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
}
The actions supported by the integration.
Action supported by the integration
Example:
["create_order", "get_inventory"]
curl --request GET \
--url https://production.trackstarhq.com/integrations/{integration_type} \
--header 'x-trackstar-api-key: <x-trackstar-api-key>'{
"data": [
{
"integration_name": "integration_name",
"install_method": "input",
"description": "description",
"logo_url": "https://example.com/logo.png",
"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",
"channel",
"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,
"unsellable": 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,
"unsellable": 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"
]
}
]
}