API/Webhook documentation

This is a page about usage of API and Webhook for your GrooveKart store with listing all the Atrributes, responses and different types of actions.

Vendor's API Introduction

GrooveKart introduced Vendor's API to facilitate its esteemed customers so that they can import products and related data to their respective stores from available third party vendors.

To use this API a store must have it activated as per the configuration option given in the store back office for selected third party vendor.

You can visit your store's back office -> Products -> POD & DropShipping page to see the list of available vendors.

Allowed actions

This API is currently allowed to perform following actions on GrooveKart app stores:

Categories

  • Create New Category
  • List Existing Categories

Products

  • Create New Product
  • Activate/Deactivate Product
  • Get Products List
  • Search Product
  • Get Product details
  • Update Product
  • Add product image
  • Replace product image
  • Add product tags
  • Delete product tags

Variants

  • Create Variant Groups
  • Get Variant Groups
  • Add Product Variants
  • Add Variant Image
  • Delete Variant Image
  • Update Product Variants
  • Delete Product Variants

Orders

  • Get Orders Count
  • Get Orders
  • Search Orders
  • Get Order Details
  • Get Order Refunds
  • Add Order Note
  • Get Order Note
  • Update Order Note
  • Delete Order Note

Shipping/Tracking

  • Get Shipping Methods
  • Update Order Tracking info

Webhooks

  • Create Webhook
  • List webhooks
  • Update Webhook
  • Delete webhook

Requirements

GrooveKart's vendor API requires auth credentials (Auth Token & API Key) to validate each request sent to the GrooveKart store. And to use vendor API, app for given vendor must be activated to enable auth.

Follow steps below to activate API auth for a vendor:

  • Login to store's back office.
  • Click Products main menu option.
  • Click POD & DropShipping sub-menu option.
  • Page will list all available third party vendors.
  • Click Learn More button for the vendor.
  • Click switch button to activate vendor app.
  • Click gear icon appeared after activating the app.
  • Subsequent page will show the auth credentials.

API auth credentials must be passed with each request.

Sample Auth Credentials

Auth-token: gk-STORE_NAME

API Key: 2461c662rr5bdd1c53e21d55c1927c82

Authentication

API auth credentials passed with each request are required to authenticate the request on GrooveKart app.

Request Auth Credentials
{
"auth_token" : "AUTH-TOKEN",
"api_key"    : "API-KEY",
"api_user"   : "APP-USING-API", //e.g. teescape, slingly
}
											

Authentication Failure

Without auth credentials or in case given auth-token or API key is invalid, request will be rejected with the error response.

Authorization failed response

{ “Error” : “Auth Token is missing.” }

{ “Error”: “API Key is missing.” }

{ “Error”: “Authentication failed. Please contact support.” }

Category

This section of API allows to perform following actions on a GrooveKart store.

Create new category/categories

List existing categories

Endpoints

POST https://STORE-URL/api/create_categories.json

POST https://STORE-URL/api/list_categories.json

Create new Category/Categories

To create a single category or multiple categories, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • category

    type: array

    value: Array contains category titles

    required: yes

    Array data

    • title

      type: string

      value: category name

      required: yes

Returns

Returns the List of all categories.

Request
POST/JSON

Endpoint: https://STORE-URL/api/create_categories.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"category":
		{
			"title": "Test Category"
		}
}
Response: Success
JSON
{
	"categories":[
		{
			"id": "25",
			"title": "Best deals"
		},
		{
			"id": "26",
			"title": "Test Category"
		}
	]
}
Response: Failed
JSON
{
	"error": "Category not created."
}

List Existing Categories

Given below instructions can be followed to get the list of all existing categories:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

Returns

Returns the List of all categories.

Request
POST/JSON

Endpoint: https://STORE-URL/api/list_categories.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
}
Response: Success
JSON
{
	"categories":[
		{
			"id": "25",
			"title": "Best deals"
		},
		{
			"id": "26",
			"title": "Test Category"
		}
	]
}
Response: Failed
JSON
{
	"error": "Categories not found."
}

Product

This section of API allows to perform following products related actions on a GrooveKart store:

  • Create New Product
  • Activate/Deactivate Product
  • Get Products List
  • Search Product
  • Get Product details
  • Update Product
  • Add product image
  • Replace product image
  • Add product tags
  • Delete product tags
Endpoints

POST https://STORE-URL/api/products.json

POST https://STORE-URL/api/list_products.json

POST https://STORE-URL/api/search_products.json

Create new Product

To create a new product, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • product

    type: array

    value: Array contains product data

    required: yes

    Array data

    • title

      type: string

      value: product name

      required: yes

    • description

      type: string

      value: product description text

      required: no

    • short_description

      type: string

      value: product short description text

      required: no

    • vendor

      type: string

      value: product vendor name

      required: no

    • category_id

      type: int

      value: existing category id for product

      required: no

    • compare_default_price

      type: int/float

      value: product compared price

      required: yes

    • price

      type: int/float

      value: product price

      required: yes

    • image

      type: array

      value: product image data

      required: no

      Image data

      • src

        type: string

        value: image url

        required: yes

      • position

        type: int

        value: image position

        required: no

        default: 0

    • sku

      type: string/int

      value: product SKU

      required: no

    • weight

      type: int/float

      value: product weight

      required: no

    • visibility

      type: string

      value: product visibility on store

      required: yes

      default: "both"

      options: "both/search/none"

    • tags

      type: string

      value: comma separate list of product tags

      required: no

    • variant_groups

      type: array

      value: product variants groups data

      required: no

      info: if variants are passed with request, groups data is required.

      Variant Groups data

      • name

        type: string

        value: variant group type e.g. Color

        required: yes

      • group_type

        type: string

        value: variant group type

        required: yes

        default: "select"

    • variants

      type: array

      value: product variants data

      required: no

      Variants data

      • variant_values

        type: array

        value: variant details

        required: yes

        Variant values data

        • Color

          type: array

          value: variant type details

          required: yes

          • variant_group_type

            type: string

            value: group type value e.g. color

            required: yes

          • variant_name

            type: string

            value: variant name e.g. Blue

            required: yes

          • color

            type: string

            value: color hex code e.g. #0000FF

            required: yes

          Style

          type: array

          value: variant type details

          required: yes

          • variant_group_type

            type: string

            value: group type value e.g. select

            required: yes

          • variant_name

            type: string

            value: variant name e.g. Tab Collor

            required: yes

          Size

          type: array

          value: variant type details

          required: yes

          • variant_group_type

            type: string

            value: group type value e.g. select

            required: yes

          • variant_name

            type: string

            value: variant name e.g. L

            required: yes

          Cloth

          type: array

          value: variant type details

          required: yes

          • variant_group_type

            type: string

            value: group type value e.g. select

            required: yes

          • variant_name

            type: string

            value: variant name e.g. Cotton

            required: yes

      • compare_at_price

        type: float

        value: variant compared price

        required: yes

      • price

        type: float

        value: variant price

        required: yes

      • sku

        type: string

        value: variant SKU

        required: no

      • weight

        type: int/float

        value: variant weight

        required: no

      • weight_unit

        type: string

        value: variant weight unit e.g. lb

        required: no

      • default_on

        type: bool

        value: default variant for product e.g. 1 or 0

        required: yes

        info: only one variant can have value = 1.

Returns

Returns created product's data.

Request
POST/JSON

Endpoint: https://STORE-URL/api/products.json

{
   "auth_token":"AUTH-TOKEN",
   "api_key":"API-KEY",
   "api_user":"VENDOR-NAME", //e.g. teescape
   "product":{
      "title":"API Test Product",
      "description":"This is product description for Blue tshirt.",
      "short_description":"product short description.",
      "vendor":"",
      "category_id":25,
      "compare_default_price":100,
      "price":80,
      "image":{
         "src":"http://pluspng.com/img-png/tshirt-png-black-t-shirt-png-transparent-image-2611.png",
         "position":0
      },
      "sku":"",
      "weight":0,
      "visibility":"both",
      "tags":"tag1, tag2, tag3, tag4",
      "variant_groups":[
         {
            "name":"Cloth",
            "group_type":"select"
         },
         {
            "name":"Style",
            "group_type":"select"
         },
         {
            "name":"Color",
            "group_type":"color"
         },
         {
            "name":"Size",
            "group_type":"select"
         }
      ],
      "variants":[
         {
            "variant_values":{
               "Color":{
                  "variant_group_type":"color",
                  "variant_name":"Blue",
                  "color":"#0000FF"
               },
               "Style":{
                  "variant_group_type":"select",
                  "variant_name":"Tab Collar"
               },
               "Size":{
                  "variant_group_type":"select",
                  "variant_name":"L"
               },
               "Cloth":{
                  "variant_group_type":"select",
                  "variant_name":"Cotton"
               }
            },
            "compare_at_price":"31.99",
            "price":"27.99",
            "sku":"TS.12345678",
            "weight":"0.37",
            "weight_unit":"lb",
            "default_on":1
         },
         {
            "variant_values":{
               "Color":{
                  "variant_group_type":"color",
                  "variant_name":"Lime",
                  "color":"#00FF00"
               },
               "Style":{
                  "variant_group_type":"select",
                  "variant_name":"Classic Collar"
               },
               "Size":{
                  "variant_group_type":"select",
                  "variant_name":"XL"
               },
               "Type":{
                  "variant_group_type":"select",
                  "variant_name":"Cotton"
               }
            },
            "compare_at_price":"32.99",
            "price":"28.99",
            "weight":"0.43",
            "weight_unit":"lb",
            "sku":"TS.12345679",
            "default_on":0
         },
         {
            "variant_values":{
               "Color":{
                  "variant_group_type":"color",
                  "variant_name":"Blue",
                  "color":"#0000FF"
               },
               "Style":{
                  "variant_group_type":"select",
                  "variant_name":"Tab Collar"
               },
               "Size":{
                  "variant_group_type":"select",
                  "variant_name":"L"
               },
               "Cloth":{
                  "variant_group_type":"select",
                  "variant_name":"Lenin"
               }
            },
            "compare_at_price":"31.99",
            "price":"27.99",
            "sku":"TS.12345680",
            "weight":"0.37",
            "weight_unit":"lb",
            "default_on":0
         },
         {
            "variant_values":{
               "Color":{
                  "variant_group_type":"color",
                  "variant_name":"Lime",
                  "color":"#00FF00"
               },
               "Style":{
                  "variant_group_type":"select",
                  "variant_name":"Classic Collar"
               },
               "Size":{
                  "variant_group_type":"select",
                  "variant_name":"XL"
               },
               "Type":{
                  "variant_group_type":"select",
                  "variant_name":"Lenin"
               }
            },
            "compare_at_price":"32.99",
            "price":"28.99",
            "weight":"0.43",
            "weight_unit":"lb",
            "sku":"TS.12345681",
            "default_on":0
         }
      ]
   }
}
Response: Success
JSON
{
   "product_url":"https:\/\/xxxxxxxx.groovekart.com\/administration\/v2\/index.php\/product\/form\/8",
   "id_product":"8",
   "image_id":"111118",
   "variants":[
      {
         "variant_id":26,
         "variant_values":{
            "Color":{
               "variant_group_type":"color",
               "variant_name":"Blue",
               "color":"#0000FF"
            },
            "Style":{
               "variant_group_type":"select",
               "variant_name":"Tab Collar"
            },
            "Size":{
               "variant_group_type":"select",
               "variant_name":"L"
            },
            "Cloth":{
               "variant_group_type":"select",
               "variant_name":"Cotton"
            }
         }
      },
      {
         "variant_id":27,
         "variant_values":{
            "Color":{
               "variant_group_type":"color",
               "variant_name":"Lime",
               "color":"#00FF00"
            },
            "Style":{
               "variant_group_type":"select",
               "variant_name":"Classic Collar"
            },
            "Size":{
               "variant_group_type":"select",
               "variant_name":"XL"
            },
            "Cloth":{
               "variant_group_type":"select",
               "variant_name":"Cotton"
            }
         }
      },
      {
         "variant_id":28,
         "variant_values":{
            "Color":{
               "variant_group_type":"color",
               "variant_name":"Blue",
               "color":"#0000FF"
            },
            "Style":{
               "variant_group_type":"select",
               "variant_name":"Tab Collar"
            },
            "Size":{
               "variant_group_type":"select",
               "variant_name":"L"
            },
            "Cloth":{
               "variant_group_type":"select",
               "variant_name":"Lenin"
            }
         }
      },
      {
         "variant_id":29,
         "variant_values":{
            "Color":{
               "variant_group_type":"color",
               "variant_name":"Lime",
               "color":"#00FF00"
            },
            "Style":{
               "variant_group_type":"select",
               "variant_name":"Classic Collar"
            },
            "Size":{
               "variant_group_type":"select",
               "variant_name":"XL"
            },
            "Cloth":{
               "variant_group_type":"select",
               "variant_name":"Lenin"
            }
         }
      }
   ],
   "tags":{
      "1":[
         "tag1",
         "tag2",
         "tag3",
         "tag4"
      ]
   }
}
Response: Failed
JSON

