Tactill API v0 (latest)

The Tactill API is built on HTTP and is RESTful. It has predictable resource URLs and returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. Use your favorite HTTP/REST library in your programming language when using this API, or use the Tactill TypeScript SDK for seamless integration.

Most actions in the Tactill Backoffice are supported by an API which is documented and available for use, so that you may automate any necessary workflows or processes. This API reference documentation contains the most commonly integrated resources.

This topic describes the authentication method available in the Tactill API.

Tactill uses API keys for authentication. Each API key is scoped to a single organization and grants the permissions configured at issue time.

To authenticate your requests, send your API key in the X-Api-Key header on every call:

X-Api-Key: v5_<your-api-key>

API keys are prefixed with v5_. Keep them secret — never embed them in client-side code or commit them to source control. If a key is compromised, revoke it from the Tactill Backoffice and issue a new one.

Tactill follows the error response format.

{
  status_code: number,
  error: string,
  message: string
}

As with any API responses, your client must be prepared to gracefully handle additional members of the response.

All error responses include structured information to help you understand and resolve issues quickly.

Tactill enforces rate limits on the API to ensure optimal performance and fair usage across all partners. Rate limits are applied per organization and are designed to accommodate typical business operations. In sandbox environment, rate limits are enforced for non-GET endpoints and are set at 3000 requests per 10 minutes. You can find the exact number of consumed requests in the X-RateLimit-Limit and X-RateLimit-Remaining headers in the response. If the rate limit is exceeded, the API returns a 429 Too Many Requests response and a X-RateLimit-Retry-After header that includes a UTC timestamp of when the rate limit resets.

All resources support test and production modes. The mode is bound to your API key — it is not a request-body parameter.

• A key issued in test mode reads and writes test data only; production data is invisible to it.
• A key issued in production mode reads and writes production data only; test data is invisible to it.

To switch environments, use a different API key. Reach out to support to provision a test key alongside your production key.

Responses include test: true or test: false on each resource so you can confirm which environment the data belongs to.

1. Business validation - Respect the constraints of each resource
2. Traceability - Maintain history for audit and accounting purposes
3. Consistency - Maintain uniform naming conventions
4. Performance - Limit API calls and use pagination
5. Security - Protect sensitive data according to GDPR

All APIs follow consistent conventions:

• Dates: ISO 8601 format (2024-01-01T10:00:00Z)
• Amounts: In cents (1200 = €12.00)
• IDs: UUIDs or system identifiers
• Pagination: Token-based with next_token

Tactill provides a TypeScript SDK to help interact with the Tactill API. However, no SDK is required to use the API. All TypeScript SDK code examples are included in the SDK's reference documentation on NPM.

For developers who prefer using Postman for API testing and exploration, we provide a comprehensive Postman collection that includes all available endpoints with example requests and responses.

The collection contains pre-configured requests for all API operations, making it easy to get started with the Tactill API without writing code. You can import the collection directly into Postman and begin testing endpoints immediately.

Download the Postman collection: Tactill API Postman Collection

The full Tactill API provides comprehensive access to manage your business operations. This includes managing products, customers, orders, inventory, and much more. If you would like to implement a particular use case, contact us for guidance and feedback on the best API operations to use for the task.

To integrate Tactill and become a partner, reach out to us at hello@tactill.com.

Products are the individual items sold in your cash register system. Each product belongs to a category, has an associated tax system, and can be customized with options, tags, and custom fields. This resource is the core of your sales catalog.

Warning: Products belong to either the test or production environment based on the API key used to create them — they are not visible across modes. A product must have an associated category and tax rate when created.

1. Consistent pricing: Always define a buy_price (purchase price) and a sell_price (selling price) to correctly calculate your margins.

2. Categorization: Organize your products in logical categories to facilitate navigation and reporting.

3. Barcodes and references: Use unique barcodes and clear internal references for inventory management.

4. Custom fields: Store business-specific information (allergens, origin, brand, etc.) in custom fields.

5. Smart tags: Use tags for cross-cutting groupings (organic, seasonal, promotion, etc.).

6. Variations: For products with variants (size, color), use the variation system for centralized management.

7. Optimized images: Store image URLs on a CDN for better cash register performance.

Discounts allow you to apply commercial reductions to your sales. They can be percentage-based or fixed amounts and are used for promotions, loyalty programs, or commercial gestures. Discounts are referenced in sales for commercial performance tracking.

Warning: Discounts belong to either the test or production environment based on the API key used to create them — they are not visible across modes. For percentage discounts, the rate must be between 0 and 100. For numeric discounts, the amount is in cents.

1. Appropriate types: Use PERCENTAGE for proportional discounts (e.g. 10%) and NUMERIC for fixed amounts (e.g. €5).

2. Explicit naming: Choose clear names that indicate the nature of the discount ("Black Friday 20%", "Loyalty €5").

3. Rate validation: For PERCENTAGE discounts, verify that the rate remains between 0 and 100.

4. Seasonal discounts: Create specific discounts for your commercial campaigns with dated names.

5. Performance tracking: Regularly analyze your discount usage through statistics to optimize your strategies.

6. Rights management: Control access to discounts according to user profiles to prevent abuse.

7. Archiving: Maintain a history of your discounts even when expired for accounting and commercial tracking.

Customers represent your customer base in the cash register system. They enable management of named sales, loyalty, customer accounts, and commercial tracking. Customers belong to a company and can have accounts with balances.

Warning: Customers belong to either the test or production environment based on the API key used to create them — they are not visible across modes. A customer can be created without email or phone, but at least one contact method is recommended for customer relations.

1. Complete data: Fill in as much information as possible (name, email, phone, address) for better customer relations.

2. GDPR management: Comply with personal data regulations and only store necessary information.

3. Customer accounts: Use the customer account system for deferred billing and installment payments.

4. Loyalty cards: Assign unique loyalty card numbers for your loyalty programs.

5. Segmentation: Use custom fields to segment your clientele (VIP, professional, individual).

6. Standardized addresses: Follow standard address formats with valid postal codes for deliveries.

7. Duplicate merging: Regularly check for duplicates on email/phone to maintain a clean database.

8. Useful notes: Use the note field to store important information about customer preferences.