Gearment API integration (v3.0.0)

Integrate your store with the Gearment Print-On-Demand platform over REST. Authenticate with your team's API key, then manage catalog, orders, and webhooks.

Read the Gearment API guides

Download OpenAPI description

JSONapi.json↓ YAMLapi.yaml↓

Overview

Support Integrationintegration@gearment.com

Servers

Mock server/_mock

Production Serverhttps://apiv2.gearment.com/integration-handler

Sandbox Serverhttps://api.gearmentinc.com/integration-handler

API operations

Catalog 4 operations

get /api/v3/catalog List Catalog get /api/v3/catalog/variants List Catalog Variant get /api/v3/catalog/variants/stock Get Catalog Stock Status get /api/v3/catalog/variants/shipping-fee Get Catalog Shipping Fee

Webhook 3 operations

get /api/v3/webhooks List Webhook post /api/v3/webhooks Create Webhook delete /api/v3/webhooks/{webhook_id} Delete Webhook

Order 9 operations

get /api/v3/orders List Order get /api/v3/orders/draft List Order Draft post /api/v3/orders/draft Create Order Draft post /api/v3/orders/draft/labeled Create Order Draft With Label patch /api/v3/orders/draft/line-items Update Order Draft Line Items get /api/v3/orders/draft/{order_id} Get Order Draft post /api/v3/orders/price Get Price Quote get /api/v3/orders/{order_id} Get Order post /api/v3/orders/draft/{order_id}/approve Approve Order Draft

Shipping 1 operations

post /api/v3/shipping/economy/coverage/check Check Economy Coverage

Support 2 operations

get /api/v3/support/requests List Support Request post /api/v3/support/requests Create Support Request

Seller Shipping Labels 6 operations

get /v1/vendor/shipping-labels/services List enabled carrier services post /v1/vendor/shipping-labels/rates Estimate label rates get /v1/vendor/shipping-labels List shipping labels post /v1/vendor/shipping-labels Purchase a shipping label get /v1/vendor/shipping-labels/{label_id} Get a shipping label post /v1/vendor/shipping-labels/{label_id}:cancel Cancel a shipping label

Gearment Webhook

Read webhook guide