If failed to create product

{ "error": "Product creation failed. Please check your data." }

If failed to upload image

{ "error": "Copying image file failed." OR "error": "Image uploading failed." OR "error": "Image status update failed." }

Search product(s)

Given below instructions can be followed to search store for existing product(s).

Search options

Product ID: a single ID or comma separated list of multiple IDs

OR

Keyword: search in product title, product or variant SKU

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • ids

    type: int/string

    value: product id(s) e.g. 10 or 10,12,34

    required: yes

    required: Not required if searched by keyword

  • keyword

    type: string

    value: a single word or multiple words

    required: yes

    required: Not required if searched by IDs

  • limit

    type: int

    value: limit product search results

    required: no

    default: 0 //for all products

  • offset

    type: int

    value: start search from

    required: no

    default: 0

  • order_by

    type: string

    value: order search output by

    required: no

    default: id_product

    info: order by id_product, date_add OR date_upd

  • order_way

    type: string

    value: ASC OR DESC

    required: no

    default: DESC

Returns

Returns the list of found products data.

Request
POST/JSON

Endpoint: https://STORE-URL/api/search_products.json

{
   "auth_token": "AUTH-TOKEN",
   "api_key": "API-KEY",
   "api_user": "VENDOR-NAME", //e.g. teescape
   "ids":"2,8,10",
   OR
   "keyword":"men shirt",
   "limit":0,
   "offset":0,
   "order_by":"id_product",
   "order_way":"DESC"
}
Response: Success
JSON
{
   "products":{
      "0":{
         "id":"8",
         "id_manufacturer":"0",
         "id_category_default":"25",
         "price":"0.000000",
         "compare_default_price":"0.00",
         "status":"1",
         "available_for_order":"1",
         "visibility":"both",
         "date_add":"2022-05-15 07:19:52",
         "date_upd":"2022-05-15 07:19:52",
         "description":"product description for Blue tshirt.",
         "link_rewrite":"api-test-product",
         "meta_title":"",
         "product_title":"API Test Product",
         "product_url":"http:\/\/gkartv2.lc\/best-deals\/8-api-test-product",
         "manufacturer_name":null,
         "vendor":null,
         "sku":"",
         "weight":"0.000000",
         "tags":"tag1,tag2,tag3,tag4",
         "cover_image":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/8\/111118-cart_default.webp?v=1652616880",
         "images":[
            {
               "id":"111118",
               "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/8\/111118-cart_default.webp?v=1652616880"
            }
         ],
         "variants":[
            {
               "id_product_variant":"26",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Short Collor",
               "reference":"TS.12345678",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":"1"
            },
            {
               "id_product_variant":"26",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"1XL",
               "reference":"TS.12345678",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":"1"
            },
            {
               "id_product_variant":"26",
               "group_name":"Color",
               "id_variant_group":"13",
               "variant_name":"Blue",
               "reference":"TS.12345678",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":"1",
               "color":"#0000FF"
            },
            {
               "id_product_variant":"26",
               "group_name":"Cloth",
               "id_variant_group":"14",
               "variant_name":"Cotton",
               "reference":"TS.12345678",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":"1"
            },
            {
               "id_product_variant":"27",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Lesbo",
               "reference":"TS.12345679",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0
            },
            {
               "id_product_variant":"27",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"2XL",
               "reference":"TS.12345679",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0
            },
            {
               "id_product_variant":"27",
               "group_name":"Color",
               "id_variant_group":"13",
               "variant_name":"Lime",
               "reference":"TS.12345679",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0,
               "color":"#00FF00"
            },
            {
               "id_product_variant":"27",
               "group_name":"Cloth",
               "id_variant_group":"14",
               "variant_name":"Cotton",
               "reference":"TS.12345679",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0
            },
            {
               "id_product_variant":"28",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Gay",
               "reference":"TS.12345680",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":0
            },
            {
               "id_product_variant":"28",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"1XL",
               "reference":"TS.12345680",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":0
            },
            {
               "id_product_variant":"28",
               "group_name":"Color",
               "id_variant_group":"13",
               "variant_name":"Teal",
               "reference":"TS.12345680",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":0,
               "color":"#008080"
            },
            {
               "id_product_variant":"28",
               "group_name":"Type",
               "id_variant_group":"15",
               "variant_name":"Lenin",
               "reference":"TS.12345680",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":0
            },
            {
               "id_product_variant":"29",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Gay",
               "reference":"TS.12345681",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0
            },
            {
               "id_product_variant":"29",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"2XL",
               "reference":"TS.12345681",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0
            },
            {
               "id_product_variant":"29",
               "group_name":"Color",
               "id_variant_group":"13",
               "variant_name":"Teal",
               "reference":"TS.12345681",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0,
               "color":"#008080"
            },
            {
               "id_product_variant":"29",
               "group_name":"Type",
               "id_variant_group":"15",
               "variant_name":"Lenin",
               "reference":"TS.12345681",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0
            }
         ]
      },
      "1":{
         "id":"5",
         "id_manufacturer":"1",
         "id_category_default":"25",
         "price":"0.000000",
         "compare_default_price":"0.00",
         "status":"1",
         "available_for_order":"1",
         "visibility":"both",
         "date_add":"2020-03-27 05:32:41",
         "date_upd":"2020-10-06 08:12:33",
         "description":"
This custom designed Backpack is a MUST HAVE!<\/strong><\/p>\r\n\r\n

\r\n\t
Features ergonomic shoulder straps with dynamic size adjustment for the perfect-fit.<\/li>\r\n\t
Made from 1200D high-grade waterproof nylon, durable and fashionable.<\/li>\r\n\t
Two main pockets for carrying books, binders, clothes and one front utility pocket for easy organization.<\/li>\r\n\t
Padded back and adjustable shoulder straps for ultra comfort and stability.<\/li>\r\n\t
Measures approximately 11.8"(L) x 5.51"(W) x 17.72"(H) x 5.9"(Hand Drop).<\/li>\r\n<\/ul>\r\n\r\n
\"\"<\/p>\r\n\r\n

 <\/p>\r\n\r\n

We ship with a USPS tracking number. Shipping takes between two and four weeks.<\/p>\r\n\r\n

 <\/p>\r\n\r\n

Click the ""Buy It Now<\/strong>"" button! Limited Quantity - Will sell out fast!<\/p>\r\n\r\n

 <\/p>\r\n\r\n

NOTE: This product is custom made and printed on demand and all sales are final.<\/p>",
         "link_rewrite":"g-logo-neck-gaiter",
         "meta_title":"Demo Backpack",
         "product_title":"G Logo Neck Gaiter",
         "product_url":"http:\/\/gkartv2.lc\/best-deals\/5-g-logo-neck-gaiter",
         "manufacturer_name":"samplebuilder.groovekart.com",
         "vendor":"samplebuilder.groovekart.com",
         "sku":"",
         "weight":"0.000000",
         "tags":"",
         "cover_image":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/5\/111115-cart_default.webp?v=1652616880",
         "images":[
            {
               "id":"111115",
               "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/5\/111115-cart_default.webp?v=1652616880"
            }
         ],
         "variants":[
            {
               "id_product_variant":"20",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"All Over Backpack - Backpack 1",
               "reference":"CASB077-799326",
               "price":"49.950000",
               "compare_price":"99.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":"1",
               "image":{
                  "id":"111115",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/5\/111115.jpg"
               }
            }
         ]
      },
      "products_count":2
   }
}
Response: Failed
JSON

If no search option is provided:

{ "error": "Product IDs or keyword not provided." }

