The Gearment API v2 is a API service for viewing the product catalog, Get a single order info and completing orders for our printing and fulfillment services.
\nRequests are made using standard GET and POST. All responses are JSON.
\nOnce you sign up for an account, you will be provided with a real API key (In your account settings).
\nThis API uses normal method for authentication (API Keys in params). Your private API keys should be used as the password.
\nIf you are currently logged in account settings, you can go to [Setting] -> [API Credentials] and get API Keys there.
\nAll requests must be made over HTTPS.
\n100 requests per 10 seconds, Block for 1 minute
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"1. Overview","slug":"1-overview"},{"content":"2. Authentication","slug":"2-authentication"},{"content":"3. Rate Limiting (Updated at: March 15, 2021)","slug":"3-rate-limiting-updated-at-march-15-2021"}],"owner":"10864246","collectionId":"bf5ba7db-8d66-499c-a8a8-7f78ad2097d3","publishedId":"SzfCT5Qn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-01-31T09:57:16.000Z"},"item":[{"name":"Product API","item":[{"name":"List Product Variants","id":"0cced3c2-11d3-4b16-8048-3c44eb491bde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"raw","raw":"{\r\n\t\"api_key\":\"xxx\",\r\n\t\"api_signature\":\"xxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.gearment.com/v2/?act=products","description":"Get a list of available product variants.
\n| Name | \nRequired | \nType | \nValue | \n
| api_key | \nYes | \nString | \n(Get from Account settings) | \n
| api_signature | \nYes | \nString | \n(Get from Account settings) | \n
| Name | \nType | \nValue | \n
| status | \nString | \nsuccess | error | \n
| message | \nString | \n[API] Product categories! | \n
| result | \njson | \n\n |
Get info of a single order
\nName | Required | Type | Value |
api_key | Yes | String | (Get from Account settings) |
api_signature | Yes | String | (Get from Account settings) |
order_id | Yes | Integer or String | Order Gearment internal ID(integer) or External ID (if prefixed with @) |
Name | Type | Value |
status | String | success | error |
message | String | [API] Order detail! |
result | json |
Create an order
\nName | Required | Type | Value |
api_key | Yes | String | (Get fromAccount settings) |
api_signature | Yes | String | (Get fromAccount settings) |
order_id | No | String | (Your Order ID: OD-xxx) |
external_id | No | String | (Order ID from the external system) |
store_id | No | String | Gearment Store ID- Get fromStore management( Column #ID) |
agree_at_risk | No | Boolean | (true: user confirms to process the order with variation at risk. As the product is at low stock, processing time might be delayed for a few business days. false: do not agree to create order) Default: true |
shipping_email | No | String | (Shipping email address: email_address@mail.com) |
shipping_name | Yes | String | (Shipping full name) |
shipping_phone | No | String | (Shipping phone number) |
shipping_company_name | No | String | (Shipping Company name) |
shipping_address1 | Yes | String | (Shipping address 1) |
shipping_address2 | No | String | (Shipping address 2) |
shipping_province_code | No | String | (Shipping province) |
shipping_city | Yes | String | (Shipping city) |
shipping_zipcode | Yes | Integer | (Shipping zipcode) |
shipping_country_code | Yes | String | US |
shipping_method | Yes | Integer | 0: Standard 1: Fastship 2days 2: Ground 3: Stamp |
gift_message_body | No | String | The gift message. Maximum character allowed 350. Configure Gift Optionshere |
ioss_number | No | String | The IOSS scheme is designed to simplify the declaration and payment of VAT in the EU on all goods sold from distance by sellers from both within and outside the EU. Example : FR 295849305 |
ioss_number_total | No | Float | The total price of IOSS number |
tax_number | No | String | A tax identification number |
order_tax_value | No | Float | The tax values for order |
line_items | Yes | Array | A list of line item objects, each containing information about an item in the order. (See below) |
line_items | |||
variant_id | Yes | Integer | (Variant ID of the item ordered. See Products API) |
product_name | No | String | Your product name: Campaign Name |
product_style | No | String | Your product style: T-shirt |
product_sku | No | String | Your product SKU: SKU01 |
quantity | Yes | Integer | (Quantity number) |
designs | Yes | Object | Custom design URLs |
designs | |||
front | No | String | URL of the front design |
pocket | No | String | URL of the pocket design |
back | No | String | URL of the back design |
whole | No | String | URL of the whole design |
left_sleeve | No | String | URL of the left sleeve design |
right_sleeve | No | String | URL of the left right design |
Name | Type | Value |
status | String | success | error |
message | String | [API] Add order successfully! |
result | json |
Create an order label
\nName | Required | Type | Value |
api_key | Yes | String | (Get fromAccount settings) |
api_signature | Yes | String | (Get fromAccount settings) |
order_id | No | String | (Your Order ID: OD-xxx) |
store_id | No | String | Gearment Store ID- Get fromStore management( Column #ID) |
agree_at_risk | No | Boolean | (true: user confirms to process the order with variation at risk. As the product is at low stock, processing time might be delayed for a few business days. false: do not agree to create order) Default: true |
shipping_service_type | Yes | String | Ebay Etsy Poshmark Tiktok Fba |
shipping_label_link | Yes | URL | Link shipping label (link pdf) |
gift_message_body | No | String | The gift message. Maximum character allowed 350. Configure Gift Optionshere |
line_items | Yes | Array | A list of line item objects, each containing information about an item in the order. (See below) |
line_items | |||
variant_id | Yes | Integer | (Variant ID of the item ordered. See Products API) |
product_name | No | String | Your product name: Campaign Name |
product_style | No | String | Your product style: T-shirt |
product_sku | No | String | Your product SKU: SKU01 |
quantity | Yes | Integer | (Quantity number) |
barcode_link | shipping_service_type = fba | required | URL | Link url barcode (Link pdf) |
designs | Yes | Object | Custom design URLs |
designs | |||
front | No | String | URL of the front design |
pocket | No | String | URL of the pocket design |
back | No | String | URL of the back design |
whole | No | String | URL of the whole design |
left_sleeve | No | String | URL of the left sleeve design |
right_sleeve | No | String | URL of the right sleeve design |
Name | Type | Value |
status | String | success | error |
message | String | [API] Add order successfully! |
result | json |
Returns list of order objects from your store
\nName | Required | Type | Value |
api_key | Yes | String | (Get from Account settings) |
api_signature | Yes | String | (Get from Account settings) |
order_status | Yes | String | Filter by order status: pending,processing,completed,canceled,any |
payment_status | Yes | String | Filter by payment status: unpaid,paid,failure,canceled,any |
created_at_min | Yes | String | Show orders created at or after date. Format: 2020-04-20 |
created_at_max | Yes | String | Show orders created at or before date. Format: 2020-04-22 |
limit | No | Integer | The maximum number of results to show on a page. (default: 50, maximum: 250) |
page | No | Integer | Number of page |
Name | Type | Value |
status | String | success | error |
message | String | [API] Order List! |
result | json | |
paging | json |
Fulfillment an order
\nName | Required | Type | Value |
api_key | Yes | String | (Get from Account settings) |
api_signature | Yes | String | (Get from Account settings) |
order_id | Yes | Integer | Gearment OrderID |
line_items | Yes | Array | A list of line item objects, each containing information about an item in the order. (See below) |
line_items | |||
order_item_id | Yes | Integer | Gearment OrderItem ID |
variant_id | Yes | Integer | (Variant ID of the item ordered. See Products API) |
quantity | Yes | Integer | (Quantity number) |
design_link | No | URL | (Link url front) |
design_link_back | No | URL | (Link url back) |
Name | Type | Value |
status | String | success | error |
message | String | [API] The order is submitted for fulfillment |
result | json |
Estimate order costs
\nName | Required | Type | Value |
api_key | Yes | String | (Get from Account settings) |
api_signature | Yes | String | (Get from Account settings) |
store_id | No | String | Gearment Store ID- Get from Store management( Column #ID) |
shipping_email | No | String | (Shipping email address: email_address@mail.com) |
shipping_name | Yes | String | (Shipping full name) |
shipping_phone | No | String | (Shipping phone number) |
shipping_company_name | No | String | (Shipping Company name) |
shipping_address1 | Yes | String | (Shipping address 1) |
shipping_address2 | No | String | (Shipping address 2) |
shipping_province_code | No | String | (Shipping province) |
shipping_city | Yes | String | (Shipping city) |
shipping_zipcode | Yes | Integer | (Shipping zipcode) |
shipping_country_code | Yes | String | US |
shipping_method | Yes | Integer | 0: Standard 1: Fastship 2days 2: Ground 3: Stamp |
line_items | Yes | Array | A list of line item objects, each containing information about an item in the order. (See below) |
line_items | |||
variant_id | Yes | Integer | (Variant ID of the item ordered. See Products API) |
quantity | Yes | Integer | (Quantity number) |
side | No | String | Applicable for some special products. Mug, for example, possible values: \"whole\" or \"both\". |
design_link | design_link or design_link_back | required | URL | (Link url front) |
design_link_back | design_link or design_link_back | required | URL | (Link url back) |
Name | Type | Value |
status | String | success | error |
data | json |
Webhooks is an API feature that allows your system to receive notifications about certain events. When an event occurs, the Gearment server will make a POST request to your defined URL that will contain a JSON object in the request body.
\nEvent type:
\nAdd Webhook: Gearment dashboard -> menu Setting -> Tab API Credentials -> Add webhook
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":"Create a new webhook subscription by specifying both an address and a topic
\nName | Required | Type | Value |
api_key | Yes | String | (Get from Account settings) |
api_signature | Yes | String | (Get from Account settings) |
topic | Yes | String | Topics allowed: orders_completed, orders_canceled, tracking_updated, shipping_address_unverified |
address | Yes | String | Retrieve webhook subscriptions that send the POST request to this URI. |
Name | Type | Value |
status | String | success | error |
message | String | Webhook created |
result | json |
Webhooks is an API feature that allows your system to receive notifications about certain events.
\n","event":[{"listen":"prerequest","script":{"id":"a2ba4296-f233-4928-8676-46b57a8375ce","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d723b4f6-8289-4509-bc3b-5eda6e9a221b","type":"text/javascript","exec":[""]}}],"_postman_id":"48ffa45c-9c52-4606-a76d-f896bad8a20f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":"| Name | \nRequired | \nType | \nValue | \n
| api_key | \nYes | \nString | \n(Get from Account settings) | \n
| api_signature | \nYes | \nString | \n(Get from Account settings) | \n
| request_status | \nNo | \nString | \nFilter by request status: pending, processing, completed, fail | \n
| created_at_max | \nNo | \nString | \nShow request issue created at or before date. Format: 2021-10-11 | \n
| created_at_min | \nNo | \nString | \nShow request issue created at or after date. Format: 2021-10-01 | \n
| limit | \nNo | \nInteger | \nThe maximum number of results to show on a page. (default: 50, maximum: 250) | \n
| page | \nNo | \nInteger | \nNumber of page | \n
| Name | \nRequired | \nType | \nValue | \n
| api_key | \nYes | \nString | \n(Get from Account settings) | \n
| api_signature | \nYes | \nString | \n(Get from Account settings) | \n
| order_id | \nYes | \nInteger | \nGearment OrderID | \n
| issue_category | \nYes | \nString | \nList issue category: img_quality, item_damaged, item_missing, item_not_expected, no_update_from_carrier, order_late_production, shipping_problem, wrong_item_size, wrong_print, shipping_to_wrong_address, size_not_expected, item_not_expected, print_missing, another, cancel_by_buyer | \n
| issue_detail | \nNo | \nString | \nIssue detail | \n
| issue_item_affected | \nYes | \nInteger | \nNumber item affected | \n
| issue_priority | \nNo | \nString | \nIsse priority: low, medium, high. (default: low) | \n
| issue_solution | \nYes | \nString | \nIssue solution: replace, refund | \n
| issue_image | \nNo | \nArray | \nlist link image | \n
HTTP Response status code
\n| Status code | \nDescription | \n
| 200 | Ok |
| 400 | Bad Request |
| 401 | Unauthorized |
| 402 | Not Acceptable |