Documentation — Pixel Wrangler Shopify Product Customizer

Getting Started

1. Install Pixel Wrangler

Install Pixel Wrangler from the Shopify App Store. The app embeds directly into your Shopify admin — no separate login needed. Start with a 14-day free trial on any plan.

2. Create a Template

Templates define what customers can customise. Open the template builder from the Pixel Wrangler dashboard and configure:

• Canvas dimensions and base product image (the mockup your customers see)
• Image placeholders — drag-and-drop zones where customers upload photos
• Text elements — editable text slots with font, colour, and size options
• Stickers, backgrounds, and masks — decorative assets customers can apply
• Output settings — PNG or PDF, file naming, and dimensions for print-ready files

Templates support multiple sides (front, back, sleeves) with independent layer systems for each.

3. Link to a Product

Assign your template to one or more Shopify products. A "Customise" button will appear on the product page via the Pixel Wrangler theme app extension. Customers click it to open the customisation modal with your template.

4. Enable AI Tools (Optional)

To enable Wrangler AI features (background removal, image generation, graphic text), purchase AI credit packs from your dashboard. Then toggle AI features on per-template in the template settings. Customers will see AI tool options alongside the standard customisation controls.

API Reference

The Wrangler AI API provides background removal and image generation via a RESTful interface. All requests require an API key passed in the X-API-Key header.

Base URL: https://pixel-wranglers.up.railway.app/api/v1/core

Authentication

Get your API key from your Account page. Include it in every request as an X-API-Key header. Keys are scoped with fine-grained permissions.

Endpoints

POST /api/v1/core/remove-background-async

Submit an image for async background removal (recommended). Send multipart form data with a file field. Returns a job_id for polling. Costs 1 credit per image.

Request: Multipart form data with file field

Response: {"job_id": "string", "status": "pending"}

POST /api/v1/core/generate-image

Generate images, stylised text, and style-transfer outputs with OpenAI. Send a JSON body with prompt, optional generation_quality, and optional reference_image_urls. Synchronous — returns the generated image URL directly.

Request: JSON body with prompt, optional generation_quality, optional reference_image_urls

Response: {"output_url": "https://cdn.example.com/generated/123.png", "credits_used": 3}

Credits: Low quality uses 3 credits, high quality uses 25 credits. Server cutout adds 1 extra credit.

GET /api/v1/core/jobs/{job_id}

Check the status of a background removal job. Returns pending, processing, completed, or failed. Free — no credits charged.

GET /api/v1/core/jobs/{job_id}/result

Get the processed image result. Returns the output URL hosted on S3. Free — no credits charged.

Response: {"result": {"url": "https://pixel-wranglers-assets.s3.amazonaws.com/jobs/123/output.png"}}

For full code examples in cURL, Python, Node.js, and JavaScript, visit the interactive API documentation.

Rate Limits & Supported Formats

• API Requests: 100 requests per minute
• Concurrent Jobs: 10 simultaneous processing jobs
• File Size: Maximum 10 MB per image
• Supported Formats: JPG, PNG, WebP
• Processing Time: Average 3-5 seconds per image

Error Codes

• 401 Unauthorized — Invalid or missing API key
• 402 Payment Required — Insufficient credits
• 413 Payload Too Large — File exceeds 10 MB limit
• 429 Too Many Requests — Rate limit exceeded
• 500 Internal Server Error — Server error — please retry

Credits & Billing

Wrangler AI uses a prepaid credit system. Purchase credit packs, then consume credits as you use AI features. Credits are shared across all AI actions and never expire.

Credit Costs Per Action

• Background Removal: 1 credit per image
• Image Generation: 3 credits (standard quality)
• Graphic Text Generation: 3 credits per generation

Credit Packs

• Starter: $29 for 500 credits ($0.058/credit)
• Studio: $79 for 2,000 credits ($0.040/credit)
• Pro: $179 for 6,000 credits ($0.030/credit)

Auto Top-Up

Set a threshold and top-up amount in your dashboard so your store never runs out of credits mid-session. When your balance drops below the threshold, credits are automatically purchased.

Checking Your Balance

Your credit balance is visible in the Pixel Wrangler dashboard and via the API at GET /api/v1/billing/credit-balance with your API key.

Print-Ready File Delivery

When a customer completes a purchase, Pixel Wrangler automatically generates print-ready artwork files. No manual image preparation needed.

How It Works

1. Customer completes checkout and the order is paid
2. Shopify sends an orders/paid webhook to Pixel Wrangler
3. A render job is queued and processed by the render pipeline
4. Print-ready PNG or PDF files are generated at full resolution
5. Files are uploaded to S3 and the order is tagged with metafields for your fulfilment system

Output Formats

Configure output format per template — PNG for web/digital use, PDF for professional print. Set custom file dimensions and naming conventions in the template output settings.

3PL Integration

Render files are delivered via S3 with pre-signed URLs. Order metafields include file URLs and render status, making it easy to connect with your 3PL, print partner, or fulfilment system. Growth and Scale plans include direct 3PL fulfilment integrations.

Monitoring Render Jobs

View all render jobs in the Pixel Wrangler dashboard with status tracking (pending, processing, completed, failed). Preview generated files, download outputs, and retry failed jobs with one click.