If product ID is not numeric or a comma separated string of IDs:

{ "error": "Product IDs must be comma separated numbers list." }

If no products found for searched criteria:

{ "error": "No products found." }

Get Products List

To get the list of all existing products for the vendor from GrooveKart store, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • limit

    type: int

    value: limit product search results

    required: no

    default: 0 //for all products

  • offset

    type: int

    value: start search from

    required: no

    default: 0

  • order_by

    type: string

    value: order search output by

    required: no

    default: id_product

    info: order by id_product, date_add OR date_upd

  • order_way

    type: string

    value: order search output

    required: no

    default: DESC

    info: ASC for ascending order or DESC for descending

  • id_category

    type: int

    value: category id

    required: no

    default: null

  • only_active

    type: bool

    value: list only active products

    required: no

    default: null

Returns

Returns the list of all existing products data.

Request
POST/JSON

Endpoint: https://STORE-URL/api/list_products.json

{
   "auth_token": "AUTH-TOKEN",
   "api_key": "API-KEY",
   "api_user": "VENDOR-NAME", //e.g. teescape
   "offset":0,
   "limit":0,
   "order_by":"id_product",
   "order_way":"DESC",
   "id_category":25,
   "only_active":null
}
Response: Success
JSON
{
   "products":[
      {
         "id":"8",
         "id_manufacturer":"0",
         "id_category_default":"25",
         "price":"0.000000",
         "compare_default_price":"0.000000",
         "status":"1",
         "available_for_order":"1",
         "visibility":"both",
         "date_add":"2022-05-15 07:19:52",
         "date_upd":"2022-05-15 07:19:52",
         "description":"product description for Blue tshirt.",
         "link_rewrite":"api-test-product",
         "meta_title":"",
         "product_title":"API Test Product",
         "product_url":"http:\/\/gkartv2.lc\/best-deals\/8-api-test-product",
         "manufacturer_name":null,
         "vendor":null,
         "sku":"",
         "weight":"0.000000",
         "tags":"tag1,tag2,tag3,tag4",
         "cover_image":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/8\/111118-cart_default.webp?v=1652618604",
         "images":[
            {
               "id":"111118",
               "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/8\/111118-cart_default.webp?v=1652618604"
            }
         ],
         "variants":[
            {
               "id_product_variant":"26",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Short Collor",
               "reference":"TS.12345678",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":"1"
            },
            {
               "id_product_variant":"26",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"1XL",
               "reference":"TS.12345678",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":"1"
            },
            {
               "id_product_variant":"26",
               "group_name":"Color",
               "id_variant_group":"13",
               "variant_name":"Blue",
               "reference":"TS.12345678",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":"1",
               "color":"#0000FF"
            },
            {
               "id_product_variant":"26",
               "group_name":"Cloth",
               "id_variant_group":"14",
               "variant_name":"Cotton",
               "reference":"TS.12345678",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":"1"
            },
            {
               "id_product_variant":"27",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Lesbo",
               "reference":"TS.12345679",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0
            },
            {
               "id_product_variant":"27",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"2XL",
               "reference":"TS.12345679",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0
            },
            {
               "id_product_variant":"27",
               "group_name":"Color",
               "id_variant_group":"13",
               "variant_name":"Lime",
               "reference":"TS.12345679",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0,
               "color":"#00FF00"
            },
            {
               "id_product_variant":"27",
               "group_name":"Cloth",
               "id_variant_group":"14",
               "variant_name":"Cotton",
               "reference":"TS.12345679",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0
            },
            {
               "id_product_variant":"28",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Gay",
               "reference":"TS.12345680",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":0
            },
            {
               "id_product_variant":"28",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"1XL",
               "reference":"TS.12345680",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":0
            },
            {
               "id_product_variant":"28",
               "group_name":"Color",
               "id_variant_group":"13",
               "variant_name":"Teal",
               "reference":"TS.12345680",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":0,
               "color":"#008080"
            },
            {
               "id_product_variant":"28",
               "group_name":"Type",
               "id_variant_group":"15",
               "variant_name":"Lenin",
               "reference":"TS.12345680",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.370000",
               "default_on":0
            },
            {
               "id_product_variant":"29",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Gay",
               "reference":"TS.12345681",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0
            },
            {
               "id_product_variant":"29",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"2XL",
               "reference":"TS.12345681",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0
            },
            {
               "id_product_variant":"29",
               "group_name":"Color",
               "id_variant_group":"13",
               "variant_name":"Teal",
               "reference":"TS.12345681",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0,
               "color":"#008080"
            },
            {
               "id_product_variant":"29",
               "group_name":"Type",
               "id_variant_group":"15",
               "variant_name":"Lenin",
               "reference":"TS.12345681",
               "price":"24.990000",
               "compare_price":"29.99",
               "quantity":20,
               "weight":"0.430000",
               "default_on":0
            }
         ]
      },
      {
         "id":"7",
         "id_manufacturer":"1",
         "id_category_default":"25",
         "price":"0.000000",
         "compare_default_price":"0.000000",
         "status":"1",
         "available_for_order":"1",
         "visibility":"both",
         "date_add":"2020-03-27 05:34:57",
         "date_upd":"2020-10-06 08:14:27",
         "description":"
\r\n
\r\n
**50% OFF FLASH SALE TODAY ONLY<\/span>**<\/strong><\/p>\r\n\r\n

Was $39.99<\/del> Now Only $19.99<\/strong> <\/span><\/p>\r\n\r\n

Features a comfortable and easy slip-on design<\/strong><\/p>\r\n\r\n

High-quality and light-weight EVA sole for traction and exceptional durability.<\/strong><\/p>\r\n\r\n

Water-resistant with a vibrant canvas print along the full length of the tops.<\/strong><\/p>\r\n<\/div>\r\n<\/div>",
         "link_rewrite":"this-girl-loves-to-groove-tank-dark",
         "meta_title":"Demo Flip Flops",
         "product_title":"This Girl Loves To Groove Tank Dark",
         "product_url":"http:\/\/gkartv2.lc\/best-deals\/7-this-girl-loves-to-groove-tank-dark",
         "manufacturer_name":"samplebuilder.groovekart.com",
         "vendor":"samplebuilder.groovekart.com",
         "sku":"",
         "weight":"0.000000",
         "tags":"",
         "cover_image":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/7\/111117-cart_default.webp?v=1652618604",
         "images":[
            {
               "id":"111117",
               "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/7\/111117-cart_default.webp?v=1652618604"
            }
         ],
         "variants":[
            {
               "id_product_variant":"22",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Flip Flops - White",
               "reference":"CASCS138-799328",
               "price":"21.000000",
               "compare_price":"42.00",
               "quantity":20,
               "weight":"0.000000",
               "default_on":"1",
               "image":{
                  "id":"111117",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/7\/111117.jpg"
               }
            },
            {
               "id_product_variant":"22",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"S (EU38-EU40)",
               "reference":"CASCS138-799328",
               "price":"21.000000",
               "compare_price":"42.00",
               "quantity":20,
               "weight":"0.000000",
               "default_on":"1",
               "image":{
                  "id":"111117",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/7\/111117.jpg"
               }
            },
            {
               "id_product_variant":"23",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Flip Flops - White",
               "reference":"CASCS138-799329",
               "price":"21.000000",
               "compare_price":"42.00",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111117",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/7\/111117.jpg"
               }
            },
            {
               "id_product_variant":"23",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"M (EU40-EU42)",
               "reference":"CASCS138-799329",
               "price":"21.000000",
               "compare_price":"42.00",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111117",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/7\/111117.jpg"
               }
            },
            {
               "id_product_variant":"24",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Flip Flops - White",
               "reference":"CASCS138-799330",
               "price":"21.000000",
               "compare_price":"42.00",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111117",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/7\/111117.jpg"
               }
            },
            {
               "id_product_variant":"24",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"L (EU42-EU-44)",
               "reference":"CASCS138-799330",
               "price":"21.000000",
               "compare_price":"42.00",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111117",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/7\/111117.jpg"
               }
            },
            {
               "id_product_variant":"25",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Flip Flops - White",
               "reference":"CASCS138-799331",
               "price":"21.000000",
               "compare_price":"42.00",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111117",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/7\/111117.jpg"
               }
            },
            {
               "id_product_variant":"25",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"XL (EU44-EU45)",
               "reference":"CASCS138-799331",
               "price":"21.000000",
               "compare_price":"42.00",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111117",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/7\/111117.jpg"
               }
            }
         ]
      },
      {
         "id":"6",
         "id_manufacturer":"1",
         "id_category_default":"25",
         "price":"0.000000",
         "compare_default_price":"0.000000",
         "status":"1",
         "available_for_order":"1",
         "visibility":"both",
         "date_add":"2020-03-27 05:33:23",
         "date_upd":"2020-10-06 08:13:33",
         "description":"

\r\n
**50% OFF FLASH SALE TODAY ONLY<\/span>**<\/strong><\/p>\r\n\r\n

Was 49.95<\/del><\/s> Now Only 24.95<\/span><\/strong> <\/span><\/p>\r\n\r\n

\r\n\t
2.96 Oz. Made of 100% polyester material, soft and comfortable texture.<\/li>\r\n\t
Throw Pillow Cover 18"x18"<\/li>\r\n\t
With pre-shrunk fabric.<\/li>\r\n\t
Zippered opening style.<\/li>\r\n\t
Both functional and decorative.<\/li>\r\n\t
Each cover features a one-sided print and does not include a pillow insert.<\/li>\r\n<\/ul>\r\n<\/div>",
         "link_rewrite":"this-girl-loves-to-groove-hightop",
         "meta_title":"Demo Pillow Case Cover",
         "product_title":"This Girl Loves To Groove Hightop",
         "product_url":"http:\/\/gkartv2.lc\/best-deals\/6-this-girl-loves-to-groove-hightop",
         "manufacturer_name":"samplebuilder.groovekart.com",
         "vendor":"samplebuilder.groovekart.com",
         "sku":"",
         "weight":"0.000000",
         "tags":"",
         "cover_image":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/6\/111116-cart_default.webp?v=1652618604",
         "images":[
            {
               "id":"111116",
               "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/6\/111116-cart_default.webp?v=1652618604"
            }
         ],
         "variants":[
            {
               "id_product_variant":"21",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Pillow Case Cover - White",
               "reference":"CHCPC52-799327",
               "price":"9.950000",
               "compare_price":"19.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":"1",
               "image":{
                  "id":"111116",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/6\/111116.jpg"
               }
            }
         ]
      },
      {
         "id":"5",
         "id_manufacturer":"1",
         "id_category_default":"25",
         "price":"0.000000",
         "compare_default_price":"0.000000",
         "status":"1",
         "available_for_order":"1",
         "visibility":"both",
         "date_add":"2020-03-27 05:32:41",
         "date_upd":"2020-10-06 08:12:33",
         "description":"
This custom designed Backpack is a MUST HAVE!<\/strong><\/p>\r\n\r\n

\r\n\t
Features ergonomic shoulder straps with dynamic size adjustment for the perfect-fit.<\/li>\r\n\t
Made from 1200D high-grade waterproof nylon, durable and fashionable.<\/li>\r\n\t
Two main pockets for carrying books, binders, clothes and one front utility pocket for easy organization.<\/li>\r\n\t
Padded back and adjustable shoulder straps for ultra comfort and stability.<\/li>\r\n\t
Measures approximately 11.8"(L) x 5.51"(W) x 17.72"(H) x 5.9"(Hand Drop).<\/li>\r\n<\/ul>\r\n\r\n
\"\"<\/p>\r\n\r\n

 <\/p>\r\n\r\n

We ship with a USPS tracking number. Shipping takes between two and four weeks.<\/p>\r\n\r\n

 <\/p>\r\n\r\n

Click the ""Buy It Now<\/strong>"" button! Limited Quantity - Will sell out fast!<\/p>\r\n\r\n

 <\/p>\r\n\r\n

NOTE: This product is custom made and printed on demand and all sales are final.<\/p>",
         "link_rewrite":"g-logo-neck-gaiter",
         "meta_title":"Demo Backpack",
         "product_title":"G Logo Neck Gaiter",
         "product_url":"http:\/\/gkartv2.lc\/best-deals\/5-g-logo-neck-gaiter",
         "manufacturer_name":"samplebuilder.groovekart.com",
         "vendor":"samplebuilder.groovekart.com",
         "sku":"",
         "weight":"0.000000",
         "tags":"",
         "cover_image":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/5\/111115-cart_default.webp?v=1652618604",
         "images":[
            {
               "id":"111115",
               "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/5\/111115-cart_default.webp?v=1652618604"
            }
         ],
         "variants":[
            {
               "id_product_variant":"20",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"All Over Backpack - Backpack 1",
               "reference":"CASB077-799326",
               "price":"49.950000",
               "compare_price":"99.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":"1",
               "image":{
                  "id":"111115",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/5\/111115.jpg"
               }
            }
         ]
      },
      {
         "id":"4",
         "id_manufacturer":"1",
         "id_category_default":"25",
         "price":"0.000000",
         "compare_default_price":"0.000000",
         "status":"1",
         "available_for_order":"1",
         "visibility":"both",
         "date_add":"2020-03-27 05:31:56",
         "date_upd":"2020-10-06 08:11:41",
         "description":"

\r\n
50% OFF SUPER SALE!<\/strong><\/p>\r\n\r\n

\r\n\t
Full canvas double sided print with rounded toe construction.<\/li>\r\n\t
Lace-up closure for a snug fit.<\/li>\r\n\t
Metal eyelet for a classic look.<\/li>\r\n\t
Soft textile lining with lightweight construction for maximum comfort.<\/li>\r\n\t
High-quality outsole for traction and exceptional durability.<\/li>\r\n<\/ul>\r\n\r\n
\r\n<\/ul>\r\n\r\n

\r\n\"\"<\/p>\r\n\r\n

\"\"<\/p>\r\n<\/div>",
         "link_rewrite":"this-guy-loves-to-groove-backpack",
         "meta_title":"Mens Hightop - White",
         "product_title":"This guy loves to Groove Backpack",
         "product_url":"http:\/\/gkartv2.lc\/best-deals\/4-this-guy-loves-to-groove-backpack",
         "manufacturer_name":"samplebuilder.groovekart.com",
         "vendor":"samplebuilder.groovekart.com",
         "sku":"",
         "weight":"0.000000",
         "tags":"",
         "cover_image":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114-cart_default.webp?v=1652618604",
         "images":[
            {
               "id":"111114",
               "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114-cart_default.webp?v=1652618604"
            }
         ],
         "variants":[
            {
               "id_product_variant":"13",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Hightop - White",
               "reference":"CASCS37-799319",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":"1",
               "image":{
                  "id":"111114",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114.jpg"
               }
            },
            {
               "id_product_variant":"13",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US8 (EU40)",
               "reference":"CASCS37-799319",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":"1",
               "image":{
                  "id":"111114",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114.jpg"
               }
            },
            {
               "id_product_variant":"14",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Hightop - White",
               "reference":"CASCS37-799320",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111114",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114.jpg"
               }
            },
            {
               "id_product_variant":"14",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US9 (EU41)",
               "reference":"CASCS37-799320",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111114",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114.jpg"
               }
            },
            {
               "id_product_variant":"15",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Hightop - White",
               "reference":"CASCS37-799321",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111114",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114.jpg"
               }
            },
            {
               "id_product_variant":"15",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US10 (EU42)",
               "reference":"CASCS37-799321",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111114",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114.jpg"
               }
            },
            {
               "id_product_variant":"16",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Hightop - White",
               "reference":"CASCS37-799322",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111114",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114.jpg"
               }
            },
            {
               "id_product_variant":"16",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US11 (EU43)",
               "reference":"CASCS37-799322",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111114",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114.jpg"
               }
            },
            {
               "id_product_variant":"17",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Hightop - White",
               "reference":"CASCS37-799323",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111114",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114.jpg"
               }
            },
            {
               "id_product_variant":"17",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US12 (EU44)",
               "reference":"CASCS37-799323",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111114",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114.jpg"
               }
            },
            {
               "id_product_variant":"18",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Hightop - White",
               "reference":"CASCS65-799324",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111114",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114.jpg"
               }
            },
            {
               "id_product_variant":"18",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US13 (EU45)",
               "reference":"CASCS65-799324",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111114",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114.jpg"
               }
            },
            {
               "id_product_variant":"19",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Hightop - White",
               "reference":"CASCS65-799325",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111114",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114.jpg"
               }
            },
            {
               "id_product_variant":"19",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US14 (EU46)",
               "reference":"CASCS65-799325",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111114",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/4\/111114.jpg"
               }
            }
         ]
      },
      {
         "id":"3",
         "id_manufacturer":"1",
         "id_category_default":"25",
         "price":"0.000000",
         "compare_default_price":"0.000000",
         "status":"1",
         "available_for_order":"1",
         "visibility":"both",
         "date_add":"2020-03-27 05:30:47",
         "date_upd":"2020-10-06 08:08:31",
         "description":"

\r\n
Limited Edition - 50% OFF FLASH SALE!<\/p>\r\n\r\n

75% Polyester, 10%cotton, 10% chinlon, 5% spandex, for Adult
\r\nMade from high quality polyester, it will give you maximum comfort and soft simultaneously.
\r\nThese socks are unisex. Dimensions: 15.35"(L) x 3.54"(W).
\r\nCold wash with like colors and hang dry.<\/p>\r\n<\/div>",
         "link_rewrite":"this-guy-loves-to-groove",
         "meta_title":"Demo Socks",
         "product_title":"This Guy Loves to Groove",
         "product_url":"http:\/\/gkartv2.lc\/best-deals\/3-this-guy-loves-to-groove",
         "manufacturer_name":"samplebuilder.groovekart.com",
         "vendor":"samplebuilder.groovekart.com",
         "sku":"",
         "weight":"0.000000",
         "tags":"",
         "cover_image":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/3\/111113-cart_default.webp?v=1652618604",
         "images":[
            {
               "id":"111113",
               "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/3\/111113-cart_default.webp?v=1652618604"
            }
         ],
         "variants":[
            {
               "id_product_variant":"11",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Demo Socks",
               "reference":"CHMS01-799317",
               "price":"14.950000",
               "compare_price":"29.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":"1",
               "image":{
                  "id":"111113",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/3\/111113.jpg"
               }
            },
            {
               "id_product_variant":"11",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"Small\/Medium",
               "reference":"CHMS01-799317",
               "price":"14.950000",
               "compare_price":"29.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":"1",
               "image":{
                  "id":"111113",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/3\/111113.jpg"
               }
            },
            {
               "id_product_variant":"12",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Demo Socks",
               "reference":"CHMS01-799318",
               "price":"14.950000",
               "compare_price":"29.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111113",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/3\/111113.jpg"
               }
            },
            {
               "id_product_variant":"12",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"Large\/X-Large",
               "reference":"CHMS01-799318",
               "price":"14.950000",
               "compare_price":"29.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0,
               "image":{
                  "id":"111113",
                  "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/3\/111113.jpg"
               }
            }
         ]
      },
      {
         "id":"2",
         "id_manufacturer":"1",
         "id_category_default":"25",
         "price":"0.000000",
         "compare_default_price":"0.000000",
         "status":"1",
         "available_for_order":"1",
         "visibility":"both",
         "date_add":"2020-03-27 05:29:39",
         "date_upd":"2020-10-06 07:46:03",
         "description":"

\r\n
International Shipping<\/strong><\/em>
YES we ship worldwide for the same low price.<\/p>\r\nHandmade Premium Sneakers<\/strong>\r\n

\r\n
23.07 Oz. Designed for fashion men, stylish and personalized.<\/li>\r\n
Polyester and spandex material upper, with soft foam, offers good foot feels.<\/li>\r\n
Unbelievably lightweight & durable.<\/li>\r\n
EVA sole, shake-proof, anti-heat, anti-moisture, anti-corrosion, non-slip, easy cleaning.<\/li>\r\n
Ergonomically streamlined foot curve, wearing soft and comfortable.<\/li>\r\n
Ideal as both running & casual shoes.<\/li>\r\n<\/ul>\r\n<\/div>",
         "link_rewrite":"this-girl-loves-to-groove",
         "meta_title":"Demo Mens Sneakers",
         "product_title":"This Girl Loves To Groove",
         "product_url":"http:\/\/gkartv2.lc\/best-deals\/2-this-girl-loves-to-groove",
         "manufacturer_name":"samplebuilder.groovekart.com",
         "vendor":"samplebuilder.groovekart.com",
         "sku":"",
         "weight":"0.000000",
         "tags":"",
         "cover_image":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/2\/111112-cart_default.webp?v=1652618604",
         "images":[
            {
               "id":"111112",
               "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/2\/111112-cart_default.webp?v=1652618604"
            }
         ],
         "variants":[
            {
               "id_product_variant":"1",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Sneakers - White",
               "reference":"CASCS32-799307",
               "price":"69.950000",
               "compare_price":"219.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":"1"
            },
            {
               "id_product_variant":"1",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US6 (EU39)",
               "reference":"CASCS32-799307",
               "price":"69.950000",
               "compare_price":"219.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":"1"
            },
            {
               "id_product_variant":"2",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Sneakers - White",
               "reference":"CASCS32-799308",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"2",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US7 (EU40)",
               "reference":"CASCS32-799308",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"3",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Sneakers - White",
               "reference":"CASCS32-799309",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"3",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US8 (EU41)",
               "reference":"CASCS32-799309",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"4",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Sneakers - White",
               "reference":"CASCS32-799310",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"4",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US9 (EU42)",
               "reference":"CASCS32-799310",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"5",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Sneakers - White",
               "reference":"CASCS32-799311",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"5",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US10 (EU43)",
               "reference":"CASCS32-799311",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"6",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Sneakers - White",
               "reference":"CASCS32-799312",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"6",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US11 (EU44)",
               "reference":"CASCS32-799312",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"7",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Sneakers - White",
               "reference":"CASCS32-799313",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"7",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US12 (EU45)",
               "reference":"CASCS32-799313",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"8",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Sneakers - White",
               "reference":"CASCS32-799314",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"8",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US13 (EU46)",
               "reference":"CASCS32-799314",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"9",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Sneakers - White",
               "reference":"CASCS32-799315",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"9",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US14 (EU47)",
               "reference":"CASCS32-799315",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"10",
               "group_name":"Style",
               "id_variant_group":"7",
               "variant_name":"Mens Sneakers - White",
               "reference":"CASCS32-799316",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            },
            {
               "id_product_variant":"10",
               "group_name":"Size",
               "id_variant_group":"8",
               "variant_name":"US15 (EU48)",
               "reference":"CASCS32-799316",
               "price":"59.950000",
               "compare_price":"119.91",
               "quantity":20,
               "weight":"0.000000",
               "default_on":0
            }
         ]
      }
   ]
}
Response: Failed
JSON
{
	"error": "No products found."
}

