Skip to content

Overview

Welcome to the Gearment Print-On-Demand (POD) Seller API! This API enables seamless integration between your stores, applications, and the Gearment platform. With our API, you can:

  • Manage products and variants

  • Sync inventory

  • Create and manage orders

  • Track fulfillment status

This documentation will guide you through authentication, rate limits, and how to start using the API.

Production API v3 URL: https://apiv2.gearment.com/integration-handler

Sandbox API v3 URL: https://api.gearmentinc.com/integration-handler

Need to use API v2
👉 View API v2 Documentation here

Authentication

All API requests must be authenticated with an API Key. Unauthorized requests will be rejected.

How to obtain your API Key

  1. Navigate to your Team Settings inside the Gearment platform.
  2. Click on Developer Settings.
  3. Request and generate your API Key.

⚠️ Important: Keep your API key secure. Do not share it publicly or embed it directly in client-side applications. If your API Key is compromised, immediately revoke it and generate a new one.

Using API Key

Include your API key in the request headers:

X-Gearment-Client-Key: Your_Gearment_Client_Key

X-Gearment-Client-Secret: Your_Gearment_Client_Secret"

Rate Limiting

To ensure stable service for all users, the Gearment API enforces rate limiting.

Rate Limit TypeValue
Requests100 requests per 10 seconds, Block for 1 minute
Retry-AfterIf exceeded, Retry-After header will indicate when you can retry

If you exceed the rate limit, the API will respond with:

json{
  "error": {
    "code": 429,
    "message": "Rate limit exceeded. Please retry later."
  }
}

Best Practices:

  • Implement exponential backoff retries for 429 errors.
  • Monitor your API usage.
  • Optimize your integrations to avoid unnecessary requests (e.g., batch updates when possible).

Migration Guide

🚀 Migration Guide: Moving from v1/v2 to Next App v3 API/Webhook

We’ve upgraded our platform to the new Next App, which provides API v3, delivering better performance, scalability, and new features.

Good news:
Backward compatibility is preserved.
Your existing integrations using API v1/v2 and Webhook v1/v2 will continue to work out of the box without changes.
✅ You can switch to the new APIs at your own pace.


1. What stays the same

  • Your current API calls v1/v2 and boundWebhooks will continue to work exactly as before.
  • We have a compatibility layer that routes those calls to the new system.
  • No immediate action is required for existing apps.

2. API Endpoints Overview

VersionBase URLSandboxNotes
v1/v2https://api.gearment.comN/Av1/v2 API, still supported via compatibility layer
v3https://apiv2.gearment.com/integration-handlerhttps://api.gearmentinc.com/integration-handlerNext App API (new API features)

3. What’s new in API v3

  • Modernized endpoints for improved queries and faster responses.
  • Consistent authentication and more detailed error handling.
  • Access to new features and data models not available in v1/v2.
  • Enhanced developer experience with updated documentation and examples.

Example API v3 Request:

  • Now you can filter product variants with more criterions, e.g.: look for product variants have product_id G5000, variant_id in GM0002003147/GM0002005986, with size 3XL, and color Daisy.
curl -i -X GET \
  -H "X-Gearment-Client-Key: xxx" \
  -H "X-Gearment-Client-Secret: xxxxxx" \
  'https://apiv2.gearment.com/integration-handler/api/v3/catalog/variants/stock?filter.product_ids=G5000&filter.variant_ids=GM0002003147&filter.variant_id=GM0002005986&filter.sizes=3XL&filter.color_codes=daisy&filter.stock_labels=VENDOR_CATALOG_VARIANT_STOCK_LABEL_IN_STOCK&paging.page=1&paging.limit=100'
  • You can also list/delete webhooks via APIs.

4. Webhooks in v3 Modified payload for webhooks

👉 Configure your webhooks in the Developer Settings.

Example Shipping Address Verified Webhook Payload:

  • v1/v2:
{
  "type": "shipping_address_verified",
  "data": {
    "gearment_ord_id": "ORD123456789",
    "gearment_ord_name": "#10001",
    "ord_status": "pending",
    "verify_address": "verified",
    "order_id": "EXT-1234567"
  }
}
  • v3:
{
  "type": "shipping_address_verified",
  "order": {
    "gearment_id": "ORD123456789",
    "gearment_name": "#10001",
    "vendor_id": "EXT-1234567",
    "verify_address": "verified",
    "ord_status": "pending"
  }
}

5. Migration Path If you’re ready to explore API v3, follow these steps:

  1. Take a glance at our API v3 Documentation: 👉 Get Started Here
  2. Visit Developer Settings to generate new API credentials for API/Webhooks v3.
  3. Review the updated endpoint list and request/response formats.
  4. Update your integration to start using v3 endpoints at your own pace.

6. Recommendations

  • Short-term: Continue running on v1/v2 without changes if everything works.
  • Medium-term: Start adopting v3 for new development to take advantage of improvements.
  • Long-term: Plan a full migration, as v1/v2 may be deprecated in the future (deprecation timelines will be communicated well in advance).

7. Support Need help migrating?

Download OpenAPI description
Overview
Languages
Servers
Production Server

https://apiv2.gearment.com/integration-handler/

Sandbox Server

https://api.gearmentinc.com/integration-handler/

Webhook

VendorWebhookAPI provides webhook management for real-time event notifications. Register webhooks to receive automated notifications when orders are completed, cancelled, or tracking is updated.

Base URL: https://apiv2.gearment.com/integration-handler Authentication: API Key (header: X-API-Key, X-API-Secret)

Operations

Order

VendorOrderAPI provides comprehensive order management capabilities for vendors. All endpoints require authentication via X-API-Key and X-API-Secret headers.

Base URL: https://apiv2.gearment.com/integration-handler Authentication: API Key (header: X-API-Key, X-API-Secret)

Operations

Catalog

VendorCatalogAPI provides access to product catalog and inventory management. Use these endpoints to browse available products, check stock status, and get product details.

Base URL: https://apiv2.gearment.com/integration-handler Authentication: API Key (header: X-API-Key, X-API-Secret)

Operations