Skip to content
Contact us
  • There are no suggestions because the search field is empty.

Getting Started with the CustomCat API

Getting Started with the CustomCat API

Overview

The CustomCat API allows software developers to build custom apps, integrations, and automated workflows. With the API, you can seamlessly transmit orders from your eCommerce platform or custom software to CustomCat—eliminating the need for manual order entry.

⚠️ Note: You do not need to use the API to access CustomCat’s core features. You can still connect via Shopify or WooCommerce, or place orders manually using the CSV Upload or Order Now features. The API is a separate integration method and does not allow management of orders created via direct integrations.

CustomCat does not offer development services. If you plan to use the API, you must work with a qualified software developer.

Key Features

✅ REST API

Use the REST API to manage your CustomCat API Store. With it, you can:

  • Retrieve product SKUs and details

  • Submit and manage orders

  • Monitor order statuses

  • And more

🔁 Webhooks

Webhooks let your application respond to events like “Order Shipped” without needing to poll the API. Once registered, CustomCat will send HTTP POST requests to your app whenever key events occur.

Use Cases

🧩 Self-Managed Integration

  • You own the CustomCat account and manage everything: order submission, billing, and support.

  • Example: A single POD store or platform that sends orders to CustomCat for fulfillment.

🧩 Merchant-Managed Integration

  • You build the platform and connect multiple merchants who each have their own CustomCat account.

  • Merchants manage fulfillment and billing independently.

  • Example: A platform offering ecommerce tools to creators with CustomCat as a fulfillment option.

Getting Started

  1. Create a CustomCat Account
    Go to app.customcat.com/signin and log in or sign up. API access is available on all plans.

  2. Connect an API Store
    In the sidebar, click Connect Store, then select Create API Order. Enter your Store Name and URL and click Connect.

  3. Get Your API Keys
    In the sidebar, go to Settings > Store > API. You’ll see:

    • A read-only key

    • A read-write key (required for most actions)

    🔐 Tip: If you're using third-party software, ensure your API keys are correctly configured in that tool.

  4. Access API Documentation
    Visit the official API docs here:
    https://customcat-beta.mylocker.net/api/v1/ (opens in a new tab)

API Workflows

There are two main workflows when using the CustomCat API:

Workflow 1: Uploaded Designs (Less Popular)

Use this if you’re creating product mockups within the CustomCat app.

How it Works:

  • Upload designs to the Design Library

  • Create products using Create Products in the app

  • Products will only exist via the API (not editable in the app)

Key Endpoints:

  • /product: Get the sku created by your uploaded design

  • /order: Submit orders using these SKUs

⚠️ Your order must use the sku tied to your uploaded design.

Workflow 2: External Designs (Most Popular)

Use this if you already have your own mockups and designs.

Key Endpoints:

  • /catalog: Get full product listings, images, weights, inventory status, etc.

    • Example: Gildan 5000 - Black - Large → catalog_sku = 48146

  • /catalogCategories: Filter by decoration method or product style (e.g., DIGISOFT only)

  • /order:
    Submit orders using:

    • A valid catalog_sku

    • An external design_url (must be downloadable .png or .jpg)

Design URL Requirements:

  • File must allow direct download (not protected/private)

  • Recommended hosts: Amazon S3, Google Cloud Storage

  • Dropbox: add ?dl=1 to the URL

  • ❌ Google Drive links are not supported

🎨 For optimal results, design dimensions should match CustomCat's print specs (opens in new tab).
If your design doesn't match, you may include a Preset_Id to auto-position artwork (see: Preset documentation).

Additional Functionality

📦 Order/Status

Track individual order status, totals, and tracking numbers.

  • Call order/status/{id} to view specific order info.

🔔 Webhooks

Register a webhook to get real-time updates when orders ship.

  • Example: Create webhook endpoint to notify your app when an order ships.

Real-Time Inventory Availability

Yes — you can check stock availability using the API.

  • The /catalog and /catalog_sku endpoints indicate if a product is:

    • In stock

    • Temporarily out of stock

    • Discontinued

🕐 Many API clients check availability daily before submitting orders to avoid errors.

Sandbox / Test Mode

There is no full sandbox environment, but you can simulate test calls using:

sandbox: 1

  • To submit production orders, either set sandbox: 0 or omit the parameter entirely.

 

 

Have Questions?

Check out our full API documentation or contact support.