Get Product Details

To get the details of a particular product, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • product

    type: array

    value: product ID

    required: yes

Returns

Returns the details of a product.

Request
POST/JSON

Endpoint: https://STORE-URL/api/products.json

{
   "auth_token": "AUTH-TOKEN",
   "api_key": "API-KEY",
   "api_user": "VENDOR-NAME", //e.g. teescape
   "product":{
      "id":8
   }
}
Response: Success
JSON
{
   "product":{
      "id_category_default":"25",
      "title":"API Test Product",
      "description":"product description for Blue tshirt.",
      "price":"0.000000",
      "compare_default_price":"0.000000",
      "weight":"0.000000",
      "manufacturer_name":null,
      "vendor":null,
      "sku":"",
      "status":"1",
      "available_for_order":"1",
      "visibility":"both",
      "date_add":"2022-05-15 07:19:52",
      "date_upd":"2022-05-15 07:19:52",
      "link_rewrite":"api-test-product",
      "meta_title":"",
      "product_url":"http:\/\/gkartv2.lc\/best-deals\/8-api-test-product",
      "cover_image":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/8\/111118-cart_default.webp?v=1652619439",
      "images":[
         {
            "id":"111118",
            "url":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/8\/111118-cart_default.webp?v=1652619439"
         }
      ],
      "tags":"tag1,tag2,tag3,tag4",
      "variants":[
         {
            "id_product_attribute":"26",
            "group_name":"Style",
            "attribute_name":"Short Collor",
            "reference":"TS.12345678",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.370000",
            "image":null
         },
         {
            "id_product_attribute":"26",
            "group_name":"Size",
            "attribute_name":"1XL",
            "reference":"TS.12345678",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.370000",
            "image":null
         },
         {
            "id_product_attribute":"26",
            "group_name":"Color",
            "attribute_name":"Blue",
            "reference":"TS.12345678",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.370000",
            "image":null
         },
         {
            "id_product_attribute":"26",
            "group_name":"Cloth",
            "attribute_name":"Cotton",
            "reference":"TS.12345678",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.370000",
            "image":null
         },
         {
            "id_product_attribute":"27",
            "group_name":"Style",
            "attribute_name":"Lesbo",
            "reference":"TS.12345679",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.430000",
            "image":null
         },
         {
            "id_product_attribute":"27",
            "group_name":"Size",
            "attribute_name":"2XL",
            "reference":"TS.12345679",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.430000",
            "image":null
         },
         {
            "id_product_attribute":"27",
            "group_name":"Color",
            "attribute_name":"Lime",
            "reference":"TS.12345679",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.430000",
            "image":null
         },
         {
            "id_product_attribute":"27",
            "group_name":"Cloth",
            "attribute_name":"Cotton",
            "reference":"TS.12345679",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.430000",
            "image":null
         },
         {
            "id_product_attribute":"28",
            "group_name":"Style",
            "attribute_name":"Gay",
            "reference":"TS.12345680",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.370000",
            "image":null
         },
         {
            "id_product_attribute":"28",
            "group_name":"Size",
            "attribute_name":"1XL",
            "reference":"TS.12345680",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.370000",
            "image":null
         },
         {
            "id_product_attribute":"28",
            "group_name":"Color",
            "attribute_name":"Teal",
            "reference":"TS.12345680",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.370000",
            "image":null
         },
         {
            "id_product_attribute":"28",
            "group_name":"Type",
            "attribute_name":"Lenin",
            "reference":"TS.12345680",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.370000",
            "image":null
         },
         {
            "id_product_attribute":"29",
            "group_name":"Style",
            "attribute_name":"Gay",
            "reference":"TS.12345681",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.430000",
            "image":null
         },
         {
            "id_product_attribute":"29",
            "group_name":"Size",
            "attribute_name":"2XL",
            "reference":"TS.12345681",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.430000",
            "image":null
         },
         {
            "id_product_attribute":"29",
            "group_name":"Color",
            "attribute_name":"Teal",
            "reference":"TS.12345681",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.430000",
            "image":null
         },
         {
            "id_product_attribute":"29",
            "group_name":"Type",
            "attribute_name":"Lenin",
            "reference":"TS.12345681",
            "price":"24.990000",
            "compare_price":"29.99",
            "quantity":20,
            "weight":"0.430000",
            "image":null
         }
      ]
   }
}
Response: Failed
JSON
{
	"error": "Product not found."
}

