Gearment API integration (1.0.0)

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 URL: https://api.gearment.com/integration-handler

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

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).
Download OpenAPI description
Overview
Languages
Servers
Production Server

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

Sandbox Server

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

Version 3

VendorWebhookAPI provide an abstraction to all of read and write data access for webhook businesses

Operations

Version 2

LegacyVendorWebhookAPI provide an abstraction to support the legacy api call format

Operations

Version 3

VendorOrderAPI provide an abstraction to all of read and write data access for order businesses

Operations

Version 2

LegacyVendorOrderAPI provide an abstraction to support the legacy api call format

Operations

Version 3

VendorCatalogAPI provide an abstraction to all of read data access for catalog businesses

Operations

Version 2

LegacyVendorCatalogAPI provide an abstraction to support the legacy api call format

Operations