Support Integration
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
All API requests must be authenticated with an API Key. Unauthorized requests will be rejected.
How to obtain 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.
Include your API key in the request headers:
X-Gearment-Client-Key: Your_Gearment_Client_Key
X-Gearment-Client-Secret: Your_Gearment_Client_Secret"
To ensure stable service for all users, the Gearment API enforces rate limiting.
| Rate Limit Type | Value |
|---|---|
| Requests | 100 requests per 10 seconds, Block for 1 minute |
| Retry-After | If 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:
https://apiv2.gearment.com/integration-handler/
https://api.gearmentinc.com/integration-handler/
Wrapper message for bool.
The JSON representation for BoolValue is JSON true and false.
Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
https://apiv2.gearment.com/integration-handler/api/v2/orders/draft/labeled
https://api.gearmentinc.com/integration-handler/api/v2/orders/draft/labeled
curl -i -X POST \
https://apiv2.gearment.com/integration-handler/api/v2/orders/draft/labeled \
-H 'Content-Type: application/json' \
-d '{
"order_id": "string",
"store_id": "string",
"agree_at_risk": true,
"shipping_service_type": "string",
"shipping_label_link": "string",
"gift_message_body": "string",
"line_items": [
{
"variant_id": 0,
"product_name": "string",
"product_style": "string",
"product_sku": "string",
"quantity": 1000,
"barcode_link": "string",
"designs": {
"front": "string",
"pocket": "string",
"back": "string",
"whole": "string",
"left_sleeve": "string",
"right_sleeve": "string"
}
}
],
"api_key": "string",
"api_signature": "string"
}'{ "status": "string", "message": "string", "result": { "id": 0, "name": "string" } }
https://apiv2.gearment.com/integration-handler/api/v2/orders
https://api.gearmentinc.com/integration-handler/api/v2/orders
curl -i -X GET \
https://apiv2.gearment.com/integration-handler/api/v2/orders \
-H 'Content-Type: application/json' \
-d '{
"order_status": "string",
"payment_status": "string",
"created_at_min": "string",
"created_at_max": "string",
"page": 0,
"limit": 0,
"api_key": "string",
"api_signature": "string"
}'{ "paging": { "total": 0, "total_page": 0, "offset": 0, "limit": 0 }, "result": [ { … } ], "status": "string", "message": "string" }
https://apiv2.gearment.com/integration-handler/api/v2/orders/draft/line-items
https://api.gearmentinc.com/integration-handler/api/v2/orders/draft/line-items
curl -i -X POST \
https://apiv2.gearment.com/integration-handler/api/v2/orders/draft/line-items \
-H 'Content-Type: application/json' \
-d '{
"order_id": 0,
"line_items": [
{
"order_item_id": 0,
"variant_id": 0,
"quantity": 1000,
"design_link": "string",
"design_link_back": "string"
}
],
"api_key": "string",
"api_signature": "string"
}'{ "status": "string", "message": "string", "result": { "id": 0 } }