Update Product

To update details of a product, given below instructions can be followed:

Allowed to update

title, description, vendor, price, compare_default_price, sku and tags.

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • product

    type: array

    value: array of product data

    required: yes

    Array data

    • action

      type: string

      value: update_product

      required: yes

    • id

      type: int

      value: target product id

      required: yes

    • title

      type: string

      value: product title

      required: no

      info: No special characters allowed

    • description

      type: string/html

      value: product description

      required: no

    • vendor

      type: string

      value: product vendor name

      required: no

      info: No special characters allowed

    • compare_default_price

      type: int/float

      value: product compared price

      required: no

    • price

      type: int/float

      value: product price

      required: no

    • sku

      type: string

      value: product SKU

      required: no

    • tags

      type: array

      value: product tags data

      required: no

      Array data

      • delete_existing

        type: bool

        value: true or false

        required: no

        info: if true, existing tags will be deleted.

      • tags_list

        type: string

        value: comma separated list of tags

        required: yes

        info: No special characters allowed

Returns

Returns true or false.

Request
POST/JSON

Endpoint: https://STORE-URL/api/products.json

{
   "auth_token": "AUTH-TOKEN",
   "api_key": "API-KEY",
   "api_user": "VENDOR-NAME", //e.g. teescape
   "product":{
      "action":"update_product",
      "id":8,
      "title":"Product Title NEw",
      "description":"New description for the product.",
      "vendor":"New Vendor",
      "price":85,
      "compare_default_price":95,
      "sku":"NEWPRODUCTSKUREF",
      "tags":{
         "delete_existing":true,
         "tags_list":"newtag1,newtag2,newtag3,newtag4"
      }
   }
}
Response: Success
JSON
{
	"status": "success",
}
Response: Failed
JSON
{
	"error": "failed",
}

Add Product Image

To add image to an existing product, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • product

    type: array

    value: array of product data

    required: yes

    Array data

    • id

      type: int

      value: target product id

      required: yes

    • image

      type: array

      value: product tags data

      required: no

      Array data

      • src

        type: string

        value: image url

        required: yes

      • position

        type: int

        value: image position

        required: yes

        default: 0

Returns

Returns boolean status with image id.

Request
POST/JSON

Endpoint: https://STORE-URL/api/products.json

{
   "auth_token": "AUTH-TOKEN",
   "api_key": "API-KEY",
   "api_user": "VENDOR-NAME", //e.g. teescape
   "product":{
      "id":8,
      "image":{
         "src":"http:\/\/pluspng.com\/img-png\/tshirt-png-black-t-shirt-png-transparent-image-2611.png",
         "position":0
      }
   }
}
Response: Success
JSON
{
	"status":"success",
	"id_image":"111119"
}
Response: Failed
JSON
{
	"error": "Failed to upload image",
}

Replace Product Image

To replace image for an existing product, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • product

    type: array

    value: array of product data

    required: yes

    Array data

    • action

      type: string

      value: replace_image

      required: yes

    • product_id

      type: int

      value: target product id

      required: yes

    • image_id

      type: int

      value: image id

      required: yes

    • image

      type: array

      value: product tags data

      required: no

      Array data

      • src

        type: string

        value: image url

        required: yes

      • position

        type: int

        value: image position

        required: yes

        default: 0

      • cover

        type: bool

        value: true to set image as product cover image.

        required: no

        default: 0

Returns

Returns boolean status with image id.

Request
POST/JSON

Endpoint: https://STORE-URL/api/products.json

