GET
/
integrations
/
{integration_type}
/
{integration_name}
curl --request GET \
  --url https://production.trackstarhq.com/integrations/{integration_type}/{integration_name} \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'
{
  "data": [
    {
      "integration_name": "shipbob",
      "display_name": "ShipBob",
      "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

​
x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

Path Parameters

​
integration_type
enum<string>
required

The type of integration to filter by.

Available options:
wms,
freight,
cart
Example:

""

​
integration_name
string
required

The name of the integration to filter by.

Example:

""

Response

200
application/json
Successful response

The response is of type object.