Getting Started with Dodgeprint API

Welcome to the Dodgeprint API documentation! This guide will help you get started with integrating Dodgeprint's e-commerce automation platform into your applications.

What is Dodgeprint?

Dodgeprint is a powerful e-commerce integration platform that allows you to:

• 🚀 Deploy products to multiple marketplaces (Etsy, TikTok Shop, Amazon)
• 📦 Manage inventory across all platforms from one place
• 🎨 Automate product listings with templates
• 📊 Track orders and fulfillment
• 💰 Optimize pricing and advertising

Quick Start

1. Get Your API Credentials

Before you can use the API, you need:

• ✅ API Token (Bearer token)
• ✅ Workspace ID

→ Follow our Authentication Guide to get your credentials.

2. Make Your First API Call

Test your credentials with a simple request:

curl -X GET "https://api.dodgeprint.com/api/v1/user" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "X-Workspace-Id: YOUR_WORKSPACE_ID"

3. Deploy Your First Product

Ready to deploy? Follow our comprehensive guide:

→ Product Deployment Guide

---

API Basics

Base URL

Production: https://api.dodgeprint.com/api/v1
Development: https://api.dodgeprint.com/api/v1

Authentication

All requests require two headers:

Authorization: Bearer YOUR_TOKEN
X-Workspace-Id: YOUR_WORKSPACE_ID

Response Format

All responses follow this structure:

{
  "success": true,
  "data": { /* response data */ },
  "message": "Optional message"
}

Error Response:

{
  "success": false,
  "code": 400,
  "message": "Error description"
}

---

Common Use Cases

Deploying Products

Deploy products to Etsy, TikTok Shop, or Amazon with a single API call.

POST /deploy-product

→ View Complete Deployment Guide

Managing Inventory

Update prices and inventory across all platforms:

POST /deploy-product
{
  "type": "update_partial",
  ...
}

Bulk Operations

Deploy multiple products at once:

POST /deploy-product
{
  "selected": [1001, 1002, 1003],
  ...
}

---

Key Concepts

Workspaces

Workspaces are isolated environments for your data. Each API request operates within a specific workspace context using the X-Workspace-Id header.

Sites

Sites represent your connected e-commerce platform accounts (Etsy shops, TikTok Shop accounts, etc.).

# Filter by platform_id (1=Etsy, 4=TikTok, 5=Amazon, 6=Shopify)
GET /sites?platform_id=1

Products

Your product catalog in Dodgeprint. Products can be deployed to multiple sites.

GET /products

Variants

Product variations (size, color, etc.) with individual pricing and inventory.

GET /group-variants/{id}

Content Templates

Reusable product descriptions and content.

GET /contents

---

API Reference

Explore our complete API documentation:

→ API Reference - Auto-generated from OpenAPI specification

---

Guides & Tutorials

Guides

Step-by-step documentation for common tasks:

• 📖 Product Deployment Guide - Complete guide with platform-specific examples
• 📖 Authentication Guide - Get API access

Tutorials

Complete walkthroughs for beginners:

• 🎓 First Deployment Tutorial - Deploy your first product
• 🎓 Bulk Deployment (Coming soon)
• 🎓 Automation Workflows (Coming soon)

---

Rate Limits

Endpoint Type	Limit	Window
Read (GET)	1000 requests	per hour
Write (POST/PUT/DELETE)	500 requests	per hour
Deploy	100 deployments	per hour

Rate Limit Headers

Check response headers for rate limit info:

• X-RateLimit-Limit: Total allowed requests
• X-RateLimit-Remaining: Remaining requests
• X-RateLimit-Reset: Timestamp when limit resets

---

Error Handling

Common HTTP Status Codes

Code	Meaning	Action
200	Success	Request completed successfully
400	Bad Request	Check request parameters
401	Unauthorized	Invalid or expired token
403	Forbidden	Invalid workspace or permissions
404	Not Found	Resource doesn't exist
429	Too Many Requests	Rate limit exceeded, wait and retry
500	Server Error	Contact support

Error Response Example

{
  "success": false,
  "code": 400,
  "message": "Deploy to Shopify is not supported yet",
  "errors": {
    "platform": ["Platform must be one of: etsy, tiktok, amazon"]
  }
}

---

SDKs & Libraries

Official SDKs

Coming soon:

• JavaScript/TypeScript SDK
• Python SDK
• PHP SDK

Community SDKs

Want to build an SDK? We'd love to feature it here!

---

Support & Community

Need Help?

• 📧 Email: [email protected]
• 💬 Support Portal: https://app.dodgeprint.com/support
• 📖 Documentation: You're here!

Reporting Issues

Found a bug or have a feature request?

• Open a support ticket in the dashboard
• Email us with details and steps to reproduce

Status Page

Check API status and uptime:

• status.dodgeprint.com (Coming soon)

---

Next Steps

Now that you understand the basics, here's what to do next:

1. Get your API credentials - Set up authentication
2. Deploy your first product - Learn the deployment workflow
3. Explore API Reference - See all available endpoints

---

Ready to Start?

Jump right into our Product Deployment Guide to deploy your first product!

---

Last Updated: January 2025 API Version: 1.0.0