{
   "auth_token": "AUTH-TOKEN",
   "api_key": "API-KEY",
   "api_user": "VENDOR-NAME", //e.g. teescape
   "product":{
      "action":"replace_image",
      "product_id":8,
      "image_id":111119,
      "image":{
         "src":"https://shopifiedapp-uploads-dev-789552.s3.amazonaws.com/uploads/u1/41d88982d1660fa91ae7adc9834b31bb.jpg",
         "position":0,
         "cover":0
      }
   }
}
Response: Success
JSON
{
	"status":"success",
	"id_image":"111119"
}
Response: Failed
JSON

if existing image id not found.

{ "error": "Image not found for id ", } { "error": "Failed to upload image", }

Activate or Deactivate Product

To activate or deactivate an existing product, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • product

    type: array

    value: array of product data

    required: yes

    Array data

    • action

      type: string

      value: product_status

      required: yes

    • id

      type: int

      value: target product id

      required: yes

    • active

      type: bool

      value: true or false

      required: yes

Returns

Returns boolean status with image id.

Request
POST/JSON

Endpoint: https://STORE-URL/api/products.json

{
   "auth_token": "AUTH-TOKEN",
   "api_key": "API-KEY",
   "api_user": "VENDOR-NAME", //e.g. teescape
   "product":{
      "id":8,
      "action":"product_status",
      "active":false
   }
}
Response: Success
JSON
{
	"status": "success",
	"statusTxt": "product deactivated"
}
Response: Failed
JSON
{
	"status": "failed",
	"error": "Failed to update product status."
	"statusTxt": null
}

Add Product Tags

To add tags to an existing product, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • product

    type: array

    value: array of product data

    required: yes

    Array data

    • action

      type: string

      value: add_tags

      required: yes

    • id

      type: int

      value: target product id

      required: yes

    • delete_existing

      type: bool

      value: true or false

      required: no

    • tags

      type: string

      value: comma separated list of tags.

      required: es

      info: no special characters allowed.

Returns

Returns boolean status.

Request
POST/JSON

Endpoint: https://STORE-URL/api/products.json

{
   "auth_token": "AUTH-TOKEN",
   "api_key": "API-KEY",
   "api_user": "VENDOR-NAME", //e.g. teescape
   "product":{
      "action":"add_tags",
      "id":8,
      "delete_existing":true,
      "tags":"tag1, tag2, tag3"
   }
}
Response: Success
JSON
{
	"status": "success",
}
Response: Failed
JSON
{
	"error": "Tags supplied may exists already."
}

Delete Product Tags

To delete tags from an existing product, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • product

    type: array

    value: array of product data

    required: yes

    Array data

    • action

      type: string

      value: delete_tags

      required: yes

    • id

      type: int

      value: target product id

      required: yes

Returns

Returns boolean status.

Request
POST/JSON

Endpoint: https://STORE-URL/api/products.json

{
   "auth_token": "AUTH-TOKEN",
   "api_key": "API-KEY",
   "api_user": "VENDOR-NAME", //e.g. teescape
   "product":{
      "action":"delete_tags",
      "id":8
   }
}
Response: Success
JSON
{
	"status": "success",
}
Response: Failed
JSON
{
	"error": "Failed to delete tags."
}

Variants

This section of API allows to perform following variants related actions on a GrooveKart store:

  • Create Variant Groups
  • Get Variant Groups
  • Add Product Variants
  • Add Variant Image
  • Delete Variant Image
  • Update Product Variants
  • Delete Product Variants
Endpoints

POST https://STORE-URL/api/variant_groups.json

POST https://STORE-URL/api/variants.json

Create Variant Groups

To create a variant groups, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: add_variant_groups

    required: yes

  • variant_groups

    type: array

    value: product variants groups data

    required: no

    Variant Groups data

    • name

      type: string

      value: variant group type e.g. Color, Style, Size etc.

      required: yes

    • group_type

      type: string

      value: variant group type e.g. color or select

      required: yes

      default: "select"

Returns

Returns boolean response.

Request
POST/JSON

Endpoint: https://STORE-URL/api/variant_groups.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
   	"action":"add_variant_groups",
	"variant_groups":[
	  {
	     "name":"Type",
	     "group_type":"select"
	  },
	  {
	     "name":"Style",
	     "group_type":"select"
	  },
	  {
	     "name":"Color",
	     "group_type":"color"
	  },
	  {
	     "name":"Size",
	     "group_type":"select"
	  }
	]
}
Response: Success
JSON
{
	"status": "success"
}
Response: Failed
JSON
{
	"error": "Variant Groups data not sent."
}

Get Variant Groups

To get the list of existing variant groups, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: list_variant_groups

    required: yes

Returns

Returns the array list of variant groups data.

Request
POST/JSON

Endpoint: https://STORE-URL/api/variant_groups.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
   	"action":"list_variant_groups",
}
Response: Success
JSON
[
   {
      "id_attribute_group":"6",
      "name":"Color",
      "public_name":"Color",
      "group_type":"radio"
   },
   {
      "id_attribute_group":"8",
      "name":"Size",
      "public_name":"Size",
      "group_type":"radio"
   },
   {
      "id_attribute_group":"7",
      "name":"Style",
      "public_name":"Style",
      "group_type":"radio"
   }
]
Response: Failed
JSON
{
	"error": "Variant Groups not found."
}

Add Product Variants

To add variants to an existing product, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: add

    required: yes

  • product_id

    type: int

    value: id of target product

    required: yes

  • image_id

    type: int

    value: id of an existing image

    required: no

    default: 0

  • variants

    type: array

    value: product variants data

    required: yes

    Variants data

    • variant_values

      type: array

      value: variant details

      required: yes

      Variant values data

      • Color

        type: array

        value: variant type details

        required: yes

        • variant_group_type

          type: string

          value: group type value e.g. color

          required: yes

        • variant_name

          type: string

          value: variant name e.g. Blue

          required: yes

        • texture/color

          type: string

          value: if color then color hex code or if texture then image url should be provided

          required: yes

    • compare_at_price

      type: float

      value: variant compared price

      required: yes

    • price

      type: float

      value: variant price

      required: yes

    • sku

      type: string

      value: variant SKU

      required: no

    • weight

      type: int/float

      value: variant weight

      required: no

    • weight_unit

      type: string

      value: variant weight unit e.g. lb

      required: no

    • default_on

      type: bool

      value: default variant for product e.g. 1 or 0

      required: yes

      info: only one variant can have value = 1.

Returns

Returns the array list of variant groups data.

Request
POST/JSON

Endpoint: https://STORE-URL/api/variants.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"action":"add",
	"product_id":8,
	"image_id":0,
	"variants":[
	  {
	     "variant_values":{
	        "Color":{
	           "variant_group_type":"color",
	           "variant_name":"Red",
	           "texture":"https:\/\/www.colorcombos.com\/images\/colors\/FF0000.png"
	        }
	     },
	     "compare_at_price":"30",
	     "weight":"0.35",
	     "weight_unit":"lb",
	     "price":"25",
	     "sku":"TS.21233323",
	     "default_on":0
	  }
	]
}
Response: Success
JSON
[
   {
      "id_attribute_group":"6",
      "name":"Color",
      "public_name":"Color",
      "group_type":"radio"
   },
   {
      "id_attribute_group":"8",
      "name":"Size",
      "public_name":"Size",
      "group_type":"radio"
   },
   {
      "id_attribute_group":"7",
      "name":"Style",
      "public_name":"Style",
      "group_type":"radio"
   }
]
Response: Failed
JSON
{
	"error": "Variant Groups not found."
}

Update Product Variants

To update data of existing variants, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: update

    required: yes

  • product_id

    type: int

    value: id of target product

    required: yes

  • variants

    type: array

    value: variants list with data

    required: yes

    Variants data

    • id

      type: int

      value: variant id

      required: yes

    • compare_at_price

      type: float

      value: variant compared price

      required: yes

    • price

      type: float

      value: variant price

      required: yes

    • sku

      type: string

      value: variant SKU

      required: no

    • weight

      type: int/float

      value: variant weight

      required: no

    • image_id

      type: array (numeric)

      value: single id or list of image IDs

      required: yes if images needs to be assigned

    • default_on

      type: bool

      value: default variant for product e.g. 1 or 0

      required: yes

      info: only one variant can have value = 1.

    • update_all_fields

      type: boolean

      value: true or false

Returns

Returns success or failed status with message.

Request
POST/JSON

Endpoint: https://STORE-URL/api/variants.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"product_id":8,
	"action":"update",
	"product_id":7,
	"variants":[
	  {
	     "id":29,
	     "compare_at_price":"29",
	     "price":"28",
	     "sku":"TS.21233319",
	     "weight":"0.35",
	     "image_id":[
	        111118
	     ],
	     "default_on":1,
	     "update_all_fields":true
	  },
	  {
	     "id":30,
	     "compare_at_price":"29",
	     "price":"28",
	     "sku":"TS.21233320",
	     "weight":"0.35",
	     "image_id":[
	        111118
	     ],
	     "default_on":0,
	     "update_all_fields":true
	  }
	]
}
Response: Success
JSON
{
	"status": "success",
	"message": "Variants are updated."
}
Response: Failed
JSON
{
	"status": "error",
	"message": "Product id or variants data is missing."
}
OR
{
	"status": "error",
	"message": "Failed to update variants."
}

Add Variants Image

To assign an image to existing variants, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • variants

    type: array(numeric)

    value: single variant id or list of existing variant IDs

    required: yes

  • image_id

    type: array (numeric)

    value: single image id or list of existing images IDs

    required: no

    default: 0

Returns

Returns success or failed response with message.

Request
POST/JSON

Endpoint: https://STORE-URL/api/variants.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"variants":[
	  26,
	  27,
	  28
	],
	"image_id":[
	  111118
	]
}
Response: Success
JSON
{
  "status": "success",
  "message":"Image assigned to variants."
}
Response: Failed
JSON
{
  "status": "error",
  "message":"Variant id or image id not provided."
}

Delete Variants Image

To unassign an image from variants, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: delete_image

    required: yes

  • variants

    type: array(numeric)

    value: single variant id or list of existing variant IDs

    required: yes

  • image_id

    type: array (numeric)

    value: single image id or list of existing images IDs

    required: no

    default: 0

Returns

Returns success or failed response with message.

Request
POST/JSON

