Skip to content

introduction.mdx

Latest commit

 

History

History
137 lines (123 loc) · 3.88 KB

introduction.mdx

File metadata and controls

137 lines (123 loc) · 3.88 KB
Raw
title Introduction
description Welcome to the Price Tag API - A comprehensive solution for creating and managing professional price tags

Hero Light Hero Dark

What is Price Tag API?

The Price Tag API is a powerful REST API that provides everything you need to create, manage, and generate professional price tags with PDF export capabilities. Built for developers, retailers, and businesses who need automated price tag generation.

Key Features

Complete price tag management with filtering, pagination, and bulk operations High-quality PDF export with customizable themes and layouts Professional designs including gradient themes, minimalist styles, and sale tags Process hundreds of price tags efficiently with bulk create and update operations

Quick Start

Get started with the Price Tag API in just a few steps:

Verify the API is running with a simple health check ```bash curl https://your-domain.com/api/health ``` Create a price tag with a simple POST request ```bash curl -X POST https://your-domain.com/api/price-tags \ -H "Content-Type: application/json" \ -d '{"data": "Premium Coffee", "price": 1200}' ``` Generate a professional PDF from your price tags ```bash curl -X POST https://your-domain.com/api/generate-pdf-v2 \ -H "Content-Type: application/json" \ -d '{"items": [{"id": 1, "data": "Premium Coffee", "price": 1200}]}' ```

API Endpoints Overview

Method Endpoint Description
GET /api/health API health status
GET /api/price-tags List all price tags
POST /api/price-tags Create price tag(s)
GET /api/price-tags/{id} Get specific price tag
PUT /api/price-tags/{id} Update price tag
DELETE /api/price-tags/{id} Delete price tag
POST /api/generate-pdf-v2 Generate PDF
POST /api/generate-html Generate HTML preview

Use Cases

Perfect for retail stores that need to generate price tags for products with different designs, discounts, and bulk pricing tiers. Integrate with your e-commerce platform to automatically generate price tags for printed catalogs or in-store displays. Create price tags for merchandise, food items, or services at events with custom branding and themes. Generate price tags as part of your inventory management workflow with barcode integration and bulk operations.

Next Steps

Get up and running in 5 minutes Explore all available endpoints See practical implementation examples