Developer Documentation - Transipal

Authentication

Personal Access Token

Generate a token from your account and include it in the Authorization header of every request. No login flow, no refresh — just one token for all your integrations.

How to get one:

Log in, then go to Account → Personal Tokens
Choose a name and a scope (read or write)
Copy the token — it is shown only once

Usage

curl -H "Authorization: Bearer tp_your_token" \
  "https://{warehouse}.staging.transipal.com/api/missions"

Tokens are prefixed with tp_ and can be revoked instantly from your account.

Token Scopes

read Read-only

Access all data in read-only mode. Can also trigger export creation. This is the recommended scope for AI agents and dashboards.

write Read & Write

Full access — create, update, and delete resources. Use for automation that needs to modify data.

Always use the most restrictive scope possible. A read token cannot modify your data even if compromised.

Interaction Methods

REST API

Swagger UI

A standard REST API for programmatic access. JSON responses, pagination, filtering.

Key endpoints:

GET	`/api/warehouses`	List your warehouses
GET	`/api/missions`	List missions
GET	`/api/tasks`	List tasks
GET	`/api/packs`	List packs
GET	`/api/products`	Search products

Warehouse context:

API requests are scoped via subdomains. Call /api/warehouses to discover yours, then use:

https://{subdomain}.staging.transipal.com/api/...

Example

# List your warehouses
curl -H "Authorization: Bearer tp_..." \
  "https://developer.staging.transipal.com/api/warehouses"

# Get missions for a warehouse
curl -H "Authorization: Bearer tp_..." \
  "https://{warehouse}.staging.transipal.com/api/missions"

Full endpoint documentation in Swagger UI.

MCP Server (AI Agents)

New

Transipal exposes an MCP (Model Context Protocol) server. Connect AI assistants and query your warehouse data using natural language.

Claude Desktop

Open Settings → Integrations
Click Add
Enter the URL: https://app.staging.transipal.com/_mcp
Click Connect — authorize with your Transipal account

ChatGPT

Open Settings → Connectors
Click Add connector
Enter the URL: https://app.staging.transipal.com/_mcp
Click Connect — authorize with your Transipal account

What AI agents can do:

List and search missions, tasks, packs, products
Filter by date, status, organization, location
View warehouse statistics and inventory audits
Switch between warehouses

For developers: you can also connect using a Personal Access Token in the Authorization header. See the MCP specification for details.

No token to manage — sign in with your Transipal account. Same permissions as your account.

Reference

Rate Limiting

Limit	200 requests / minute / user
Pagination	30 items/page (max 100)

Response headers:

`X-RateLimit-Limit`	Maximum requests (200)
`X-RateLimit-Remaining`	Remaining in window
`X-RateLimit-Reset`	Reset timestamp

Error Codes

Code	Meaning	Action
400	Bad Request	Check request body
401	Unauthorized	Check token
403	Forbidden	Insufficient scope
404	Not Found	Check URL / resource ID
429	Rate Limited	Wait and retry

Code Examples

TOKEN="tp_your_token"
WAREHOUSE="{warehouse}"

# List warehouses
curl -H "Authorization: Bearer $TOKEN" \
  "https://developer.staging.transipal.com/api/warehouses"

# List missions (paginated)
curl -H "Authorization: Bearer $TOKEN" \
  "https://$WAREHOUSE.staging.transipal.com/api/missions?page=1&itemsPerPage=10"

# Search products
curl -H "Authorization: Bearer $TOKEN" \
  "https://$WAREHOUSE.staging.transipal.com/api/products?name=widget"

const TOKEN = 'tp_your_token';

async function api(path, warehouse = null) {
  const host = warehouse
    ? `${warehouse}.staging.transipal.com`
    : 'developer.staging.transipal.com';

  const res = await fetch(`https://${host}${path}`, {
    headers: { 'Authorization': `Bearer ${TOKEN}` }
  });

  if (!res.ok) throw new Error(`HTTP ${res.status}`);
  return res.json();
}

// List warehouses
const warehouses = await api('/api/warehouses');

// Get missions for a specific warehouse
const missions = await api(
  '/api/missions',
  '{warehouse}'
);

import requests

TOKEN = "tp_your_token"

def api(path, warehouse=None):
    host = f"{warehouse}.staging.transipal.com" if warehouse else "developer.staging.transipal.com"
    r = requests.get(
        f"https://{host}{path}",
        headers={"Authorization": f"Bearer {TOKEN}"}
    )
    r.raise_for_status()
    return r.json()

# List warehouses
warehouses = api("/api/warehouses")

# Get missions
missions = api(
    "/api/missions",
    "{warehouse}"
)

Interactive API Documentation

Explore all endpoints, test requests live, and see response schemas in Swagger UI.

Open Swagger UI

Transipal Developer Documentation