Endpoint: https://STORE-URL/api/variants.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"action":"delete_image",
	"variants":[
	  26,
	  27,
	  28
	],
	"image_id":[
	  111118
	]
}
Response: Success
JSON
{
  "status": "success",
  "message":"Image deleted from variants."
}
Response: Failed
JSON
{
  "status": "error",
  "message":"Variant id or image id not provided."
}
OR
{
  "status": "error",
  "message":"Variant image combination does not exists or unkonwn error."
}

Delete Variants

To delete existing variants assigned to a product, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: delete

    required: yes

  • product_id

    type: int

    value: id of target product

    required: yes

Returns

Returns success or failed response with message.

Request
POST/JSON

Endpoint: https://STORE-URL/api/variants.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"action":"delete",
	"product_id":8
}
Response: Success
JSON
{
  "status": "success",
  "message":"variants are deleted."
}
Response: Failed
JSON
{
  "status": "error",
  "message":"Product id is missing."
}
OR
{
  "status": "error",
  "message":"Failed to delete variants."
}

Orders

This section of API allows to perform following orders related actions on a GrooveKart store:

  • Get Orders Count
  • Get Orders
  • Search Orders
  • Get Order Details
  • Get Order Returns/Refunds
  • Add Order Nnote
  • Get Order Nnote
  • Update Order Nnote
  • Delete Order Nnote
Endpoints

POST https://STORE-URL/api/orders.json

Get Orders Count

To get count of existing orders, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: orders_count

    required: yes

  • order_status

    type: int

    value: order status type id

    required: yes

    Info: 2(Payment accepted), 3(Processing in progress), 4(Shipped), 5(Delivered), 6(Canceled), 7(Refunded) OR 0 for all

  • limit

    type: int

    value: limit value for sql query

    required: no

    info: 0 for all

  • offset

    type: int

    value: start sql selection from

    required: no

    info: 0 to start from first row

  • order_by

    type: string

    value: order results by column

    required: no

    info: id_order, date_add, date_upd, delivery_date

  • order_way

    type: string

    value: ASC OR DESC

    required: no

    default: DESC

Returns

Returns count of orders.

Request
POST/JSON

Endpoint: https://STORE-URL/api/orders.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"action":"orders_count",
	"order_status":3,
	"limit":0,
	"offset":0,
	"order_by":"date_add",
	"order_way":"ASC"
}
Response: Success
JSON
{
  "orders_count": 10,
}
Response: Failed
JSON
No errors except unexpected or system generated.

Get Orders Data

To get existing orders data, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • order_status

    type: int

    value: order status type id

    required: yes

    Info: 2(Payment accepted), 3(Processing in progress), 4(Shipped), 5(Delivered), 6(Canceled), 7(Refunded) OR 0 for all

  • limit

    type: int

    value: limit value for sql query

    required: no

    info: 0 for all

  • offset

    type: int

    value: start sql selection from

    required: no

    info: 0 to start from first row

  • order_by

    type: string

    value: order results by column

    required: no

    info: id_order, date_add, date_upd, delivery_date

  • order_way

    type: string

    value: ASC OR DESC

    required: no

    default: DESC

Returns

Returns list of orders with data.

Request
POST/JSON

Endpoint: https://STORE-URL/api/orders.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"order_status":2,
	"limit":0,
	"offset":0,
	"order_by":"delivery_date",
	"order_way":"DESC"
}
Response: Success
JSON
{
   "orders":[
      {
         "id":"1",
         "reference":"VBBPTZHCN",
         "created_at":"2022-05-28 09:33:38",
         "note":"",
         "private_note":"",
         "currency":"USD",
         "total_price":"14.950000",
         "order_status":"Payment accepted",
         "trackings":[
            
         ],
         "line_items":[
            {
               "id":"1",
               "product_id":"3",
               "sku":"CHMS01-799317",
               "vendor":"samplebuilder.groovekart.com",
               "name":"This Guy Loves to Groove - Style : Demo Socks, Size : Small\/Medium",
               "price":14.95,
               "quantity":"1",
               "variants":{
                  "variant_id":"11",
                  "image":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/3\/111113.jpg",
                  "options":[
                     {
                        "type":"Style",
                        "value":"Demo Socks"
                     },
                     {
                        "type":"Size",
                        "value":"Small\/Medium"
                     }
                  ]
               }
            }
         ],
         "customer":{
            "first_name":"firstname",
            "last_name":"lastname",
            "email":"customer@domain.com"
         },
         "shipping_address":{
            "first_name":"firstname",
            "last_name":"lastname",
            "address1":"Ave. 76",
            "phone":"1",
            "city":"Birmingham",
            "zip":"35008",
            "province":"Alabama",
            "country":"United States",
            "country_code":"US"
         }
      }
   ]
}

IF not available

{
	"status":"success",
	"orders":[]
}
Response: Failed
JSON
No errors except unexpected or system generated.

Search Orders

To search orders, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: search_orders

    required: yes

  • ids

    type: string

    value: id or IDs of orders e.g. 1 or 1,2,3,4

    required: no

  • reference

    type: string

    value: part of or complete order refernce

    required: no

  • product_id

    type: string

    value: id or IDs of products e.g. 1 or 1,2,3,4

    required: no

  • order_status

    type: int

    value: order status type id

    required: yes

    Info: 2(Payment accepted), 3(Processing in progress), 4(Shipped), 5(Delivered), 6(Canceled), 7(Refunded) OR 0 for all

  • created_at_min

    type: string

    value: date string in format Y-m-d e.g. 2018-03-10

    required: no

  • created_at_max

    type: string

    value: date string in format Y-m-d e.g. 2018-04-22

    required: no

  • country_code

    type: string

    value: country code e.g. US, UK, HK etc.

    required: no

  • limit

    type: int

    value: limit value for sql query

    required: no

    info: 0 for all

  • offset

    type: int

    value: start sql selection from

    required: no

    info: 0 to start from first row

  • order_by

    type: string

    value: order results by column

    required: no

    info: id_order, date_add, date_upd, delivery_date

  • order_way

    type: string

    value: ASC OR DESC

    required: no

    default: DESC

Returns

Returns orders list with data.

Request
POST/JSON

Endpoint: https://STORE-URL/api/orders.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"action":"search_orders",
	"ids":1273,
	"reference":"",
	"product_id":"",
	"order_status":"",
	"created_at_min":"",
	"created_at_max":"",
	"country_code":"US",
	"limit":0,
	"offset":0,
	"order_by":"id_order",
	"order_way":"ASC"
}
Response: Success
JSON
{
   "orders":[
      {
         "id":"1",
         "reference":"VBBPTZHCN",
         "created_at":"2022-05-28 09:33:38",
         "note":"",
         "private_note":"",
         "currency":null,
         "total_price":"14.950000",
         "order_status":"Payment accepted",
         "trackings":[
            
         ],
         "line_items":[
            {
               "id":"1",
               "product_id":"3",
               "sku":"CHMS01-799317",
               "vendor":"samplebuilder.groovekart.com",
               "name":"This Guy Loves to Groove - Style : Demo Socks, Size : Small\/Medium",
               "price":14.95,
               "quantity":"1",
               "variants":{
                  "variant_id":"11",
                  "image":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/3\/111113.jpg",
                  "options":[
                     {
                        "type":"Style",
                        "value":"Demo Socks"
                     },
                     {
                        "type":"Size",
                        "value":"Small\/Medium"
                     }
                  ]
               }
            }
         ],
         "customer":{
            "first_name":"firstname",
            "last_name":"lastname",
            "email":"customer@domain.com"
         },
         "shipping_address":{
            "first_name":"firstname",
            "last_name":"lastname",
            "address1":"Ave. 76",
            "phone":"1",
            "city":"Birmingham",
            "zip":"35008",
            "province":"Alabama",
            "country":"United States",
            "country_code":"US"
         }
      }
   ],
   "orders_count":1
}

If not found

{
	"status":"success",
	"orders":[]
}
Response: Failed
JSON
No errors except unexpected or system generated.

Get Order Details

To details of an existing orders, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • order_id

    type: int

    value: id of an existing order

    required: yes

Returns

Returns array of order details.

Request
POST/JSON

Endpoint: https://STORE-URL/api/orders.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"order_id":1
}
Response: Success
JSON
{
   "id":1,
   "reference":"VBBPTZHCN",
   "created_at":"2022-05-28 09:33:38",
   "currency":"USD",
   "total_price":"14.950000",
   "order_status":"Payment accepted",
   "trackings":[
      
   ],
   "note":"",
   "private_note":"",
   "billing_address":{
      "name":"firstname lastname",
      "first_name":"firstname",
      "last_name":"lastname",
      "address1":"Ave. 76",
      "phone":"1",
      "city":"Birmingham",
      "zip":"35008",
      "province":"Alabama",
      "country":"United States",
      "country_code":"US"
   },
   "shipping_address":{
      "name":"firstname lastname",
      "first_name":"firstname",
      "last_name":"lastname",
      "address1":"Ave. 76",
      "phone":"1",
      "city":"Birmingham",
      "zip":"35008",
      "province":"Alabama",
      "country":"United States",
      "country_code":"US"
   },
   "line_items":[
      {
         "id":"1",
         "product_id":"3",
         "sku":"CHMS01-799317",
         "vendor":"samplebuilder.groovekart.com",
         "name":"This Guy Loves to Groove - Style : Demo Socks, Size : Small\/Medium",
         "price":14.95,
         "quantity":"1",
         "variants":{
            "variant_id":"11",
            "image":"https:\/\/cdn.groovekart.com\/xxxxxxxx\/img\/p\/1\/1\/1\/1\/1\/3\/111113.jpg",
            "options":[
               {
                  "type":"Style",
                  "value":"Demo Socks"
               },
               {
                  "type":"Size",
                  "value":"Small\/Medium"
               }
            ]
         }
      }
   ],
   "customer":{
      "first_name":"firstname",
      "last_name":"lastname"
   }
}
Response: Failed
JSON
{
	"status":"error",
	"message":"incorrect order id or order does not exist."
}

Get Order Refunds/Returns

