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/
Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
For API Legacy
https://apiv2.gearment.com/integration-handler/api/v3/orders
https://api.gearmentinc.com/integration-handler/api/v3/orders
curl -i -X GET \
'https://apiv2.gearment.com/integration-handler/api/v3/orders?filter.created_at_min.nanos=0&filter.created_at_min.seconds=0&filter.created_methods=VENDOR_CREATED_METHOD_UNKNOWN&filter.order_ids=string&filter.payment_status=VENDOR_ORDER_PAYMENT_STATUS_UNKNOWN&filter.statuses=VENDOR_ORDER_STATUS_UNKNOWN&paging.limit=0&paging.page=0'{ "status": "string", "message": "string", "paging": { "total": 0, "total_page": 0, "page": 0, "limit": 0 }, "data": [ { … } ] }
Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
https://apiv2.gearment.com/integration-handler/api/v3/orders/draft
https://api.gearmentinc.com/integration-handler/api/v3/orders/draft
curl -i -X GET \
'https://apiv2.gearment.com/integration-handler/api/v3/orders/draft?filter.created_at_min.nanos=0&filter.created_at_min.seconds=0&filter.created_methods=VENDOR_CREATED_METHOD_UNKNOWN&filter.order_ids=string&filter.statuses=VENDOR_ORDER_DRAFT_STATUS_UNKNOWN&paging.limit=0&paging.page=0'{ "status": "string", "message": "string", "paging": { "total": 0, "total_page": 0, "page": 0, "limit": 0 }, "data": [ { … } ] }
https://apiv2.gearment.com/integration-handler/api/v3/orders/draft
https://api.gearmentinc.com/integration-handler/api/v3/orders/draft
curl -i -X POST \
https://apiv2.gearment.com/integration-handler/api/v3/orders/draft \
-H 'Content-Type: application/json' \
-d '{
"data": {
"reference_id": "string",
"platform": "MARKETPLACE_PLATFORM_UNSPECIFIED",
"store_id": "string",
"agree_at_risk": true,
"address": {
"first_name": "string",
"last_name": "string",
"company": "string",
"contact_pronoun": "string",
"street_1": "string",
"street_2": "string",
"state_code": "string",
"state_name": "string",
"city": "string",
"zip_code": "string",
"country_code": "string",
"country_name": "string",
"phone_no": "string",
"email": "string",
"type": "TYPE_UNKNOWN"
},
"shipping_method": "METHOD_UNKNOWN",
"billing_option": {
"ioss_number": "string",
"ioss_value": {
"currency_code": "string",
"units": 0,
"nanos": 0
},
"tax_number": "string",
"tax_value": {
"currency_code": "string",
"units": 0,
"nanos": 0
}
},
"gift_message_body": "string",
"line_items": [
{
"variant_id": "string",
"legacy_id": 0,
"quantity": 1000,
"printing_options": [
{
"location_code": "PRINT_LOCATION_CODE_UNKNOWN",
"url": "string"
}
],
"barcode_url": "string"
}
]
}
}'{ "status": "string", "message": "string", "data": { "order_id": "string", "team_id": "string", "store_id": "string", "store_name": "string", "platform_ref": "string", "order_platform": "MARKETPLACE_PLATFORM_UNSPECIFIED", "import_id": "string", "pull_id": "string", "request_id": "string", "created_method": "VENDOR_CREATED_METHOD_UNKNOWN", "fulfillment_vendor": "VENDOR_FULFILLMENT_VENDOR_UNKNOWN", "priority": "VENDOR_FULFILLMENT_PRIORITY_UNKNOWN", "fulfillment_option": { … }, "shipping_option": { … }, "billing_option": { … }, "order_date": "2019-08-24T14:15:22Z", "status": "VENDOR_ORDER_DRAFT_STATUS_UNKNOWN", "order_tracking_code": "string", "shipping_labels": [ … ], "is_label_attached": true, "shipping_verification_status": "VENDOR_SHIPPING_VERIFICATION_STATUS_UNKNOWN", "product_matching_status": "VENDOR_PRODUCT_MATCHING_STATUS_UNKNOWN", "is_shipping_verification_bypassed": true, "is_approved": true, "approved_at": "2019-08-24T14:15:22Z", "origin_draft_id": "string", "origin_order_id": "string", "addresses": [ … ], "line_items": [ … ], "gift_messages": [ … ], "legacy_external_id": "string", "fulfilment_order": "string", "payment_status": "string", "order_subtotal": { … }, "order_shipping_fee": { … }, "order_handle_fee": { … }, "order_tax": { … }, "order_fee": { … }, "order_discount": { … }, "order_total": { … }, "verify_address": "VENDOR_SHIPPING_VERIFICATION_STATUS_UNKNOWN", "print_option": { … } } }