API Reference

Built for Engineers. Designed for Scale.

RESTful API with predictable resource-oriented URLs, JSON responses, and standard HTTP response codes.

Base URL

https://api.tallyhubgh.com/v3

Authentication

Authenticate requests using Bearer tokens in the Authorization header.

Header

Authorization: Bearer YOUR_API_KEY

Products

GET/products

Retrieve a list of all products with pagination.

RequestGET

curl -X GET "https://api.tallyhubgh.com/v3/products?limit=20&offset=0" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response200 OK

{
  "data": [
    {
      "id": "prod_abc123",
      "name": "iPhone 15 Pro",
      "sku": "APL-IP15-PRO",
      "price": 999.00,
      "stock": 150
    }
  ],
  "pagination": {
    "total": 1234,
    "limit": 20,
    "offset": 0
  }
}

Query Parameters

Parameter	Type	Required	Description
limit	integer	Optional	Max items per page (default: 20, max: 100)
offset	integer	Optional	Number of items to skip
category	string	Optional	Filter by category ID

POST/products

Create a new product in your inventory.

Request BodyPOST

{
  "name": "MacBook Air M3",
  "sku": "APL-MBA-M3",
  "price": 1299.00,
  "cost_price": 1100.00,
  "stock": 50,
  "category_id": "cat_electronics"
}

Orders

GET/orders

Retrieve all orders with optional filters.

Response200 OK

{
  "data": [
    {
      "id": "ord_xyz789",
      "status": "completed",
      "total": 1298.00,
      "items_count": 3,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Rate Limits

Rate Limit Headers

Check response headers for your current rate limit status.

Plan	Requests/min	Burst
Starter	60	100
Professional	300	500
Enterprise	1000	2000

Need Help?

Our developer support team is here to help.

Contact Support