To get order refunds/returns data, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: get_refunds

    required: yes

  • order_ids

    type: string

    value: id or IDs of orders e.g. 1 or 1,2,3,4

    required: no

  • created_at_min

    type: string

    value: date string in format Y-m-d e.g. 2018-03-10

    required: no

  • created_at_max

    type: string

    value: date string in format Y-m-d e.g. 2018-04-22

    required: no

  • limit

    type: int

    value: limit value for sql query

    required: no

    info: 0 for all

  • offset

    type: int

    value: start sql selection from

    required: no

    info: 0 to start from first row

  • order_by

    type: string

    value: order results by column

    required: no

    info: id_order, date_add, date_upd, delivery_date

  • order_way

    type: string

    value: ASC OR DESC

    required: no

    default: DESC

Returns

Returns order returns/refunds list with data.

Request
POST/JSON

Endpoint: https://STORE-URL/api/orders.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"action":"get_refunds",
	"order_ids":"1,2,3",
	"created_at_min":"",
	"created_at_max":"",
	"limit":0,
	"offset":0,
	"order_by":"id_order",
	"order_way":"ASC"
}
Response: Success
JSON
!!Returns data will be added shortly!!

If not found

{
	"status":"success",
	"order_returns":[]
}
Response: Failed
JSON
If order id not provided
{
	"status":"error",
	"message": "Order id(s) not provided."
}
OR if created_date_min is provided but missing created_date_max
{
	"status":"error",
	"message": "created_date_max is missing."
}
OR if created_date_min with incorrect format
{
	"status":"error",
	"message": "created_date_min format should be Y-m-d."
}
OR if created_at_max is provided but missing created_date_min
{
	"status":"error",
	"message": "created_date_min is missing."
}
OR if created_at_max with incorrect format
{
	"status":"error",
	"message": "created_at_max format should be Y-m-d."
}

Add Order Note

To add order note to an existing order, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: add_note

    required: yes

  • order_id

    type: int

    value: order id

    required: yes

  • note

    type: string

    value: order note text

    required: yes

Returns

Returns status with message.

Request
POST/JSON

Endpoint: https://STORE-URL/api/orders.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"action":"add_note",
	"order_id":1,
	"note":"This is simple text as note for order #1"
}
Response: Success
JSON
{
	"status":"success",
	"message": "Order note added"
}
OR 
{
	"status":"success",
	"message": "Order note updated"
}
Response: Failed
JSON
{
	"status":"error",
	"message":"Order id missing"
}
{
	"status":"error",
	"message":"Order note text is missing"
}
{
	"status":"error",
	"message":"Order not found with given id"
}
{
	"status":"error",
	"message":"Invalid note content"
}
{
	"status":"error",
	"message":"Failed to update order note"
}
{
	"status":"error",
	"message":"Failed to add order note"
}

Get Order Note

To get order note for existing order, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: get_note

    required: yes

  • order_id

    type: int

    value: order id

    required: yes

Returns

Returns order note details.

Request
POST/JSON

Endpoint: https://STORE-URL/api/orders.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"action":"get_note",
	"order_id":1
}
Response: Success
JSON
{
	"status":"success",
	"id_order": 1,
	"note": "This is simple text as note for order #1"
}
Response: Failed
JSON
{
	"status":"error",
	"message":"Order id missing"
}
{
	"status":"error",
	"message":"Order not found with given id"
}
{
	"status":"error",
	"id_order": 1,
	"message": "No note found"
}

Update Order Note

To update order note for an existing order, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: update_note

    required: yes

  • order_id

    type: int

    value: order id

    required: yes

  • note

    type: string

    value: order note text

    required: yes

Returns

Returns status with message.

Request
POST/JSON

Endpoint: https://STORE-URL/api/orders.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"action":"update_note",
	"order_id":1,
	"note":"Updated simple text as note for order #1"
}
Response: Success
JSON
{
	"status":"success",
	"message": "Order note updated"
}
Response: Failed
JSON
{
	"status":"error",
	"message":"Order id missing"
}
{
	"status":"error",
	"message":"Order note text is missing"
}
{
	"status":"error",
	"message":"Order not found with given id"
}
{
	"status":"error",
	"message":"Invalid note content"
}
{
	"status":"error",
	"message":"Failed to update order note"
}

Delete Order Note

To delete order note for existing order, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: delete_note

    required: yes

  • order_id

    type: int

    value: order id

    required: yes

Returns

Returns status with message.

Request
POST/JSON

Endpoint: https://STORE-URL/api/orders.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"action":"delete_note",
	"order_id":1
}
Response: Success
JSON
{
	"status":"success",
	"note": "Order note deleted"
}
Response: Failed
JSON
{
	"status":"error",
	"message":"Order id missing"
}
{
	"status":"error",
	"message":"Order not found with given id"
}
{
	"status":"error",
	"id_order": 1,
	"message": "No note found"
}
{
	"status":"error",
	"message":"Failed to delete order note"
}

Shipping/Tracking

This section of API allows to perform following orders shipment/tracking related actions on a GrooveKart store:

  • Get Shipping Methods
  • Update Order Tracking
Endpoints

POST https://STORE-URL/api/shipping.json

POST https://STORE-URL/api/tracking.json

Get Shipping Methods

To get shipping methods data, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: get_shipping

    required: yes

Returns

Returns shipping methods data.

Request
POST/JSON

Endpoint: https://STORE-URL/api/shipping.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"action":"get_shipping",
}
Response: Success
JSON
{
   "shipping_methods":[
      {
         "id_carrier":"1",
         "name":"samplebuilder",
         "url":"https://t.17track.net/ru#nums=@",
         "active":"1",
         "shipping_handling":"0",
         "is_free":"1",
         "max_width":"0",
         "max_height":"0",
         "max_depth":"0",
         "max_weight":"0.000000",
         "description":"Fast shipping"
      }
   ]
}
Response: Failed
JSON
{
	"status":"error",
	"message":"Shipping methods not found."
}

Update Order Shipment Tracking

To update order shipment tracking info, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • order_id

    type: int

    value: id of order

    required: yes

  • tracking_number

    type: string

    value: tracking number/string

    required: yes

  • note

    type: string

    value: order note text message

    required: no

  • send_email

    type: boolean

    value: whether to send an email to customer or not

    required: no

    default: true

Returns

Returns status with message.

Request
POST/JSON

Endpoint: https://STORE-URL/api/trackings.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"order_id":1,
	"tracking_number":"TESTRNUM25215",
	"note":"order note with tracking #TESTRNUM25215",
	"send_email":true
}
Response: Success
JSON
{
   "status": "success"
   "message": "Tracking updated and email sent to customer"
}
OR
{
   "status": "success"
   "message": "Tracking updated and email not sent to customer"
}
Response: Failed
JSON
{
	"status":"error",
	"message":"Order id is missing"
}
{
	"status":"error",
	"message":"Tracking number is missing"
}

Webhooks

This section of API allows to perform following webhooks related actions on a GrooveKart store:

  • Create Webhook(s)
  • List Webhook
  • Update Webhook
  • Delete Webhook
Endpoints

POST https://STORE-URL/api/webhooks.json

Create Webhook(s)

To create a webhook, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: create

    required: yes

  • webhook_data

    type: array

    value: data for webhook

    required: yes

    webhook data

    • name

      type: string

      value: webhook name to identify

      required: yes

    • endpoint

      type: string

      value: webhook endpoint url

      required: yes

Returns

Returns status with message.

Request
POST/JSON

Endpoint: https://STORE-URL/api/webhooks.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"action":"create",
	"webhook_data":[
	  {
	     "name":"Teescape",
	     "endpoint":"https://teescape.com/active/Groovekart/webhook.asp"
	  }
	]
}
Response: Success
JSON
{
   "status": "success"
   "message": "Created webhook"
}
Response: Failed
JSON
{
	"status":"error",
	"message":"Invalid endpoint URL or URL not provided in one or more webhooks"
}
{
	"status":"error",
	"message":"One or more webhooks already exists"
}

Get Webhooks List

To get a list webhooks, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: list

    required: yes

Returns

Returns list of webhooks with data.

Request
POST/JSON

Endpoint: https://STORE-URL/api/webhooks.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"action":"list",
}
Response: Success
JSON
[
   {
      "id":"1",
      "name":"teescape",
      "type":"order_confirmation",
      "endpoint":"https://teescape.com/active/Groovekart/webhook.asp"
   }
]
Response: Failed
JSON
{
	"status":"error",
	"message":"Webhooks not found"
}

Update Webhook

To update an existing webhook, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: update

    required: yes

  • webhook_data

    type: array

    value: data for webhook

    required: yes

    webhook data

    • id

      type: int

      value: id of webhook

      required: yes

    • name

      type: string

      value: webhook name to identify

      required: no

    • endpoint

      type: string

      value: webhook endpoint url

      required: no

Returns

Returns status with message.

Request
POST/JSON

Endpoint: https://STORE-URL/api/webhooks.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"action":"update",
	"webhook_data":[
	  {
	  	 "id": 1,
	     "name":"Teescape",
	     "endpoint":"https://teescape.com/active/Groovekart/webhook.asp"
	  }
	]
}
Response: Success
JSON
{
   "status": "success"
   "message": "Webhook updated"
}
Response: Failed
JSON
{
	"status":"error",
	"message":"Webhook ID missing."
}
{
	"status":"error",
	"message":"Invalid endpoint URL or URL not provided in one or more webhooks"
}
{
	"status":"error",
	"message":"Webhook with same info already exists."
}
{
	"status":"error",
	"message":"Webhook data was empty."
}
{
	"status":"error",
	"message":"Webhook not found."
}

Delete Webhook

To delete an existing webhook, given below instructions can be followed:

Required Parameters

  • auth_token

    type: string

    value: Unique token for authentication

    required: yes

  • api_key

    type: string

    value: Unique API key required for authentication.

    required: yes

  • api_user

    type: string

    value: Vendor name e.g. teescape

    required: yes

  • action

    type: string

    value: delete

    required: yes

  • id

    type: int

    value: id of webhook

    required: yes

Returns

Returns status with message.

Request
POST/JSON

Endpoint: https://STORE-URL/api/webhooks.json

{
	"auth_token": "AUTH-TOKEN",
	"api_key": "API-KEY",
	"api_user": "VENDOR-NAME", //e.g. teescape
	"action":"delete",
	"id":1,
}
Response: Success
JSON
{
  "status":"success",
  "message":"Webhook deleted"
}
Response: Failed
JSON
{
	"status":"error",
	"message":"Webhook ID missing"
}
{
	"status":"error",
	"message":"Webhook not found with given id"
}