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.

Product

On several actions on GrooveKart store we can send data about it to external url (webhook). This data is having JSON format and contain attrbutes. Full list of attributes is listed below with exact attribute name, type and short explanation.

Data to Webhook will be sent if:

  • Product will be created or updated manually
  • Product will be pushed or updated from Vendor (PrintFul, Teescape, AliConnect etc) to a GrooveKart store
  • Product will be created or updated from GrooveKart Public API

Main Attributes

  • id

    type: numeric

    Unique identificator of the product

  • name

    type: string

    Name of the Product

  • description

    type: string

    Long description of the product in html

  • description_short

    type: string

    Short description of the product in html

  • default_category

    type: string

    Default category of the product

  • quantity

    type: numeric

    actual quantity

  • price

    type: numeric

    Product price (if 0 means product have variaitons and need to look at price there)

  • additional_shipping_cost

    type: numeric

    Additional Shipping fee

  • compare_default_price

    type: numeric

    Old Price

  • wholesale_price

    type: numeric

    Vendor's price (not visible for Buyers)

  • online_only

    type: numeric

    If 1 means product is digital

  • reference

    type: numeric

    SKU of the product

  • width

    type: numeric

    Width of the Product package

  • height

    type: numeric

    height of the Product package

  • depth

    type: numeric

    depth of the Product's package

  • weight

    type: numeric

    weight of the Product's package

  • link_rewrite

    type: string

    url of the product

  • meta_description

    type: string

    Meta description of the product

  • meta_keywords

    type: string

    Meta keywords of the product separdated by comma

  • meta_title

    type: string

    Meta title of the product

  • active

    type: numeric

    Product Status if 1 means product is visible for Buyers

  • visibility

    type: string

    Visibility type. can be url only, search only or both. Both status means product listed everywhere

  • date_add

    type: date

    Product's creation date

  • date_upd

    type: date

    Date when Product was updated

  • tags

    type: string

    List of tags

  • is_virtual

    type: string

    if 1 means product is digital

  • category

    type: string

    Associated cateogries array. Categories where product is visible

  • og_title

    type: string

    OG markup products title

  • og_description

    type: string

    OG markup product's description

  • og_image_url

    type: string

    OG product's image url

  • images

    type: url

    Array of assigned Images. Images can be also used to be show when some varations was clicked on Store Front.

  • cover_image

    type: url

    Array of Images. The main image of the product.

  • variants

    type: array

    like Color: Black Size: Middle

    Show child attributes

    • reference

      type: numeric

      SKU of the Variant

    • price

      type: numeric

      Price of the Variant

    • compare_price

      type: numeric

      Old price of the Variant

    • quantity

      type: numeric

      Quantity which is left

    • weight

      type: numeric

      Weight of the Variant

    • is_color_group

      type: numeric

      If you want to display an image or HEX color instead of text - this value should be set to 1

    • group_name

      type: string

      Vairant Group name

    • attribute_name

      type: string

      Vairant Group name

  • variations

    type: array

    like Color: Black Size: Middle

    Show child attributes

    • reference

      type: numeric

      SKU of the Variant

    • price

      type: numeric

      Price of the Variant

    • compare_price

      type: numeric

      Old price of the Variant

    • quantity

      type: numeric

      Quantity which is left

    • weight

      type: numeric

      Weight of the Variant

    • attribute_designation

      type: text

      Variations name

RESPONSE
{ 
	"id": "12",
	"name": "Product Name",
	"description": "Product Description",
	"description_short": Product Short Description,
	"default_category": "Best deals",
	"quantity": 0,
	"price": 0,
	"additional_shipping_cost": 0,
	"compare_default_price": 0,
	"wholesale_price": 0,
	"online_only": "0",
	"reference": "243032438",
	"width": 0,
	"height": 0,
	"depth": 0,
	"weight": 0,
	"link_rewrite": "https://domain.com/category/product-name",
	"meta_description": null,
	"meta_keywords": null,
	"meta_title": "Trucker Cap",
	"active": 1,
	"visibility": "both",
	"date_add": "2021-09-14 02:42:16",
	"date_upd": "2021-09-14 02:42:16",
	"tags": null,
	"is_virtual": null,
	"category": { "Best deals", "Associated Category", "Another associated category" },  
	"og_title": null,
	"og_description": null,
	"og_image_url": null,
	"images": [
		"https://cdn.groovekart.com/xxxxxxxx/img/p/1/1/1/2/2/3/111223.webp",
		"https://cdn.groovekart.com/xxxxxxxx/img/p/1/1/1/2/2/4/111224.webp",
		"https://cdn.groovekart.com/xxxxxxxx/img/p/1/1/1/2/2/5/111225.webp"
	],
	"cover_image": [
		"https://cdn.groovekart.com/xxxxxxxx/img/p/1/1/1/2/2/3/111223.webp"
	],
	"variants": [
		{
		"reference": "6140350FA51EE_Black--White",
		"price": "20.000000",
		"compare_price": "0.00",
		"quantity": 20,
		"weight": "0.000000",
		"is_color_group": "0",
		"group_name": "Color",
		"attribute_name": "Black/ White"
		},
		{
		"reference": "6140350FA51EE_Black--White--Black",
		"price": "20.000000",
		"compare_price": "0.00",
		"quantity": 20,
		"weight": "0.000000",
		"is_color_group": "0",
		"group_name": "Color",
		"attribute_name": "Black/ White/ Black"
		}
	],
	"variations": [
		{
		"reference": "6140350FA51EE_Black--White",
		"price": "20.000000",
		"compare_price": "0.00",
		"quantity": 20,
		"weight": "0.000000",
		"attribute_designation": "Color - Black/ White"
		},
		{
		"reference": "6140350FA51EE_Black--White--Black",
		"price": "20.000000",
		"compare_price": "0.00",
		"quantity": 20,
		"weight": "0.000000",
		"attribute_designation": "Color - Black/ White/ Black"
		}
	]
}
												

Customer

On several actions on GrooveKart store we can send data about it to external url (webhook). This data is having JSON format and contain attrbutes. Full list of attributes is listed below with exact attribute name, type and short explanation.

Data to a Webhook will be sent if:

  • Customer will be created or updated from StoreFront during checkout or from account creation page
  • Customer will be created or updated from GrooveKart Public API
  • Customer will be created or updated from GrooveKart Dashboard
  • This is an additional webhook for a Product data. If you need only quanitiy track - use this Action. Data to a Webhook will be sent if quantity for a product will be changed from:

Main Attributes

  • id

    type: numeric

    Unique ID of the Customer

  • note

    type: string

    Note of this Customer internal vew only for Merchant

  • gender

    type: string

    Gender of the customer

  • lastname

    type: Text

    Customer's Lastname

  • firstname

    type: Text

    Customer's Firstname

  • birthday

    type: date

    Birthday of the customer

  • email

    type: string

    Customer's email

  • newsletter

    type: numeric

    Acceptation of newsletter

  • active

    type: numeric

    Active or not

  • is_guest

    type: numeric

    If 1 means Customer do not have an account

  • deleted

    type: numeric

    if 1 means customer was deleted

  • date_add

    type: date

    Customer's creation date

  • date_upd

    type: date

    Date when customer information was updated

  • addresses

    type: array

    array of Customer's addresses

    Show child attributes

    • id_address

      type: numeric

    • alias

      type: string

      Name of the address

    • lastname

      type: string

      Lastname inside the address

    • firstname

      type: string

      Firstname inside the address

    • address1

      type: string

      Address line 1

    • postcode

      type: string

      ZIP/Postcode

    • city

      type: string

      City name

    • other

      type: string

    • phone_mobile

      type: numeric

      Phone number

    • date_add

      type: date

      Address creation date

    • date_upd

      type: date

      Date when Address was updated

    • deleted

      type: numeric

      Address can be deleted from view but not deleted from the DB

    • country

      type: string

      Country name

    • state

      type: string

      State/Province name

    • state_iso

      type: string

      ISO code of state

RESPONSE
{
	"id": 16,
	"note": null,
	"gender": "Mr.",
	"lastname": "Jhon",
	"firstname": "Brown",
	"birthday": "1989-08-19",
	"email": "jhon@email.com",
	"newsletter": "0",
	"active": "1",
	"is_guest": "0",
	"deleted": "0",
	"date_add": "2021-09-14 08:11:42",
	"date_upd": "2021-09-14 08:11:42",
	"addresses": [
    {
      "id_address": "56",
      "alias": "Home",
      "lastname": "lastname",
      "firstname": "first",
      "address1": "New town",
      "postcode": "99501",
      "city": "Alaska",
      "other": "",
      "phone_mobile": "123456789",
      "date_add": "2021-09-27 06:59:50",
      "date_upd": "2021-09-27 07:08:59",
      "deleted": "0",
      "country": "United States",
      "state": "Alaska",
      "state_iso": "AK"
    }
  ]
}
												

Abandoned Cart

On several actions on GrooveKart store we can send data about it to external url (webhook). This data is having JSON format and contain attrbutes. Full list of attributes is listed below with exact attribute name, type and short explanation.

Data to a Webhook will be sent when lifetime of the abandoned cart will be between 1 and 2 hours. There is no strict time because script is processing all of the abandoned cart.

Main Attributes

  • id

    type: numeric

    Unique identificator of the cart

  • id_customer

    type: numeric

    Unique identificator of the customer

  • firstname

    type: string

    Customer's firstname

  • lastname

    type: string

    Customer's lastname

  • email

    type: string

    Customer's email

  • date_upd

    type: date

    Date when the last update was done inside this shopping cart

  • products

    type: array

    Array of products inside this shopping cart

    Show child attributes

    • Name

      type: string

      Name of the Product

    • SKU

      type: string

      SKU of the product

    • Quantity

      type: numeric

      Quanitiy of the product inside this shopping cart

RESPONSE
{
	"id": "95",
	"id_customer": "63",
	"firstname": "Brown",
	"lastname": "Jhon",
	"email": "jhon@email.com",
	"date_upd": "2021-09-08 06:17:32",
	"products": [
		{
		"Name": "Product Name",
		"SKU": "XX123--01",
		"Quantity": "2"
		}
	]
}
												

Orders

On several actions on GrooveKart store we can send data about it to external url (webhook). This data is having JSON format and contain attrbutes. Full list of attributes is listed below with exact attribute name, type and short explanation.

Data to a Webhook will be sent if:

  • Order will be created or updated from StoreFront by a Buyer
  • Order will be created or updated from GrooveKart Public API
  • Order will be created or updated from GrooveKart Dashboard
  • Order will be updated from Vendor (PrintFul, Teescape, AliConnect etc)

Main Attributes

  • id_cart

    type: numeric

    ID of the shopping cart which was used before order was created

  • currency_iso

    type: string

    ISO code of the currency

  • id_customer

    type: numeric

    unique ID of the currency

  • id_carrier

    type: numeric

    ID of the shipping option

  • payment

    type: string

    Payment whic hwas used for this order

  • shipping_number

    type: numeric

    Tracking number

  • total_discounts

    type: numeric

    Total amount of the discounts

  • total_paid

    type: numeric

    Total amount of the order

  • total_products

    type: numeric

    Totoal amount of the products

  • total_shipping

    type: numeric

    Total amount of the shipping

  • date_add

    type: date

    Date when order was created

  • date_upd

    type: date

    Date when order was changed

  • reference

    type: string

  • id

    type: numeric

    ID of the Order

  • customer_id

    type: numeric

    ID of the customer

  • customer_note

    type: string

    Customer Note which was made like a comment during checkout process

  • customer_lastname

    type: string

    Customer's Lastname

  • customer_firstname

    type: string

    Customer's Firstname

  • customer_birthday

    type: date

    Customer's birthday date

  • customer_email

    type: string

    Customer's email

  • customer_newsletter

    type: numeric

    Confirmation for opt-in

  • customer_active

    type: numeric

    If 1 customer is active

  • customer_is_guest

    type: numeric

    If 1 means customer do not have a full account and order was made as a guest

  • customer_deleted

    type: numeric

    1 means that customer was deleted

  • customer_date_add

    type: date

    Date when customer was added

  • customer_date_upd

    type: date

    Date when customer info was updated

  • customer_gender

    type: string

    Customer's gender

  • delivery

    type: array

    Delivery address of the Order

    Show child attributes

    • state_name

      type: text

      State of the Delivery address

    • country

      type: string

      Country of the Delivery address

    • alias

      type: string

      Name of the Delivery address

    • lastname

      type: string

      Lastname of the Delivery address

    • firstname

      type: string

      Firstname of the Delivery address

    • address

      type: string

      line 1 of the Delivery address

    • postcode

      type: numeric

      Zpi/postcode of the Delivery address

    • city

      type: string

      City Name

    • phone_mobile

      type: numeric

      Phone Number

    • date_add

      type: date

      Date added of the Delivery

    • date_upd

      type: date

      Date updated of the Delivery

    • deleted

      type: numeric

  • invoice

    type: array

    Billing address of the order

    Show child attributes

    • state_name

      type: text

      State/Province name

    • country

      type: string

      Country name

    • alias

      type: string

      Name of the Billing address

    • lastname

      type: string

      Lastname of the Billing address

    • firstname

      type: string

      Firstname of the Billing address

    • address

      type: string

      Address line 1

    • postcode

      type: numeric

      ZIP/Postcode

    • city

      type: string

      City name

    • phone_mobile

      type: numeric

      Phone number

    • date_add

      type: date

      Added date

    • date_upd

      type: date

      Updated date

  • products

    type: array

    array of the products inside the order

    Show child attributes

    • product_name

      type: string

      Product's name

    • product_quantity

      type: numeric

      Product's quantity

    • product_price

      type: numeric

      Product's price

    • product_reference

      type: string

      Product's SKU

    • product_weight

      type: numeric

      Product's Weight

    • default_category

      type: string

    • quantity

      type: numeric

      Quantity in the cart

    • price

      type: numeric

      Product price

    • compare_default_price

      type: numeric

    • reference

      type: string

      Product SKU

    • width

      type: numeric

      Weight of the Product

    • height

      type: numeric

      Height of the Product

    • depth

      type: numeric

      Depth of the Product

    • weight

      type: numeric

      Weight of the Product

    • current_stock

      type: numeric

      Quantity which is left

    • cart_quantity

      type: numeric

      Quantity which is in the cart

    • name

      type: string

    • variants

      type: array

      Show child attributes

      • reference

        type: numeric

        SKU of the Variant

      • price

        type: numeric

        Price of the Variant

      • compare_price

        type: numeric

        Old price of the Variant

      • quantity

        type: numeric

        Quantity which is left

      • weight

        type: numeric

        Weight of the Variant

      • group_name

        type: string

        Vairant Group name

      • attribute_name

        type: string

        Vairant Group name

  • products_count

    type: numeric

    Totla products in the cart

  • carrier_name

    type: string

    Shipping Option name

  • carrier_url

    type: string

    Tracking url

  • carrier_delay

    type: string

    Shipping option description

RESPONSE
{
    "id_cart": "34",
    "currency_iso": "USD",
    "id_customer": "15",
    "id_carrier": "1",
    "payment": "Credit Card",
    "shipping_number": "",
    "total_discounts": "0.000000",
    "total_paid": "69.950000",
    "total_products": "69.950000",
    "total_shipping": "0.000000",
    "date_add": "2021-09-13 07:13:40",
    "date_upd": "2021-09-13 07:13:40",
    "reference": "VOOGKBHXB",
    "id": 7,
    "customer_id": 15,
    "customer_note": null,
    "customer_lastname": "Brown",
    "customer_firstname": "jhon",
    "customer_birthday": "0000-00-00",
    "customer_email": "jhon@email.com",
    "customer_newsletter": "1",
    "customer_active": "1",
    "customer_is_guest": "0",
    "customer_deleted": "0",
    "customer_date_add": "2021-09-13 07:12:25",
    "customer_date_upd": "2021-09-13 07:12:25",
    "customer_gender": "Mr.",
    "delivery": {
      "state_name": "California",
      "country": "United States",
      "alias": "My address",
      "lastname": "Jhon",
      "firstname": "Brown",
      "address": "1st street avenue",
      "postcode": "12345",
      "city": "City",
      "phone_mobile": "9999999999",
      "date_add": "2021-09-13 07:12:27",
      "date_upd": "2021-09-13 07:12:27",
      "deleted": "0",
    },
    "invoice": {
      "state_name": "California",
      "country": "United States",
      "alias": "My address",
      "lastname": "Jhon",
      "firstname": "Brown",
      "address": "1st street avenue",
      "postcode": "12345",
      "city": "City",
      "phone_mobile": "9999999999",
      "date_add": "2021-09-13 07:12:27",
      "date_upd": "2021-09-13 07:12:27",
    },
    "products": [
        {
        "product_name": "This Girl Loves To Groove - Style : Mens Sneakers - White, Size : US6 (EU39)",
        "product_quantity": "1",
        "product_price": 69.95,
        "product_reference": "CASCS32-799307",
        "product_weight": "0.000000",
        "default_category": "Best Deal",
        "quantity": "1",
        "price": 69.95,
        "compare_default_price": "0.000000",
        "reference": "",
        "width": "0.000000",
        "height": "0.000000",
        "depth": "0.000000",
        "weight": "0.000000",
        "current_stock": 19,
        "name": "This Girl Loves To Groove - Style : Mens Sneakers - White, Size : US6 (EU39)",
        "variants": [
            {
            "reference": "CASCS32-799307",
            "price": "69.950000",
            "compare_price": "219.91",
            "quantity": 19,
            "weight": "0.000000",
            "group_name": "Style",
            "attribute_name": "Mens Sneakers - White",
            },
            {
            "id_product_attribute": "1",
            "id_product": "2",
            "reference": "CASCS32-799307",
            "wholesale_price": "0.000000",
            "price": "69.950000",
            "compare_price": "219.91",
            "ecotax": "0.000000",
            "quantity": 19,
            "weight": "0.000000",
            "unit_price_impact": "0.000000",
            "default_on": "1",
            "id_shop": "1",
            "id_attribute_group": "8",
            "is_color_group": "0",
            "group_name": "Size",
            "attribute_name": "US6 (EU39)",
            "id_attribute": "49"
            }
        ]
        }
    ],
    "products_count": 1,
    "carrier_name": "Shipping Option name",
    "carrier_url": "https://t.17track.net/ru#nums=@",
    "carrier_delay": "Shipping Option description",
}
												

Product Quantity Update

On several actions on GrooveKart store we can send data about it to external url (webhook). This data is having JSON format and contain attrbutes. Full list of attributes is listed below with exact attribute name, type and short explanation.

  • GrooveKart Dasboard
  • Successful Order
  • Public API

Main Attributes

  • id_product

    type: numeric

    Unique identificator of the product

  • id_variation

    type: numeric

    Unique identificator of the Product's variaiton

  • quantity

    type: numeric

    current quantity of the product or variaiton

  • name_product

    type: string

    Name of the Product

  • variation_name

    type: string

    Name of the variation

  • variants

    type: array

    name of the Variants

    Show child attributes

    • reference

      type: string

      SKU of the Variant

    • price

      type: numeric

      Price of the Variant

    • compare_price

      type: numeric

      Old price of the Variant

    • quantity

      type: numeric

      Quantity which is left

    • weight

      type: numeric

      Weight of the Variant

    • group_name

      type: string

      Vairant Group name

    • attribute_name

      type: string

      Variant name

  • SKU

    type: string

    SKU of the Variations

RESPONSE
{
	"id_product": 134,
	"id_variation": 0,
	"quantity": 20,
	"name_product": "Product Name",
	"variation_name": "Variantion Name",
	"variants": [
				{
				"reference": "CASCS32-799307",
				"price": "69.950000",
				"compare_price": "219.91",
				"quantity": 19,
				"weight": "0.000000",
				"group_name": "Style",
				"attribute_name": "Mens Sneakers - White",
				}
	],
	"SKU": "PROD-TEST3",
}
												

New Customer Message

On several actions on GrooveKart store we can send data about it to external url (webhook). This data is having JSON format and contain attrbutes. Full list of attributes is listed below with exact attribute name, type and short explanation.

Data to a webhook will be sent only if Visitor send a message from default contact us form.

Main Attributes

  • id

    type: numeric

    Unique identificator of customer message

  • id_customer_thread

    type: numeric

    Unique identificator of a message thread

  • name

    type: string

    Title of the customer's message

  • email

    type: string

    Email of the customer

  • message

    type: string

    Message content

  • date_add

    type: date

    Initial date of the message

  • date_upd

    type: date

    Date of the last thread update

RESPONSE
{
	"id": "11", 
	"id_customer_thread": "8",
	"name": "Message title",
	"email": "user@email.com",
	"message": "Sample Message",
	"date_add": "2021-09-20 15:33:35",
	"date_upd": "2021-09-20 15:33:35",
}
												

Authentication

We required to pass the Authorization attribute in the request headers, with all API requests. Basic Auth has been used for it. Key generated in WebApi, will be base64 encoded and passed this Basic Auth. This way you don’t expose your API key directly but a base64_encode compute of your user:password couple. Although Groovekart API only has a user with empty password, so in order to compute your authorization key you can do as follows:

$apiKey = `GWKQ5UB22IB3IQZBYYEBT4319P4U3C8P`;

$authorizationKey = base64_encode($apiKey . ':'); // R1dLUTVVQjIySUIzSVFaQllZRUJUNDMxOVA0VTNDOFA6

Without the Authorization, WebAPi will give "401 Unauthorized" instead of expected output.

AUTHORIZATION EXAMPLE

$apiKey = `GWKQ5UB22IB3IQZBYYEBT4319P4U3C8P`;

$authorizationKey = base64_encode($apiKey . ':'); // R1dLUTVVQjIySUIzSVFaQllZRUJUNDMxOVA0VTNDOFA6



Basic R1dLUTVVQjIySUIzSVFaQllZRUJUNDMxOVA0VTNDOFA6

Additional list parameters


Display parameter

You can specify which fields you want for each resource using the display parameter.

display :
full - Returns all the fields of the resour/ce
[field1,field2,...] - Returns only the fields specified in this array


Filter parameter

You can filter the expected result with the filter parameter

filter[field] :
[1|5] - OR operator - list of possible values
[1,10] - Interval operator: define interval of possible values
[John] - Literal value (not case sensitive)
[Jo]% - Begin operator - fields begins with the value (not case sensitive)
%[hn] - End operator - fields ends with the value (not case sensitive)
%[oh]% - Contains operator - fields contains the value (not case sensitive)


Sort parameter

You can sort the expected result with the sort parameter

sort :
[{fieldname}_{ASC|DESC}] - The sort value is composed of a field name and the expected order separated by a _ (underscore).

Limit parameter


You can define a limit to the expected result with the limit parameter (which may allow you to perform pagination).

limit :
[offset,]limit - Either define offset and limit separated by a , (ex: 1,5) or the limit only (offset is 0-indexed)

Display parameter Examples

GET http://domain.com/webapi/products/?display=full

GET http://domain.com/webapi/products/?display=[id]

GET http://domain.com/webapi/products/?display=[id,type]



Filter parameter Examples

GET http://domain.com/webapi/products/?filter[id]=[1|5]

GET http://domain.com/webapi/products/?filter[id]=[1,10]

GET http://domain.com/webapi/customers/?filter[firstname]=[John]

GET http://domain.com/webapi/customers/?filter[firstname]=[Jo]%



Sort parameter Examples

GET http://domain.com/webapi/customers/?sort=[lastname_ASC]

GET http://domain.com/webapi/customers/?sort=[lastname_ASC,id_DESC]


Limit parameter Examples

GET http://domain.com/webapi/products/?limit=5

GET http://domain.com/webapi/products/?limit=9,5

Product

We can perform following operations on the products.

Get all product list
Get a specfic product Details
Add New Product
Update any product

Endpoints

GET http://domain.com/webapi/products

GET http://domain.com/webapi/products/63

POST http://domain.com/webapi/products

PUT http://domain.com/webapi/products

DELETE http://domain.com/webapi/products/63

Product Object

Here are some steps to create a great product on GrooveKart
1. Add a Product with main and additional attributes you need
2. Work with associations
- add categories and then update your product with default category_id and associated categories using ID as a required parameter
- add images and then update your product with associated images using ID as a required parameter
- add variant groups, variant values and then generate variaitons you need for a product using ID as a required parameter
- optionally in the same manner you can add Tags, Related Products, Upsell Products, Brands to your Product using Product Update and ID as a required paramenter

Attributes

No Attributes.

Returns

Returns the List of all products.

GET

No Parameter

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
	<products>
		<product id="2" xlink:href="https://domain.com/webapi/products/2"/>
		<product id="3" xlink:href="https://domain.com/webapi/products/3"/>
		<product id="4" xlink:href="https://domain.com/webapi/products/4"/>
		<product id="5" xlink:href="https://domain.com/webapi/products/5"/>
		<product id="6" xlink:href="https://domain.com/webapi/products/6"/>
	</products>
</groovekart>
														

Product Object

Here are some steps to create a great product on GrooveKart
1. Add a Product with main and additional attributes you need
2. Work with associations
- add categories and then update your product with default category_id and associated categories using ID as a required parameter
- add images and then update your product with associated images using ID as a required parameter
- add variant groups, variant values and then generate variaitons you need for a product using ID as a required parameter
- optionally in the same manner you can add Tags, Related Products, Upsell Products, Brands to your Product using Product Update and ID as a required paramenter

Attributes

No Attributes.

Returns

Returns the detail of the product.

GET

No Parameter

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <product>
        <id>
            <![CDATA[2]]>
        </id>
        <id_manufacturer xlink:href="https://domain.com/webapi/manufacturers/1">
            <![CDATA[1]]>
        </id_manufacturer>
        <id_category_default xlink:href="https://domain.com/webapi/categories/25">
            <![CDATA[25]]>
        </id_category_default>
        <id_default_image xlink:href="https://domain.com/webapi/images/products/2/2" notFilterable="true">
            <![CDATA[2]]>
        </id_default_image>
        <id_default_combination xlink:href="https://domain.com/webapi/combinations/1" notFilterable="true">
            <![CDATA[1]]>
        </id_default_combination>
        <manufacturer_name notFilterable="true">
            <![CDATA[samplebuilder.groovekart.com]]>
        </manufacturer_name>
        <quantity notFilterable="true">
            <![CDATA[0]]>
        </quantity>
        <type notFilterable="true">
            <![CDATA[simple]]>
        </type>
        <payload notFilterable="true">
            <![CDATA[product_909210]]>
        </payload>
        <upsell_payload notFilterable="true">
            <![CDATA[upsell_203675]]>
        </upsell_payload>
        <reference></reference>
        <width>
            <![CDATA[0.000000]]>
        </width>
        <height>
            <![CDATA[0.000000]]>
        </height>
        <depth>
            <![CDATA[0.000000]]>
        </depth>
        <weight>
            <![CDATA[0.000000]]>
        </weight>
        <is_virtual>
            <![CDATA[0]]>
        </is_virtual>
        <og_title>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[]]>
            </language>
        </og_title>
        <og_description>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[]]>
            </language>
        </og_description>
        <og_image_url></og_image_url>
        <price>
            <![CDATA[0.000000]]>
        </price>
        <wholesale_price>
            <![CDATA[0.000000]]>
        </wholesale_price>
        <additional_shipping_cost>
            <![CDATA[6.00]]>
        </additional_shipping_cost>
        <compare_default_price>
            <![CDATA[0.000000]]>
        </compare_default_price>
        <active>
            <![CDATA[0]]>
        </active>
        <redirect_type>
            <![CDATA[404]]>
        </redirect_type>
        <id_product_redirected>
            <![CDATA[0]]>
        </id_product_redirected>
        <available_for_order>
            <![CDATA[1]]>
        </available_for_order>
        <visibility>
            <![CDATA[both]]>
        </visibility>
        <date_add>
            <![CDATA[2020-03-27 05:29:39]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-09-23 18:46:03]]>
        </date_upd>
        <meta_description>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[This is a summary description. Used to explain in few words what product you are selling]]>
            </language>
        </meta_description>
        <meta_title>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Demo Mens Sneakers]]>
            </language>
        </meta_title>
        <link_rewrite>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[this-girl-loves-to-groove]]>
            </language>
        </link_rewrite>
        <name>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[This Girl Loves To Groove]]>
            </language>
        </name>
        <description>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[<div class="description" style="font-size: 15px;"><p><em><strong>International Shipping</strong></em><br />YES we ship worldwide for the same low price.</p><strong>Handmade Premium Sneakers</strong><ul><li>23.07 Oz. Designed for fashion men, stylish and personalized.</li><li>Polyester and spandex material upper, with soft foam, offers good foot feels.</li><li>Unbelievably lightweight & durable.</li><li>EVA sole, shake-proof, anti-heat, anti-moisture, anti-corrosion, non-slip, easy cleaning.</li><li>Ergonomically streamlined foot curve, wearing soft and comfortable.</li><li>Ideal as both running & casual shoes.</li></ul>
</div>]]>
</language>
</description>
<description_short>
    <language id="1" xlink:href="https://domain.com/webapi/languages/1">
        <![CDATA[<p>This is a summary description. Used to explain in few words what product you are selling</p>]]>
    </language>
</description_short>
<associations>
    <categories nodeType="category" api="categories">
        <category xlink:href="https://domain.com/webapi/categories/2">
            <id>
                <![CDATA[2]]>
            </id>
        </category>
        <category xlink:href="https://domain.com/webapi/categories/25">
            <id>
                <![CDATA[25]]>
            </id>
        </category>
    </categories>
    <images nodeType="image" api="images">
        <image xlink:href="https://domain.com/webapi/images/products/2/2">
            <id>
                <![CDATA[2]]>
            </id>
        </image>
    </images>
    <combinations nodeType="combination" api="combinations">
        <combination xlink:href="https://domain.com/webapi/combinations/1">
            <id>
                <![CDATA[1]]>
            </id>
        </combination>
        <combination xlink:href="https://domain.com/webapi/combinations/2">
            <id>
                <![CDATA[2]]>
            </id>
        </combination>
        <combination xlink:href="https://domain.com/webapi/combinations/3">
            <id>
                <![CDATA[3]]>
            </id>
        </combination>
        <combination xlink:href="https://domain.com/webapi/combinations/4">
            <id>
                <![CDATA[4]]>
            </id>
        </combination>
        <combination xlink:href="https://domain.com/webapi/combinations/5">
            <id>
                <![CDATA[5]]>
            </id>
        </combination>
        <combination xlink:href="https://domain.com/webapi/combinations/6">
            <id>
                <![CDATA[6]]>
            </id>
        </combination>
        <combination xlink:href="https://domain.com/webapi/combinations/7">
            <id>
                <![CDATA[7]]>
            </id>
        </combination>
        <combination xlink:href="https://domain.com/webapi/combinations/8">
            <id>
                <![CDATA[8]]>
            </id>
        </combination>
        <combination xlink:href="https://domain.com/webapi/combinations/9">
            <id>
                <![CDATA[9]]>
            </id>
        </combination>
        <combination xlink:href="https://domain.com/webapi/combinations/10">
            <id>
                <![CDATA[10]]>
            </id>
        </combination>
    </combinations>
    <product_option_values nodeType="product_option_value" api="product_option_values">
        <product_option_value xlink:href="https://domain.com/webapi/product_option_values/49">
            <id>
                <![CDATA[49]]>
            </id>
        </product_option_value>
        <product_option_value xlink:href="https://domain.com/webapi/product_option_values/50">
            <id>
                <![CDATA[50]]>
            </id>
        </product_option_value>
        <product_option_value xlink:href="https://domain.com/webapi/product_option_values/51">
            <id>
                <![CDATA[51]]>
            </id>
        </product_option_value>
        <product_option_value xlink:href="https://domain.com/webapi/product_option_values/52">
            <id>
                <![CDATA[52]]>
            </id>
        </product_option_value>
        <product_option_value xlink:href="https://domain.com/webapi/product_option_values/53">
            <id>
                <![CDATA[53]]>
            </id>
        </product_option_value>
        <product_option_value xlink:href="https://domain.com/webapi/product_option_values/54">
            <id>
                <![CDATA[54]]>
            </id>
        </product_option_value>
        <product_option_value xlink:href="https://domain.com/webapi/product_option_values/55">
            <id>
                <![CDATA[55]]>
            </id>
        </product_option_value>
        <product_option_value xlink:href="https://domain.com/webapi/product_option_values/56">
            <id>
                <![CDATA[56]]>
            </id>
        </product_option_value>
        <product_option_value xlink:href="https://domain.com/webapi/product_option_values/57">
            <id>
                <![CDATA[57]]>
            </id>
        </product_option_value>
        <product_option_value xlink:href="https://domain.com/webapi/product_option_values/58">
            <id>
                <![CDATA[58]]>
            </id>
        </product_option_value>
        <product_option_value xlink:href="https://domain.com/webapi/product_option_values/59">
            <id>
                <![CDATA[59]]>
            </id>
        </product_option_value>
    </product_option_values>
    <product_features nodeType="product_feature" api="product_features"/>
    <tags nodeType="tag" api="tags"/>
    <stock_availables nodeType="stock_available" api="stock_availables">
        <stock_available xlink:href="https://domain.com/webapi/stock_availables/2">
            <id>
                <![CDATA[2]]>
            </id>
            <id_product_attribute>
                <![CDATA[0]]>
            </id_product_attribute>
        </stock_available>
        <stock_available xlink:href="https://domain.com/webapi/stock_availables/3">
            <id>
                <![CDATA[3]]>
            </id>
            <id_product_attribute>
                <![CDATA[1]]>
            </id_product_attribute>
        </stock_available>
        <stock_available xlink:href="https://domain.com/webapi/stock_availables/4">
            <id>
                <![CDATA[4]]>
            </id>
            <id_product_attribute>
                <![CDATA[2]]>
            </id_product_attribute>
        </stock_available>
        <stock_available xlink:href="https://domain.com/webapi/stock_availables/5">
            <id>
                <![CDATA[5]]>
            </id>
            <id_product_attribute>
                <![CDATA[3]]>
            </id_product_attribute>
        </stock_available>
        <stock_available xlink:href="https://domain.com/webapi/stock_availables/6">
            <id>
                <![CDATA[6]]>
            </id>
            <id_product_attribute>
                <![CDATA[4]]>
            </id_product_attribute>
        </stock_available>
        <stock_available xlink:href="https://domain.com/webapi/stock_availables/7">
            <id>
                <![CDATA[7]]>
            </id>
            <id_product_attribute>
                <![CDATA[5]]>
            </id_product_attribute>
        </stock_available>
        <stock_available xlink:href="https://domain.com/webapi/stock_availables/8">
            <id>
                <![CDATA[8]]>
            </id>
            <id_product_attribute>
                <![CDATA[6]]>
            </id_product_attribute>
        </stock_available>
        <stock_available xlink:href="https://domain.com/webapi/stock_availables/9">
            <id>
                <![CDATA[9]]>
            </id>
            <id_product_attribute>
                <![CDATA[7]]>
            </id_product_attribute>
        </stock_available>
        <stock_available xlink:href="https://domain.com/webapi/stock_availables/10">
            <id>
                <![CDATA[10]]>
            </id>
            <id_product_attribute>
                <![CDATA[8]]>
            </id_product_attribute>
        </stock_available>
        <stock_available xlink:href="https://domain.com/webapi/stock_availables/11">
            <id>
                <![CDATA[11]]>
            </id>
            <id_product_attribute>
                <![CDATA[9]]>
            </id_product_attribute>
        </stock_available>
        <stock_available xlink:href="https://domain.com/webapi/stock_availables/12">
            <id>
                <![CDATA[12]]>
            </id>
            <id_product_attribute>
                <![CDATA[10]]>
            </id_product_attribute>
        </stock_available>
    </stock_availables>
    <accessories nodeType="product" api="products">
        <product>
            <id xlink:href="https://domain.com/webapi/product/3">
                <![CDATA[3]]>
            </id>
        </product>
        <product>
            <id xlink:href="https://domain.com/webapi/product/4">
                <![CDATA[4]]>
            </id>
        </product>
        <product>
            <id xlink:href="https://domain.com/webapi/product/6">
                <![CDATA[6]]>
            </id>
        </product>
    </accessories>
</associations>
</product>
</groovekart>
														

Product Object

Here are some steps to create a great product on GrooveKart
1. Add a Product with main and additional attributes you need
2. Work with associations
- add categories and then update your product with default category_id and associated categories using ID as a required parameter
- add images and then update your product with associated images using ID as a required parameter
- add variant groups, variant values and then generate variaitons you need for a product using ID as a required parameter
- optionally in the same manner you can add Tags, Related Products, Upsell Products, Brands to your Product using Product Update and ID as a required paramenter

Main Attributes

  • id required on update

    type: numeric

    Id of a Product. Unique value for each Product. Automincremental

  • name optional

    type: text

    Product Name

    Show child attributes

    • language id required

      type: numeric

      English is having ID 1 on all the stores

  • description optional

    type: html

    Product long description

    Show child attributes

    • language id required

      type: numeric

      English is having ID 1 on all the stores

  • description_short optional

    type: html

    Product short description

    Show child attributes

    • language id required

      type: numeric

      English is having ID 1 on all the stores

  • type required

    type: numeric

    1 - default product, 2 - digital product

    GrooveKart have two types. Difference between is that Default Product can have variations and digital product don't. Digital product can have associated file and default - can not

  • visibility required

    type: numeric

    Product can have 4 types of visibility: All, Search only, url only, from facebook refferal link

  • reference optional

    type: text

    This is an SKU for Product.

    Please note that every Variation can have it's own SKU

  • price optional

    type: numeric

    Final Product Price for Buyers

    IF Product have variants - please leave this field as 0

  • wholesale_price optional

    type: numeric

    Product Price which is visible only for Merchant. like Vendor price. Useful to calculate benefits

  • additional_shipping_cost optional

    type: numeric

    Price which is added to a Shipping Option if it was configured to use it

    tips

  • compare_default_price optional

    type: numeric

    Product Old Price. Showing on Store Front as a line through Price

    IF Product have variants - please leave this field as 0

  • active required

    type: numeric

    If it's active - it can be visible on Store Front. If it's not active, it's not visible at any point.

  • date_add optional

    type: date

    Date where product was initally added

  • date_upd optional

    type: date

    Date where product was updated

  • payload required

    type: string

    pass as empty

    This is an ID of a Product Template. It's a required parameter but pass it as empty one.

    Just because we do not have yet a listing of Product Payloads. It's not possible for you to know what Payload IDs we have. That's why for now pass it as empty and we will assign first default payload

  • upsell_payload required

    type: string

    pass as empty

    This is an ID of a Upsell Template. It's a required parameter but pass it as empty one.

    Just because we do not have yet a listing of Product Payloads. It's not possible for you to know what Payload IDs we have. That's why for now pass it as empty and we will assign first default payload

Assosiations

  • id_default_combination optional

    type: numeric

    This is an ID of existing Variation assigned to this Product. Default Variation can be only one.

    First you want to create some Variants: Look Variant Groups Add and Variants Values documentation After you have your Variants on a Store this can help you: Variation generation, Product Variaiton List

  • id_category_default required

    type: numeric

    Do not use ID 1 or 2 as a default category!

    This is an ID of existing Category on GrooveKart. Default Category can be only one.

    Look at Category Add and Category List. If you need to assign multiple associated categories look for Associations array where you can see child attribute of Categories

  • id_default_image optional

    type: numeric

    This is an ID of existing Image on GrooveKart. Default Image can be only one.

    Look at Image Add and Image List documentation

  • associations optional

    type: array

    Show child attributes

    • categories optional

      type: array

      Array of associated categories. On every associated category product will be displayed

      Show child attributes

      • category optional

        type: array

        Show child attributes

        • id required

          type: numeric

    • images optional

      type: array

      Array of assigned Images. Images can be also used to be show when some varations was clicked on Store Front.

      Show child attributes

      • image optional

        type: array

        Show child attributes

        • id required

          type: numeric

    • combinations optional

      type: array

      Array of assigned Variaitions. Variaiton is a combination of Variant Values like Size: Medium - Color: Black. Where Size and Color are a Variant Groups and Medium and Black are variant values

      Show child attributes

      • combination optional

        type: array

        Show child attributes

        • id required

          type: numeric

    • product_option_values optional

      type: array

      Array of assigned Variant Values

      Show child attributes

      • product_option_value optional

        type: array

        Show child attributes

        • id required

          type: numeric

    • tags optional

      type: array

      Array of assigned Tags

      Show child attributes

      • tag optional

        type: array

        Show child attributes

        • id required

          type: numeric

    • accessories optional

      type: array

      Array of assigned Related Products

      Show child attributes

      • product optional

        type: array

        Show child attributes

        • id required

          type: numeric

    • one_upsell_accessories optional

      type: array

      Array of assigned Upsell Products during Instant Checkout on Product Page

      Show child attributes

      • product optional

        type: array

        Show child attributes

        • id required

          type: numeric

    • upsell_accessories optional

      type: array

      Array of assigned Upsell Products after main checkout

      Show child attributes

      • product optional

        type: array

        Show child attributes

        • id required

          type: numeric

Additional Attributes

  • id_manufacturer optional

    type: numeric

    This is an ID of existing Brand. Product can have only one assigned Brand

    Look at Brand Add and Brand List docs

  • is_virtual optional

    type: numeric

    0 - Not a digital product. 1 - Digital Product

    If you are creating Digital Product - need to set this option t o1

  • width optional

    type: numeric

    This is a optional parameter for your Shippin Option or a Carrier

  • height optional

    type: numeric

    This is a optional parameter for your Shippin Option or a Carrier

  • depth optional

    type: numeric

    This is a optional parameter for your Shippin Option or a Carrier

  • weight optional

    type: numeric

    This is a optional parameter for your Shippin Option or a Carrier

  • og_title optional

    type: array

    Show child attributes

  • og_description optional

    type: text

    Show child attributes

  • og_image_url optional

    type: text

  • meta_description optional

    type: text

    Show child attributes

  • meta_keywords optional

    type: text

    Show child attributes

  • meta_title optional

    type: text

    Show child attributes

  • link_rewrite optional

    type: text

    Show child attributes

  • redirect_type optional

    type: text

  • id_product_redirected optional

    type: numeric

  • is_virtual optional

    type: numeric

    0 - Not a digital product. 1 - Digital Product

    If you are creating Digital Product - need to set this option t o1

Returns

Returns of new added product.

POST
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <product>
        <id></id>
        <id_manufacturer></id_manufacturer>
        <id_category_default>25</id_category_default>
        <id_default_combination></id_default_combination>
        <type></type>
        <reference></reference>
        <width></width>
        <height></height>
        <depth></depth>
        <weight></weight>
        <is_virtual></is_virtual>
        <og_title>
            <language id="1">og title</language>
        </og_title>
        <og_description>
            <language id="1">Og Description</language>
        </og_description>
        <price>51.00</price>
        <wholesale_price></wholesale_price>
        <additional_shipping_cost>5.0</additional_shipping_cost>
        <compare_default_price>55.00</compare_default_price>
        <active>1</active>
        <available_for_order>1</available_for_order>
        <redirect_type></redirect_type>
        <id_product_redirected></id_product_redirected>
        <visibility></visibility>
        <date_add></date_add>
        <date_upd></date_upd>
        <meta_description>
            <language id="1">Test Dummy Products description</language>
        </meta_description>
        <meta_title>
            <language id="1">Test Dummy Products</language>
        </meta_title>
        <link_rewrite>
            <language id="1">test-dummy-products</language>
        </link_rewrite>
        <name>
            <language id="1">Test Dummy Products</language>
        </name>
        <description>
            <language id="1">Test Dummy Products description</language>
        </description>
        <description_short>
            <language id="1">Test Dummy Products description short</language>
        </description_short>
        <payload></payload>
        <upsell_payload></upsell_payload>
        <associations>
            <categories>
                <category>
                    <id></id>
                </category>
            </categories>
            
            <combinations>
                <combination>
                    <id></id>
                </combination>
            </combinations>
            <product_option_values>
                <product_option_value>
                    <id></id>
                </product_option_value>
            </product_option_values>
            <product_features>
                <product_feature>
                    <id></id>
                    <id_feature_value></id_feature_value>
                </product_feature>
            </product_features>
            <tags>
                <tag>
                    <id></id>
                </tag>
            </tags>
            <stock_availables>
                <stock_available>
                    <id></id>
                    <id_product_attribute></id_product_attribute>
                </stock_available>
            </stock_availables>
            <accessories>
                <product>
                    <id></id>
                </product>
            </accessories>
        </associations>
    </product>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <product>
        <id>
            <![CDATA[166]]>
        </id>
        <id_manufacturer></id_manufacturer>
        <id_category_default xlink:href="https://domain.com/webapi/categories/25">
            <![CDATA[25]]>
        </id_category_default>
        <id_default_image notFilterable="true"></id_default_image>
        <id_default_combination notFilterable="true"></id_default_combination>
        <manufacturer_name notFilterable="true"></manufacturer_name>
        <quantity notFilterable="true"></quantity>
        <type notFilterable="true">
            <![CDATA[simple]]>
        </type>
        <payload notFilterable="true">
            <![CDATA[product_909210]]>
        </payload>
        <upsell_payload notFilterable="true">
            <![CDATA[upsell_203675]]>
        </upsell_payload>
        <reference></reference>
        <width></width>
        <height></height>
        <depth></depth>
        <weight></weight>
        <is_virtual></is_virtual>
        <og_title>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[og title]]>
            </language>
        </og_title>
        <og_description>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Og Description]]>
            </language>
        </og_description>
        <og_image_url></og_image_url>
        <price>
            <![CDATA[51.00]]>
        </price>
        <wholesale_price></wholesale_price>
        <additional_shipping_cost>
            <![CDATA[5.0]]>
        </additional_shipping_cost>
        <compare_default_price>
            <![CDATA[55.00]]>
        </compare_default_price>
        <active>
            <![CDATA[1]]>
        </active>
        <redirect_type></redirect_type>
        <id_product_redirected></id_product_redirected>
        <available_for_order>
            <![CDATA[1]]>
        </available_for_order>
        <visibility>
            <![CDATA[both]]>
        </visibility>
        <date_add>
            <![CDATA[2021-09-30 15:13:16]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-09-30 15:13:16]]>
        </date_upd>
        <meta_description>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Test Dummy Products description]]>
            </language>
        </meta_description>
        <meta_title>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Test Dummy Products]]>
            </language>
        </meta_title>
        <link_rewrite>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[test-dummy-products]]>
            </language>
        </link_rewrite>
        <name>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Test Dummy Products]]>
            </language>
        </name>
        <description>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Test Dummy Products description]]>
            </language>
        </description>
        <description_short>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Test Dummy Products description short]]>
            </language>
        </description_short>
        <associations>
            <categories nodeType="category" api="categories"/>
            <images nodeType="image" api="images"/>
            <combinations nodeType="combination" api="combinations"/>
            <product_option_values nodeType="product_option_value" api="product_option_values"/>
            <product_features nodeType="product_feature" api="product_features"/>
            <tags nodeType="tag" api="tags">
                <tag xlink:href="https://domain.com/webapi/tags/0">
                    <id>
                        <![CDATA[0]]>
                    </id>
                </tag>
            </tags>
            <stock_availables nodeType="stock_available" api="stock_availables">
                <stock_available xlink:href="https://domain.com/webapi/stock_availables/713">
                    <id>
                        <![CDATA[713]]>
                    </id>
                    <id_product_attribute>
                        <![CDATA[0]]>
                    </id_product_attribute>
                </stock_available>
            </stock_availables>
            <accessories nodeType="product" api="products"/>
        </associations>
    </product>
</groovekart>
														

Product Object

Here are some steps to create a great product on GrooveKart
1. Add a Product with main and additional attributes you need
2. Work with associations
- add categories and then update your product with default category_id and associated categories using ID as a required parameter
- add images and then update your product with associated images using ID as a required parameter
- add variant groups, variant values and then generate variaitons you need for a product using ID as a required parameter
- optionally in the same manner you can add Tags, Related Products, Upsell Products, Brands to your Product using Product Update and ID as a required paramenter

Main Attributes

  • id required on update

    type: numeric

    Id of a Product. Unique value for each Product. Automincremental

  • name optional

    type: text

    Product Name

    Show child attributes

    • language id required

      type: numeric

      English is having ID 1 on all the stores

  • description optional

    type: html

    Product long description

    Show child attributes

    • language id required

      type: numeric

      English is having ID 1 on all the stores

  • description_short optional

    type: html

    Product short description

    Show child attributes

    • language id required

      type: numeric

      English is having ID 1 on all the stores

  • type required

    type: numeric

    1 - default product, 2 - digital product

    GrooveKart have two types. Difference between is that Default Product can have variations and digital product don't. Digital product can have associated file and default - can not

  • visibility required

    type: numeric

    Product can have 4 types of visibility: All, Search only, url only, from facebook refferal link

  • reference optional

    type: text

    This is an SKU for Product.

    Please note that every Variation can have it's own SKU

  • price optional

    type: numeric

    Final Product Price for Buyers

    IF Product have variants - please leave this field as 0

  • wholesale_price optional

    type: numeric

    Product Price which is visible only for Merchant. like Vendor price. Useful to calculate benefits

  • additional_shipping_cost optional

    type: numeric

    Price which is added to a Shipping Option if it was configured to use it

    tips

  • compare_default_price optional

    type: numeric

    Product Old Price. Showing on Store Front as a line through Price

    IF Product have variants - please leave this field as 0

  • active required

    type: numeric

    If it's active - it can be visible on Store Front. If it's not active, it's not visible at any point.

  • date_add optional

    type: date

    Date where product was initally added

  • date_upd optional

    type: date

    Date where product was updated

  • payload required

    type: string

    pass as empty

    This is an ID of a Product Template. It's a required parameter but pass it as empty one.

    Just because we do not have yet a listing of Product Payloads. It's not possible for you to know what Payload IDs we have. That's why for now pass it as empty and we will assign first default payload

  • upsell_payload required

    type: string

    pass as empty

    This is an ID of a Upsell Template. It's a required parameter but pass it as empty one.

    Just because we do not have yet a listing of Product Payloads. It's not possible for you to know what Payload IDs we have. That's why for now pass it as empty and we will assign first default payload

Assosiations

  • id_default_combination optional

    type: numeric

    This is an ID of existing Variation assigned to this Product. Default Variation can be only one.

    First you want to create some Variants: Look Variant Groups Add and Variants Values documentation After you have your Variants on a Store this can help you: Variation generation, Product Variaiton List

  • id_category_default required

    type: numeric

    Do not use ID 1 or 2 as a default category!

    This is an ID of existing Category on GrooveKart. Default Category can be only one.

    Look at Category Add and Category List. If you need to assign multiple associated categories look for Associations array where you can see child attribute of Categories

  • id_default_image optional

    type: numeric

    This is an ID of existing Image on GrooveKart. Default Image can be only one.

    Look at Image Add and Image List documentation

  • associations optional

    type: array

    Show child attributes

    • categories optional

      type: array

      Array of associated categories. On every associated category product will be displayed

      Show child attributes

      • category optional

        type: array

        Show child attributes

        • id required

          type: numeric

    • images optional

      type: array

      Array of assigned Images. Images can be also used to be show when some varations was clicked on Store Front.

      Show child attributes

      • image optional

        type: array

        Show child attributes

        • id required

          type: numeric

    • combinations optional

      type: array

      Array of assigned Variaitions. Variaiton is a combination of Variant Values like Size: Medium - Color: Black. Where Size and Color are a Variant Groups and Medium and Black are variant values

      Show child attributes

      • combination optional

        type: array

        Show child attributes

        • id required

          type: numeric

    • product_option_values optional

      type: array

      Array of assigned Variant Values

      Show child attributes

      • product_option_value optional

        type: array

        Show child attributes

        • id required

          type: numeric

    • tags optional

      type: array

      Array of assigned Tags

      Show child attributes

      • tag optional

        type: array

        Show child attributes

        • id required

          type: numeric

    • accessories optional

      type: array

      Array of assigned Related Products

      Show child attributes

      • product optional

        type: array

        Show child attributes

        • id required

          type: numeric

    • one_upsell_accessories optional

      type: array

      Array of assigned Upsell Products during Instant Checkout on Product Page

      Show child attributes

      • product optional

        type: array

        Show child attributes

        • id required

          type: numeric

    • upsell_accessories optional

      type: array

      Array of assigned Upsell Products after main checkout

      Show child attributes

      • product optional

        type: array

        Show child attributes

        • id required

          type: numeric

Additional Attributes

  • id_manufacturer optional

    type: numeric

    This is an ID of existing Brand. Product can have only one assigned Brand

    Look at Brand Add and Brand List docs

  • is_virtual optional

    type: numeric

    0 - Not a digital product. 1 - Digital Product

    If you are creating Digital Product - need to set this option t o1

  • width optional

    type: numeric

    This is a optional parameter for your Shippin Option or a Carrier

  • height optional

    type: numeric

    This is a optional parameter for your Shippin Option or a Carrier

  • depth optional

    type: numeric

    This is a optional parameter for your Shippin Option or a Carrier

  • weight optional

    type: numeric

    This is a optional parameter for your Shippin Option or a Carrier

  • og_title optional

    type: array

    Show child attributes

  • og_description optional

    type: text

    Show child attributes

  • og_image_url optional

    type: text

  • meta_description optional

    type: text

    Show child attributes

  • meta_keywords optional

    type: text

    Show child attributes

  • meta_title optional

    type: text

    Show child attributes

  • link_rewrite optional

    type: text

    Show child attributes

  • redirect_type optional

    type: text

  • id_product_redirected optional

    type: numeric

  • is_virtual optional

    type: numeric

    0 - Not a digital product. 1 - Digital Product

    If you are creating Digital Product - need to set this option t o1

Returns

Returns the update of products.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <product>
        <id></id>
        <id_manufacturer></id_manufacturer>
        <id_category_default>25</id_category_default>
        <id_default_combination></id_default_combination>
        <type></type>
        <reference></reference>
        <width></width>
        <height></height>
        <depth></depth>
        <weight></weight>
        <is_virtual></is_virtual>
        <og_title>
            <language id="1">og title</language>
        </og_title>
        <og_description>
            <language id="1">Og Description</language>
        </og_description>
        <price>51.00</price>
        <wholesale_price></wholesale_price>
        <additional_shipping_cost>5.0</additional_shipping_cost>
        <compare_default_price>55.00</compare_default_price>
        <active>1</active>
        <available_for_order>1</available_for_order>
        <redirect_type></redirect_type>
        <id_product_redirected></id_product_redirected>
        <visibility></visibility>
        <date_add></date_add>
        <date_upd></date_upd>
        <meta_description>
            <language id="1">Test Dummy Products description</language>
        </meta_description>
        <meta_title>
            <language id="1">Test Dummy Products</language>
        </meta_title>
        <link_rewrite>
            <language id="1">test-dummy-products</language>
        </link_rewrite>
        <name>
            <language id="1">Test Dummy Products</language>
        </name>
        <description>
            <language id="1">Test Dummy Products description</language>
        </description>
        <description_short>
            <language id="1">Test Dummy Products description short</language>
        </description_short>
        <payload></payload>
        <upsell_payload></upsell_payload>
        <associations>
            <categories>
                <category>
                    <id></id>
                </category>
            </categories>
            
            <combinations>
                <combination>
                    <id></id>
                </combination>
            </combinations>
            <product_option_values>
                <product_option_value>
                    <id></id>
                </product_option_value>
            </product_option_values>
            <product_features>
                <product_feature>
                    <id></id>
                    <id_feature_value></id_feature_value>
                </product_feature>
            </product_features>
            <tags>
                <tag>
                    <id></id>
                </tag>
            </tags>
            <stock_availables>
                <stock_available>
                    <id></id>
                    <id_product_attribute></id_product_attribute>
                </stock_available>
            </stock_availables>
            <accessories>
                <product>
                    <id></id>
                </product>
            </accessories>
        </associations>
    </product>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <product>
        <id></id>
        <id_manufacturer></id_manufacturer>
        <id_category_default>25</id_category_default>
        <id_default_combination></id_default_combination>
        <type></type>
        <reference></reference>
        <width></width>
        <height></height>
        <depth></depth>
        <weight></weight>
        <is_virtual></is_virtual>
        <og_title>
            <language id="1">og title</language>
        </og_title>
        <og_description>
            <language id="1">Og Description</language>
        </og_description>
        <price>51.00</price>
        <wholesale_price></wholesale_price>
        <additional_shipping_cost>5.0</additional_shipping_cost>
        <compare_default_price>55.00</compare_default_price>
        <active>1</active>
        <available_for_order>1</available_for_order>
        <redirect_type></redirect_type>
        <id_product_redirected></id_product_redirected>
        <visibility></visibility>
        <date_add></date_add>
        <date_upd></date_upd>
        <meta_description>
            <language id="1">Test Dummy Products description</language>
        </meta_description>
        <meta_title>
            <language id="1">Test Dummy Products</language>
        </meta_title>
        <link_rewrite>
            <language id="1">test-dummy-products</language>
        </link_rewrite>
        <name>
            <language id="1">Test Dummy Products</language>
        </name>
        <description>
            <language id="1">Test Dummy Products description</language>
        </description>
        <description_short>
            <language id="1">Test Dummy Products description short</language>
        </description_short>
        <payload></payload>
        <upsell_payload></upsell_payload>
        <associations>
            <categories>
                <category>
                    <id></id>
                </category>
            </categories>
            
            <combinations>
                <combination>
                    <id></id>
                </combination>
            </combinations>
            <product_option_values>
                <product_option_value>
                    <id></id>
                </product_option_value>
            </product_option_values>
            <product_features>
                <product_feature>
                    <id></id>
                    <id_feature_value></id_feature_value>
                </product_feature>
            </product_features>
            <tags>
                <tag>
                    <id></id>
                </tag>
            </tags>
            <stock_availables>
                <stock_available>
                    <id></id>
                    <id_product_attribute></id_product_attribute>
                </stock_available>
            </stock_availables>
            <accessories>
                <product>
                    <id></id>
                </product>
            </accessories>
        </associations>
    </product>
</groovekart>
														

Product Object

Here are some steps to create a great product on GrooveKart
1. Add a Product with main and additional attributes you need
2. Work with associations
- add categories and then update your product with default category_id and associated categories using ID as a required parameter
- add images and then update your product with associated images using ID as a required parameter
- add variant groups, variant values and then generate variaitons you need for a product using ID as a required parameter
- optionally in the same manner you can add Tags, Related Products, Upsell Products, Brands to your Product using Product Update and ID as a required paramenter

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

DELETE

No Parameter

Response

Successfully deleted

Variant Groups

First of all need to clearly understand the difference between Variation, Variant, Variant Group and Value
Let's say we have a Sizes Large and Small and Colors Black and White
Variant Group are Size and Color. Where we have Variant Values as Blaock & White, Large and Small
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small
Product Object mainly need Variaitons, because each Variation can have different Price
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small

Attributes

No Attributes.

Returns

Returns the List of all product.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <product_options>
        <product_option id="6" xlink:href="https://domain.com/webapi/product_options/6"/>
        <product_option id="7" xlink:href="https://domain.com/webapi/product_options/7"/>
        <product_option id="8" xlink:href="https://domain.com/webapi/product_options/8"/>
        <product_option id="9" xlink:href="https://domain.com/webapi/product_options/9"/>
        <product_option id="10" xlink:href="https://domain.com/webapi/product_options/10"/>
        <product_option id="11" xlink:href="https://domain.com/webapi/product_options/11"/>
        <product_option id="12" xlink:href="https://domain.com/webapi/product_options/12"/>
        <product_option id="13" xlink:href="https://domain.com/webapi/product_options/13"/>
    </product_options>
</groovekart>
														

Variant Values

First of all need to clearly understand the difference between Variation, Variant, Variant Group and Value
Let's say we have a Sizes Large and Small and Colors Black and White
Variant Group are Size and Color. Where we have Variant Values as Blaock & White, Large and Small
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small
Product Object mainly need Variaitons, because each Variation can have different Price
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small

Attributes

No Attributes.

Returns

Returns the List of all product.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <product_option_values>
        <product_option_value id="85" xlink:href="https://domain.com/webapi/product_option_values/85"/>
        <product_option_value id="12023" xlink:href="https://domain.com/webapi/product_option_values/12023"/>
        <product_option_value id="12024" xlink:href="https://domain.com/webapi/product_option_values/12024"/>
        <product_option_value id="12025" xlink:href="https://domain.com/webapi/product_option_values/12025"/>
        <product_option_value id="50" xlink:href="https://domain.com/webapi/product_option_values/50"/>
        <product_option_value id="61" xlink:href="https://domain.com/webapi/product_option_values/61"/>
        <product_option_value id="64" xlink:href="https://domain.com/webapi/product_option_values/64"/>
        <product_option_value id="71" xlink:href="https://domain.com/webapi/product_option_values/71"/>
        <product_option_value id="72" xlink:href="https://domain.com/webapi/product_option_values/72"/>
        <product_option_value id="74" xlink:href="https://domain.com/webapi/product_option_values/74"/>
        <product_option_value id="12000" xlink:href="https://domain.com/webapi/product_option_values/12000"/>
        <product_option_value id="12001" xlink:href="https://domain.com/webapi/product_option_values/12001"/>
        <product_option_value id="49" xlink:href="https://domain.com/webapi/product_option_values/49"/>
        <product_option_value id="51" xlink:href="https://domain.com/webapi/product_option_values/51"/>
        <product_option_value id="52" xlink:href="https://domain.com/webapi/product_option_values/52"/>
        <product_option_value id="53" xlink:href="https://domain.com/webapi/product_option_values/53"/>
        <product_option_value id="54" xlink:href="https://domain.com/webapi/product_option_values/54"/>
        <product_option_value id="55" xlink:href="https://domain.com/webapi/product_option_values/55"/>
        <product_option_value id="56" xlink:href="https://domain.com/webapi/product_option_values/56"/>
        <product_option_value id="57" xlink:href="https://domain.com/webapi/product_option_values/57"/>
        <product_option_value id="58" xlink:href="https://domain.com/webapi/product_option_values/58"/>
        <product_option_value id="59" xlink:href="https://domain.com/webapi/product_option_values/59"/>
        <product_option_value id="60" xlink:href="https://domain.com/webapi/product_option_values/60"/>
        <product_option_value id="62" xlink:href="https://domain.com/webapi/product_option_values/62"/>
        <product_option_value id="63" xlink:href="https://domain.com/webapi/product_option_values/63"/>
        <product_option_value id="65" xlink:href="https://domain.com/webapi/product_option_values/65"/>
        <product_option_value id="66" xlink:href="https://domain.com/webapi/product_option_values/66"/>
        <product_option_value id="67" xlink:href="https://domain.com/webapi/product_option_values/67"/>
        <product_option_value id="68" xlink:href="https://domain.com/webapi/product_option_values/68"/>
        <product_option_value id="69" xlink:href="https://domain.com/webapi/product_option_values/69"/>
        <product_option_value id="70" xlink:href="https://domain.com/webapi/product_option_values/70"/>
        <product_option_value id="73" xlink:href="https://domain.com/webapi/product_option_values/73"/>
        <product_option_value id="75" xlink:href="https://domain.com/webapi/product_option_values/75"/>
        <product_option_value id="76" xlink:href="https://domain.com/webapi/product_option_values/76"/>
        <product_option_value id="77" xlink:href="https://domain.com/webapi/product_option_values/77"/>
        <product_option_value id="79" xlink:href="https://domain.com/webapi/product_option_values/79"/>
        <product_option_value id="80" xlink:href="https://domain.com/webapi/product_option_values/80"/>
        <product_option_value id="81" xlink:href="https://domain.com/webapi/product_option_values/81"/>
        <product_option_value id="82" xlink:href="https://domain.com/webapi/product_option_values/82"/>
        <product_option_value id="83" xlink:href="https://domain.com/webapi/product_option_values/83"/>
        <product_option_value id="84" xlink:href="https://domain.com/webapi/product_option_values/84"/>
        <product_option_value id="86" xlink:href="https://domain.com/webapi/product_option_values/86"/>
        <product_option_value id="12002" xlink:href="https://domain.com/webapi/product_option_values/12002"/>
        <product_option_value id="12009" xlink:href="https://domain.com/webapi/product_option_values/12009"/>
        <product_option_value id="12010" xlink:href="https://domain.com/webapi/product_option_values/12010"/>
        <product_option_value id="12019" xlink:href="https://domain.com/webapi/product_option_values/12019"/>
        <product_option_value id="12020" xlink:href="https://domain.com/webapi/product_option_values/12020"/>
        <product_option_value id="12021" xlink:href="https://domain.com/webapi/product_option_values/12021"/>
        <product_option_value id="12022" xlink:href="https://domain.com/webapi/product_option_values/12022"/>
        <product_option_value id="78" xlink:href="https://domain.com/webapi/product_option_values/78"/>
        <product_option_value id="12003" xlink:href="https://domain.com/webapi/product_option_values/12003"/>
        <product_option_value id="12004" xlink:href="https://domain.com/webapi/product_option_values/12004"/>
        <product_option_value id="12005" xlink:href="https://domain.com/webapi/product_option_values/12005"/>
        <product_option_value id="12006" xlink:href="https://domain.com/webapi/product_option_values/12006"/>
        <product_option_value id="12007" xlink:href="https://domain.com/webapi/product_option_values/12007"/>
        <product_option_value id="12008" xlink:href="https://domain.com/webapi/product_option_values/12008"/>
        <product_option_value id="12011" xlink:href="https://domain.com/webapi/product_option_values/12011"/>
        <product_option_value id="12012" xlink:href="https://domain.com/webapi/product_option_values/12012"/>
        <product_option_value id="12013" xlink:href="https://domain.com/webapi/product_option_values/12013"/>
        <product_option_value id="12014" xlink:href="https://domain.com/webapi/product_option_values/12014"/>
        <product_option_value id="12015" xlink:href="https://domain.com/webapi/product_option_values/12015"/>
        <product_option_value id="12016" xlink:href="https://domain.com/webapi/product_option_values/12016"/>
        <product_option_value id="12017" xlink:href="https://domain.com/webapi/product_option_values/12017"/>
        <product_option_value id="12018" xlink:href="https://domain.com/webapi/product_option_values/12018"/>
        <product_option_value id="12026" xlink:href="https://domain.com/webapi/product_option_values/12026"/>
        <product_option_value id="12027" xlink:href="https://domain.com/webapi/product_option_values/12027"/>
        <product_option_value id="12028" xlink:href="https://domain.com/webapi/product_option_values/12028"/>
        <product_option_value id="12029" xlink:href="https://domain.com/webapi/product_option_values/12029"/>
        <product_option_value id="12030" xlink:href="https://domain.com/webapi/product_option_values/12030"/>
    </product_option_values>
</groovekart>
														

Variations

First of all need to clearly understand the difference between Variation, Variant, Variant Group and Value
Let's say we have a Sizes Large and Small and Colors Black and White
Variant Group are Size and Color. Where we have Variant Values as Blaock & White, Large and Small
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small
Product Object mainly need Variaitons, because each Variation can have different Price
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small

Attributes

No Attributes.

Returns

Returns the List of all product.

GET

No Parameter

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <combinations>
        <combination id="2" xlink:href="https://domain.com/webapi/combinations/2"/>
        <combination id="3" xlink:href="https://domain.com/webapi/combinations/3"/>
        <combination id="4" xlink:href="https://domain.com/webapi/combinations/4"/>
        <combination id="5" xlink:href="https://domain.com/webapi/combinations/5"/>
        <combination id="6" xlink:href="https://domain.com/webapi/combinations/6"/>
        <combination id="7" xlink:href="https://domain.com/webapi/combinations/7"/>
        <combination id="8" xlink:href="https://domain.com/webapi/combinations/8"/>
        <combination id="9" xlink:href="https://domain.com/webapi/combinations/9"/>
        <combination id="10" xlink:href="https://domain.com/webapi/combinations/10"/>
        <combination id="1" xlink:href="https://domain.com/webapi/combinations/1"/>
    </combinations>
</groovekart>
														

Variant Groups

First of all need to clearly understand the difference between Variation, Variant, Variant Group and Value
Let's say we have a Sizes Large and Small and Colors Black and White
Variant Group are Size and Color. Where we have Variant Values as Blaock & White, Large and Small
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small
Product Object mainly need Variaitons, because each Variation can have different Price
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small

Attributes

No Attributes.

Returns

Returns the detail of the product.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <product_option>
        <id>
            <![CDATA[8]]>
        </id>
        <is_color_group>
            <![CDATA[0]]>
        </is_color_group>
        <group_type>
            <![CDATA[radio]]>
        </group_type>
        <position>
            <![CDATA[4]]>
        </position>
        <name>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Size]]>
            </language>
        </name>
        <public_name>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Size]]>
            </language>
        </public_name>
        <associations>
            <product_option_values nodeType="product_option_value" api="product_option_values">
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/49">
                    <id>
                        <![CDATA[49]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/51">
                    <id>
                        <![CDATA[51]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/52">
                    <id>
                        <![CDATA[52]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/53">
                    <id>
                        <![CDATA[53]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/54">
                    <id>
                        <![CDATA[54]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/55">
                    <id>
                        <![CDATA[55]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/56">
                    <id>
                        <![CDATA[56]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/57">
                    <id>
                        <![CDATA[57]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/58">
                    <id>
                        <![CDATA[58]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/59">
                    <id>
                        <![CDATA[59]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/60">
                    <id>
                        <![CDATA[60]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/62">
                    <id>
                        <![CDATA[62]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/63">
                    <id>
                        <![CDATA[63]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/65">
                    <id>
                        <![CDATA[65]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/66">
                    <id>
                        <![CDATA[66]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/67">
                    <id>
                        <![CDATA[67]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/68">
                    <id>
                        <![CDATA[68]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/69">
                    <id>
                        <![CDATA[69]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/70">
                    <id>
                        <![CDATA[70]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/73">
                    <id>
                        <![CDATA[73]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/75">
                    <id>
                        <![CDATA[75]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/76">
                    <id>
                        <![CDATA[76]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/77">
                    <id>
                        <![CDATA[77]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/79">
                    <id>
                        <![CDATA[79]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/80">
                    <id>
                        <![CDATA[80]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/81">
                    <id>
                        <![CDATA[81]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/82">
                    <id>
                        <![CDATA[82]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/83">
                    <id>
                        <![CDATA[83]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/84">
                    <id>
                        <![CDATA[84]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/86">
                    <id>
                        <![CDATA[86]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/12002">
                    <id>
                        <![CDATA[12002]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/12009">
                    <id>
                        <![CDATA[12009]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/12010">
                    <id>
                        <![CDATA[12010]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/12019">
                    <id>
                        <![CDATA[12019]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/12020">
                    <id>
                        <![CDATA[12020]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/12021">
                    <id>
                        <![CDATA[12021]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/12022">
                    <id>
                        <![CDATA[12022]]>
                    </id>
                </product_option_value>
            </product_option_values>
        </associations>
    </product_option>
</groovekart>
														

Variant Values

First of all need to clearly understand the difference between Variation, Variant, Variant Group and Value
Let's say we have a Sizes Large and Small and Colors Black and White
Variant Group are Size and Color. Where we have Variant Values as Blaock & White, Large and Small
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small
Product Object mainly need Variaitons, because each Variation can have different Price
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small

Attributes

No Attributes.

Returns

Returns the detail of the product.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <product_option_value>
        <id>
            <![CDATA[80]]>
        </id>
        <id_attribute_group xlink:href="https://domain.com/webapi/product_options/8">
            <![CDATA[8]]>
        </id_attribute_group>
        <color></color>
        <position>
            <![CDATA[4]]>
        </position>
        <name>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[M]]>
            </language>
        </name>
    </product_option_value>
</groovekart>
														

Variations

First of all need to clearly understand the difference between Variation, Variant, Variant Group and Value
Let's say we have a Sizes Large and Small and Colors Black and White
Variant Group are Size and Color. Where we have Variant Values as Blaock & White, Large and Small
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small
Product Object mainly need Variaitons, because each Variation can have different Price
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small

Attributes

No Attributes.

Returns

Returns the detail of the product.

GET

No Parameter

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <combination>
        <id>
            <![CDATA[3]]>
        </id>
        <id_product xlink:href="https://domain.com/webapi/products/2">
            <![CDATA[2]]>
        </id_product>
        <quantity>
            <![CDATA[0]]>
        </quantity>
        <reference>
            <![CDATA[CASCS32-799309]]>
        </reference>
        <price>
            <![CDATA[59.950000]]>
        </price>
        <compare_price>
            <![CDATA[119.91]]>
        </compare_price>
        <weight>
            <![CDATA[0.000000]]>
        </weight>
        <default_on></default_on>
        <associations>
            <product_option_values nodeType="product_option_value" api="product_option_values">
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/50">
                    <id>
                        <![CDATA[50]]>
                    </id>
                </product_option_value>
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/52">
                    <id>
                        <![CDATA[52]]>
                    </id>
                </product_option_value>
            </product_option_values>
            <images nodeType="image" api="images/products"/>
        </associations>
    </combination>
</groovekart>
														

Variant Groups

First of all need to clearly understand the difference between Variation, Variant, Variant Group and Value
Let's say we have a Sizes Large and Small and Colors Black and White
Variant Group are Size and Color. Where we have Variant Values as Blaock & White, Large and Small
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small
Product Object mainly need Variaitons, because each Variation can have different Price
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small

Main Attributes

  • is_color_group optional

    type: numeric

    0 1

    If you want to display an image or HEX color instead of text - this value should be set to 1

  • group_type required

    type: text

    0 1

    Basically it's a matter of appearance. YOu can display them on Store Front as a dropdown values, buttons or image/HEX

    Please try to not use dropdown. It will be a staled option in the nearest future

  • position optional

    type: numeric

  • name required

    type: text

    Technical Name for Store Dashboard should be unique

    Show child attributes

  • public_name required

    type: text

    Name which will be visible for Buyers on Store Front

    Show child attributes

  • associations optional

    type: array

    Here you will assign Variant Values

    Show child attributes

Returns

Returns of new added product.

POST
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <product_option>
        <id></id>
        <is_color_group>0</is_color_group>
        <group_type>select</group_type>
        <position></position>
        <name>
            <language id="1">Gender</language>
        </name>
        <public_name>
            <language id="1">Gender</language>
        </public_name>
        <associations>
            <product_option_values>
                <product_option_value>
                    <id></id>
                </product_option_value>
            </product_option_values>
        </associations>
    </product_option>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <product_option>
        <id>
            <![CDATA[14]]>
        </id>
        <is_color_group></is_color_group>
        <group_type>
            <![CDATA[select]]>
        </group_type>
        <position>
            <![CDATA[7]]>
        </position>
        <name>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Gender]]>
            </language>
        </name>
        <public_name>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Gender]]>
            </language>
        </public_name>
        <associations>
            <product_option_values nodeType="product_option_value" api="product_option_values"/>
        </associations>
    </product_option>
</groovekart>
														

Variant Values

First of all need to clearly understand the difference between Variation, Variant, Variant Group and Value
Let's say we have a Sizes Large and Small and Colors Black and White
Variant Group are Size and Color. Where we have Variant Values as Blaock & White, Large and Small
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small
Product Object mainly need Variaitons, because each Variation can have different Price
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small

Main Attributes

  • id required on update

    type: numeric

  • id_attribute_group required

    type: numeric

  • color optional

    type: text

  • position optional

    type: numeric

  • name required

    type: text

    Show child attributes

Returns

Returns of new added product.

POST
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
<product_option_value>
        <id></id>
        <id_attribute_group>12</id_attribute_group>
        <color></color>
        <position></position>
        <name><language id="1">Female</language></name>
</product_option_value>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <product_option_value>
        <id>
            <![CDATA[12031]]>
        </id>
        <id_attribute_group xlink:href="https://domain.com/webapi/product_options/12">
            <![CDATA[12]]>
        </id_attribute_group>
        <color></color>
        <position>
            <![CDATA[1]]>
        </position>
        <name>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Female]]>
            </language>
        </name>
    </product_option_value>
</groovekart>
														

Variations

First of all need to clearly understand the difference between Variation, Variant, Variant Group and Value
Let's say we have a Sizes Large and Small and Colors Black and White
Variant Group are Size and Color. Where we have Variant Values as Blaock & White, Large and Small
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small
Product Object mainly need Variaitons, because each Variation can have different Price
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small

Main Attributes

  • id required on update

    type: numeric

  • id_product required

    type: numeric

  • quantity optional

    type: numeric

  • reference optional

    type: text

  • price optional

    type: numeric

  • compare_price optional

    type: text

  • weight optional

    type: numeric

  • associations required

    type: array

    Show child attributes

Returns

Returns of new added product.

GET
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <combination>
        <id></id>
        <id_product>63</id_product>
        <reference></reference>
        <price>100</price>
        <compare_price>130</compare_price>
        <weight></weight>
        <default_on>0</default_on>
        <associations>
            <product_option_values>
                <product_option_value>
                    <id>12017</id>
                </product_option_value>
            </product_option_values>
            <images>
                <image>
                    <id></id>
                </image>
            </images>
        </associations>
    </combination>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <combination>
        <id>
            <![CDATA[550]]>
        </id>
        <id_product xlink:href="https://domain.com/webapi/products/63">
            <![CDATA[63]]>
        </id_product>
        <quantity></quantity>
        <reference></reference>
        <price>
            <![CDATA[100]]>
        </price>
        <compare_price>
            <![CDATA[130]]>
        </compare_price>
        <weight></weight>
        <default_on></default_on>
        <associations>
            <product_option_values nodeType="product_option_value" api="product_option_values">
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/12017">
                    <id>
                        <![CDATA[12017]]>
                    </id>
                </product_option_value>
            </product_option_values>
            <images nodeType="image" api="images/products">
                <image xlink:href="https://domain.com/webapi/images/products/63/0">
                    <id>
                        <![CDATA[0]]>
                    </id>
                </image>
            </images>
        </associations>
    </combination>
</groovekart>
														

Variant Groups

First of all need to clearly understand the difference between Variation, Variant, Variant Group and Value
Let's say we have a Sizes Large and Small and Colors Black and White
Variant Group are Size and Color. Where we have Variant Values as Blaock & White, Large and Small
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small
Product Object mainly need Variaitons, because each Variation can have different Price
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small

Main Attributes

  • is_color_group optional

    type: numeric

    0 1

    If you want to display an image or HEX color instead of text - this value should be set to 1

  • group_type required

    type: text

    0 1

    Basically it's a matter of appearance. YOu can display them on Store Front as a dropdown values, buttons or image/HEX

    Please try to not use dropdown. It will be a staled option in the nearest future

  • position optional

    type: numeric

  • name required

    type: text

    Technical Name for Store Dashboard should be unique

    Show child attributes

  • public_name required

    type: text

    Name which will be visible for Buyers on Store Front

    Show child attributes

  • associations optional

    type: array

    Here you will assign Variant Values

    Show child attributes

Returns

Returns of new added product.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <product_option>
        <id>14</id>
        <is_color_group>0</is_color_group>
        <group_type>radio</group_type>
        <position></position>
        <name>
            <language id="1">Gender</language>
        </name>
        <public_name>
            <language id="1">Gender</language>
        </public_name>
        <associations>
            <product_option_values>
                <product_option_value>
                    <id></id>
                </product_option_value>
            </product_option_values>
        </associations>
    </product_option>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <product_option>
        <id>
            <![CDATA[14]]>
        </id>
        <is_color_group></is_color_group>
        <group_type>
            <![CDATA[radio]]>
        </group_type>
        <position></position>
        <name>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Gender]]>
            </language>
        </name>
        <public_name>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Gender]]>
            </language>
        </public_name>
        <associations>
            <product_option_values nodeType="product_option_value" api="product_option_values"/>
        </associations>
    </product_option>
</groovekart>
														

Variant Values

First of all need to clearly understand the difference between Variation, Variant, Variant Group and Value
Let's say we have a Sizes Large and Small and Colors Black and White
Variant Group are Size and Color. Where we have Variant Values as Blaock & White, Large and Small
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small
Product Object mainly need Variaitons, because each Variation can have different Price
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small

Main Attributes

  • id required on update

    type: numeric

  • id_attribute_group required

    type: numeric

  • color optional

    type: text

  • position optional

    type: numeric

  • name required

    type: text

    Show child attributes

Returns

Returns of new added product.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
<product_option_value>
        <id>12018</id>
        <id_attribute_group>12</id_attribute_group>
        <color></color>
        <position></position>
        <name><language id="1">FeMale</language></name>
</product_option_value>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <product_option_value>
        <id>
            <![CDATA[12018]]>
        </id>
        <id_attribute_group xlink:href="https://domain.com/webapi/product_options/12">
            <![CDATA[12]]>
        </id_attribute_group>
        <color></color>
        <position></position>
        <name>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[FeMale]]>
            </language>
        </name>
    </product_option_value>
</groovekart>
														

Variations

First of all need to clearly understand the difference between Variation, Variant, Variant Group and Value
Let's say we have a Sizes Large and Small and Colors Black and White
Variant Group are Size and Color. Where we have Variant Values as Blaock & White, Large and Small
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small
Product Object mainly need Variaitons, because each Variation can have different Price
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small

Main Attributes

  • id required on update

    type: numeric

  • id_product required

    type: numeric

  • quantity optional

    type: numeric

  • reference optional

    type: text

  • price optional

    type: numeric

  • compare_price optional

    type: text

  • weight optional

    type: numeric

  • associations required

    type: array

    Show child attributes

Returns

Returns of new added product.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <combination>
        <id>550</id>
        <id_product>63</id_product>
        <reference></reference>
        <price>110</price>
        <compare_price>130</compare_price>
        <weight></weight>
        <default_on>0</default_on>
        <associations>
            <product_option_values>
                <product_option_value>
                    <id>12017</id>
                </product_option_value>
            </product_option_values>
            <images>
                <image>
                    <id></id>
                </image>
            </images>
        </associations>
    </combination>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <combination>
        <id>
            <![CDATA[550]]>
        </id>
        <id_product xlink:href="https://domain.com/webapi/products/63">
            <![CDATA[63]]>
        </id_product>
        <quantity></quantity>
        <reference></reference>
        <price>
            <![CDATA[110]]>
        </price>
        <compare_price>
            <![CDATA[130]]>
        </compare_price>
        <weight></weight>
        <default_on></default_on>
        <associations>
            <product_option_values nodeType="product_option_value" api="product_option_values">
                <product_option_value xlink:href="https://domain.com/webapi/product_option_values/12017">
                    <id>
                        <![CDATA[12017]]>
                    </id>
                </product_option_value>
            </product_option_values>
            <images nodeType="image" api="images/products">
                <image xlink:href="https://domain.com/webapi/images/products/63/0">
                    <id>
                        <![CDATA[0]]>
                    </id>
                </image>
            </images>
        </associations>
    </combination>
</groovekart>
														

Variant Groups

First of all need to clearly understand the difference between Variation, Variant, Variant Group and Value
Let's say we have a Sizes Large and Small and Colors Black and White
Variant Group are Size and Color. Where we have Variant Values as Blaock & White, Large and Small
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small
Product Object mainly need Variaitons, because each Variation can have different Price
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

DELETE

No Attributes

Response

Successfully deleted


Variant Values

First of all need to clearly understand the difference between Variation, Variant, Variant Group and Value
Let's say we have a Sizes Large and Small and Colors Black and White
Variant Group are Size and Color. Where we have Variant Values as Blaock & White, Large and Small
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small
Product Object mainly need Variaitons, because each Variation can have different Price
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

DELETE

No Attributes

Response

Successfully deleted


Variations

First of all need to clearly understand the difference between Variation, Variant, Variant Group and Value
Let's say we have a Sizes Large and Small and Colors Black and White
Variant Group are Size and Color. Where we have Variant Values as Blaock & White, Large and Small
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small
Product Object mainly need Variaitons, because each Variation can have different Price
Variaitons are combinations of Variant Values like: Black - Large, Black - Small and White - Large, White - Small

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

DELETE

No Attributes

Response

Successfully deleted

All Product Images

https://domain.com/webapi/images/products/

Attributes

No Attributes.

Returns

Returns the List of all products.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <images>
        <image id="2" xlink:href="https://domain.com/webapi/images/products/2"/>
        <image id="3" xlink:href="https://domain.com/webapi/images/products/3"/>
        <image id="4" xlink:href="https://domain.com/webapi/images/products/4"/>
        <image id="5" xlink:href="https://domain.com/webapi/images/products/5"/>
        <image id="6" xlink:href="https://domain.com/webapi/images/products/6"/>
        <image id="163" xlink:href="https://domain.com/webapi/images/products/163"/>
        <image id="164" xlink:href="https://domain.com/webapi/images/products/164"/>
        <image id="166" xlink:href="https://domain.com/webapi/images/products/166"/>
        <image id="167" xlink:href="https://domain.com/webapi/images/products/167"/>
        <image id="179" xlink:href="https://domain.com/webapi/images/products/179"/>
        <image id="180" xlink:href="https://domain.com/webapi/images/products/180"/>
        <image id="182" xlink:href="https://domain.com/webapi/images/products/182"/>
        <image id="185" xlink:href="https://domain.com/webapi/images/products/185"/>
    </images>
</groovekart>
														

Product Images

https://domain.com/webapi/images/products/166/

Attributes

No Attributes.

Returns

Returns the Images List of the product Images.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <image id="166">
        <declination id="111245" xlink:href="https://domain.com/webapi/images/products/166/111245"/>
        <declination id="111252" xlink:href="https://domain.com/webapi/images/products/166/111252"/>
        <declination id="111253" xlink:href="https://domain.com/webapi/images/products/166/111253"/>
        <declination id="111254" xlink:href="https://domain.com/webapi/images/products/166/111254"/>
        <declination id="111255" xlink:href="https://domain.com/webapi/images/products/166/111255"/>
        <declination id="111256" xlink:href="https://domain.com/webapi/images/products/166/111256"/>
        <declination id="111257" xlink:href="https://domain.com/webapi/images/products/166/111257"/>
        <declination id="111258" xlink:href="https://domain.com/webapi/images/products/166/111258"/>
        <declination id="111259" xlink:href="https://domain.com/webapi/images/products/166/111259"/>
        <declination id="111260" xlink:href="https://domain.com/webapi/images/products/166/111260"/>
        <declination id="111261" xlink:href="https://domain.com/webapi/images/products/166/111261"/>
        <declination id="111262" xlink:href="https://domain.com/webapi/images/products/166/111262"/>
        <declination id="111263" xlink:href="https://domain.com/webapi/images/products/166/111263"/>
        <declination id="111264" xlink:href="https://domain.com/webapi/images/products/166/111264"/>
        <declination id="111283" xlink:href="https://domain.com/webapi/images/products/166/111283"/>
    </image>
</groovekart>
														

Product Images

https://domain.com/webapi/images/products/166/111283

Attributes

No Attributes.

Returns

Returns the Image of the product.

GET

No Attributes

Response
Returns the Image

Product Images

https://domain.com/webapi/images/products/166/

Main Attributes

  • image required

    type: string

Returns

Returns of new added Image.

POST
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <images>
        <image>https://cdn.groovekart.com/xxxxxxxx/img/p/1/1/1/1/4/1/111141.webp</image>
    </images>
</groovekart>    
														
Response
Returns the Image

Product Images

https://domain.com/webapi/images/products/166/111284

Main Attributes

  • image required

    type: string

Returns

Returns the updated Image.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <images>
        <image>https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_92x30dp.png</image>
    </images>
</groovekart>  
														
Response

Returns the Image

Product Images

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

DELETE

No Attributes

Response

Successfully deleted

Product Categories

important about Categories. Every store have Root category with Id 1 and Home category as ID 2. This is a Mandatory.
So every root category on the store should have a id_parent as ID 2

Attributes

No Attributes.

Returns

Returns the List of all products.

GET

No Parameter

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <categories>
        <category id="1" xlink:href="https://domain.com/webapi/categories/1"/>
        <category id="2" xlink:href="https://domain.com/webapi/categories/2"/>
        <category id="25" xlink:href="https://domain.com/webapi/categories/25"/>
        <category id="26" xlink:href="https://domain.com/webapi/categories/26"/>
        <category id="27" xlink:href="https://domain.com/webapi/categories/27"/>
        <category id="28" xlink:href="https://domain.com/webapi/categories/28"/>
        <category id="29" xlink:href="https://domain.com/webapi/categories/29"/>
        <category id="30" xlink:href="https://domain.com/webapi/categories/30"/>
        <category id="31" xlink:href="https://domain.com/webapi/categories/31"/>
        <category id="32" xlink:href="https://domain.com/webapi/categories/32"/>
        <category id="33" xlink:href="https://domain.com/webapi/categories/33"/>
    </categories>
</groovekart>
														

Product Categories

important about Categories. Every store have Root category with Id 1 and Home category as ID 2. This is a Mandatory.
So every root category on the store should have a id_parent as ID 2

Attributes

No Attributes.

Returns

Returns the detail of the product.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <category>
        <id>
            <![CDATA[25]]>
        </id>
        <id_parent xlink:href="http://domain.com/webapi/categories/2">
            <![CDATA[2]]>
        </id_parent>
        <active>
            <![CDATA[1]]>
        </active>
        <display_from_sub>
            <![CDATA[1]]>
        </display_from_sub>
        <date_add>
            <![CDATA[2020-03-27 05:29:11]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-08-04 04:07:51]]>
        </date_upd>
        <name>
            <language id="1" xlink:href="http://domain.com/webapi/languages/1">
                <![CDATA[Best deals]]>
            </language>
        </name>
        <link_rewrite>
            <language id="1" xlink:href="http://domain.com/webapi/languages/1">
                <![CDATA[best-deals]]>
            </language>
        </link_rewrite>
        <description>
            <language id="1" xlink:href="http://domain.com/webapi/languages/1">
                <![CDATA[<p>This is a category description which can be changed from Categories Page. Categories Page link is available from left menu</p>]]>
            </language>
        </description>
        <meta_title>
            <language id="1" xlink:href="http://domain.com/webapi/languages/1">
                <![CDATA[]]>
            </language>
        </meta_title>
        <meta_description>
            <language id="1" xlink:href="http://domain.com/webapi/languages/1">
                <![CDATA[]]>
            </language>
        </meta_description>
        <associations>
            <categories nodeType="category" api="categories"/>
            <products nodeType="product" api="products">
                <product xlink:href="http://domain.com/webapi/products/2">
                    <id>
                        <![CDATA[2]]>
                    </id>
                </product>
                <product xlink:href="http://domain.com/webapi/products/140">
                    <id>
                        <![CDATA[140]]>
                    </id>
                </product>
            </products>
        </associations>
    </category>
</groovekart>
														

Product Categories

important about Categories. Every store have Root category with Id 1 and Home category as ID 2. This is a Mandatory.
So every root category on the store should have a id_parent as ID 2

Main Attributes

  • id required

    type: numeric

  • id_parent required

    type: numeric

    Id of a parent category in the hierarchy of your catalog

    Please read a description. If you are adding a Root category for your store id_parent should be 2

  • active required

    type: numeric

    Active categories will be visible on Store Front, not active - will be hidden

  • display_from_sub required

    type: numeric

  • date_add optional

    type: date

  • date_upd optional

    type: date

  • name required

    type: text

    Public Name of the Category

    Show child attributes

  • link_rewrite optional

    type: text

    Friendly url of the Category. If not passed - it will taken from Public Name

    pass url for this category, no need to save absolute path to this category

    Show child attributes

  • description required

    type: html

    Public Description for the Category

    Show child attributes

  • meta_title optional

    type: text

    Meta title for the Category

    Show child attributes

  • meta_description optional

    type: text

    Meta description for the Category

    Show child attributes

  • associations optional

    type: array

    Show child attributes

Returns

Returns of new added product.

POST
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <category>
        <id></id>
        <id_parent>2</id_parent>
        <active>1</active>
        <date_add></date_add>
        <date_upd></date_upd>
        <name>
            <language id="1">API Category</language>
        </name>
        <link_rewrite>
            <language id="1">api-category</language>
        </link_rewrite>
        <description>
            <language id="1"></language>
        </description>
        <meta_title>
            <language id="1"></language>
        </meta_title>
        <meta_description>
            <language id="1"></language>
        </meta_description>
        <associations>
            <categories>
                <category>
                    <id></id>
                </category>
            </categories>
            <products>
                <product>
                    <id></id>
                </product>
            </products>
        </associations>
    </category>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <category>
        <id>
            <![CDATA[34]]>
        </id>
        <id_parent xlink:href="http://domain.com/webapi/categories/2">
            <![CDATA[2]]>
        </id_parent>
        <active>
            <![CDATA[1]]>
        </active>
        <display_from_sub></display_from_sub>
        <date_add>
            <![CDATA[2021-10-01 06:07:33]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-10-01 06:07:33]]>
        </date_upd>
        <name>
            <language id="1" xlink:href="http://domain.com/webapi/languages/1">
                <![CDATA[API Category]]>
            </language>
        </name>
        <link_rewrite>
            <language id="1" xlink:href="http://domain.com/webapi/languages/1">
                <![CDATA[api-category]]>
            </language>
        </link_rewrite>
        <description>
            <language id="1" xlink:href="http://domain.com/webapi/languages/1">
                <![CDATA[]]>
            </language>
        </description>
        <meta_title>
            <language id="1" xlink:href="http://domain.com/webapi/languages/1">
                <![CDATA[]]>
            </language>
        </meta_title>
        <meta_description>
            <language id="1" xlink:href="http://domain.com/webapi/languages/1">
                <![CDATA[]]>
            </language>
        </meta_description>
        <associations>
            <categories nodeType="category" api="categories"/>
            <products nodeType="product" api="products"/>
        </associations>
    </category>
</groovekart>
														

Product Categories

important about Categories. Every store have Root category with Id 1 and Home category as ID 2. This is a Mandatory.
So every root category on the store should have a id_parent as ID 2

Main Attributes

  • id required

    type: numeric

  • id_parent required

    type: numeric

    Id of a parent category in the hierarchy of your catalog

    Please read a description. If you are adding a Root category for your store id_parent should be 2

  • active required

    type: numeric

    Active categories will be visible on Store Front, not active - will be hidden

  • display_from_sub required

    type: numeric

  • date_add optional

    type: date

  • date_upd optional

    type: date

  • name required

    type: text

    Public Name of the Category

    Show child attributes

  • link_rewrite optional

    type: text

    Friendly url of the Category. If not passed - it will taken from Public Name

    pass url for this category, no need to save absolute path to this category

    Show child attributes

  • description required

    type: html

    Public Description for the Category

    Show child attributes

  • meta_title optional

    type: text

    Meta title for the Category

    Show child attributes

  • meta_description optional

    type: text

    Meta description for the Category

    Show child attributes

  • associations optional

    type: array

    Show child attributes

Returns

Returns the update of products.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <category>
        <id>34</id>
        <id_parent>2</id_parent>
        <active>1</active>
        <date_add>2021-10-01 06:07:33</date_add>
        <date_upd></date_upd>
        <name>
            <language id="1">API Category</language>
        </name>
        <link_rewrite>
            <language id="1">api-category</language>
        </link_rewrite>
        <description>
            <language id="1"></language>
        </description>
        <meta_title>
            <language id="1"></language>
        </meta_title>
        <meta_description>
            <language id="1"></language>
        </meta_description>
        <associations>
            <categories>
                <category>
                    <id></id>
                </category>
            </categories>
            <products>
                <product>
                    <id></id>
                </product>
            </products>
        </associations>
    </category>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <category>
        <id>
            <![CDATA[34]]>
        </id>
        <id_parent xlink:href="http://domain.com/webapi/categories/2">
            <![CDATA[2]]>
        </id_parent>
        <active>
            <![CDATA[1]]>
        </active>
        <display_from_sub></display_from_sub>
        <date_add>
            <![CDATA[2021-10-01 06:07:33]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-10-01 06:08:30]]>
        </date_upd>
        <name>
            <language id="1" xlink:href="http://domain.com/webapi/languages/1">
                <![CDATA[API Category]]>
            </language>
        </name>
        <link_rewrite>
            <language id="1" xlink:href="http://domain.com/webapi/languages/1">
                <![CDATA[api-category]]>
            </language>
        </link_rewrite>
        <description>
            <language id="1" xlink:href="http://domain.com/webapi/languages/1">
                <![CDATA[]]>
            </language>
        </description>
        <meta_title>
            <language id="1" xlink:href="http://domain.com/webapi/languages/1">
                <![CDATA[]]>
            </language>
        </meta_title>
        <meta_description>
            <language id="1" xlink:href="http://domain.com/webapi/languages/1">
                <![CDATA[]]>
            </language>
        </meta_description>
        <associations>
            <categories nodeType="category" api="categories"/>
            <products nodeType="product" api="products"/>
        </associations>
    </category>
</groovekart>
														

Product Categories

important about Categories. Every store have Root category with Id 1 and Home category as ID 2. This is a Mandatory.
So every root category on the store should have a id_parent as ID 2

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

DELETE

No Attributes

Response

Successfully deleted

Product Tags

Attributes

No Attributes.

Returns

Returns the List of all products.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <tags>
        <tag id="1" xlink:href="https://domain.com/webapi/tags/1"/>
        <tag id="2" xlink:href="https://domain.com/webapi/tags/2"/>
        <tag id="3" xlink:href="https://domain.com/webapi/tags/3"/>
        <tag id="4" xlink:href="https://domain.com/webapi/tags/4"/>
        <tag id="6" xlink:href="https://domain.com/webapi/tags/6"/>
        <tag id="7" xlink:href="https://domain.com/webapi/tags/7"/>
        <tag id="8" xlink:href="https://domain.com/webapi/tags/8"/>
        <tag id="9" xlink:href="https://domain.com/webapi/tags/9"/>
        <tag id="10" xlink:href="https://domain.com/webapi/tags/10"/>
    </tags>
</groovekart>
														

Product Tags

Attributes

No Attributes.

Returns

Returns the detail of the product.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <tag>
        <id>
            <![CDATA[1]]>
        </id>
        <id_lang xlink:href="https://domain.com/webapi/languages/1">
            <![CDATA[1]]>
        </id_lang>
        <name>
            <![CDATA[tag1]]>
        </name>
    </tag>
</groovekart>
														

Product Tags

Main Attributes

  • id required on update

    type: numeric

  • id_lang required

    type: numeric

    English is having ID 1 on all the stores

  • Name required

    type: text

    Only A-Z and 0-9 are allowed. No special characters

    Public Name of the tag

Returns

Returns of new added product.

POST
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <tag>
        <id></id>
        <id_lang>1</id_lang>
        <name>tshirt</name>
    </tag>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <tag>
        <id>
            <![CDATA[42]]>
        </id>
        <id_lang xlink:href="https://domain.com/webapi/languages/1">
            <![CDATA[1]]>
        </id_lang>
        <name>
            <![CDATA[tshirt]]>
        </name>
    </tag>
</groovekart>
														

Product Tags

Main Attributes

  • id required on update

    type: numeric

  • id_lang required

    type: numeric

    English is having ID 1 on all the stores

  • Name required

    type: text

    Only A-Z and 0-9 are allowed. No special characters

    Public Name of the tag

Returns

Returns the update of products.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <tag>
        <id>42</id>
        <id_lang>1</id_lang>
        <name>t-shirt</name>
    </tag>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <tag>
        <id>
            <![CDATA[42]]>
        </id>
        <id_lang xlink:href="https://domain.com/webapi/languages/1">
            <![CDATA[1]]>
        </id_lang>
        <name>
            <![CDATA[t-shirt]]>
        </name>
    </tag>
</groovekart>
														

Product Tags

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

GET

No Attributes

Response

Successfully deleted

Product Brands

Attributes

No Attributes.

Returns

Returns the List of all products.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <manufacturers>
        <manufacturer id="1" xlink:href="https://domain.com/webapi/manufacturers/1"/>
        <manufacturer id="2" xlink:href="https://domain.com/webapi/manufacturers/2"/>
        <manufacturer id="3" xlink:href="https://domain.com/webapi/manufacturers/3"/>
        <manufacturer id="4" xlink:href="https://domain.com/webapi/manufacturers/4"/>
        <manufacturer id="5" xlink:href="https://domain.com/webapi/manufacturers/5"/>
        <manufacturer id="6" xlink:href="https://domain.com/webapi/manufacturers/6"/>
        <manufacturer id="7" xlink:href="https://domain.com/webapi/manufacturers/7"/>
        <manufacturer id="8" xlink:href="https://domain.com/webapi/manufacturers/8"/>
        <manufacturer id="9" xlink:href="https://domain.com/webapi/manufacturers/9"/>
    </manufacturers>
</groovekart>
														

Product Brands

Attributes

No Attributes.

Returns

Returns the detail of the product.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <manufacturer>
        <id>
            <![CDATA[2]]>
        </id>
        <active>
            <![CDATA[1]]>
        </active>
        <link_rewrite notFilterable="true">
            <![CDATA[teescape]]>
        </link_rewrite>
        <name>
            <![CDATA[Teescape]]>
        </name>
        <date_add>
            <![CDATA[2020-10-27 08:13:20]]>
        </date_add>
        <date_upd>
            <![CDATA[2020-10-27 08:13:20]]>
        </date_upd>
        <description>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[]]>
            </language>
        </description>
        <short_description>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[]]>
            </language>
        </short_description>
        <meta_title>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[]]>
            </language>
        </meta_title>
        <meta_description>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[]]>
            </language>
        </meta_description>
    </manufacturer>
</groovekart>
														

Product Brands

Main Attributes

  • id required on update

    type: numeric

  • active required

    type: numeric

    1 - active, 0 - disabled

  • name required

    type: text

    Public name of a Brand

  • date_add optional

    type: date

    Date of adding a Brand

  • date_upd optional

    type: date

    Date update of a Brand

  • description optional

    type: html

    Long Desription

    Show child attributes

  • short_description optional

    type: html

    Short Description

    Show child attributes

  • meta_title optional

    type: text

    Meta title of a Brand Page

    If not set it will take a Brand Name

    Show child attributes

  • meta_description optional

    type: text

    Meta description of a Brand page

    If not set it will take Brand Description

    Show child attributes

Returns

Returns of new added product.

POST
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <manufacturer>
        <id></id>
        <active>1</active>
        <name>Printful</name>
        <date_add></date_add>
        <date_upd></date_upd>
        <description>
            <language id="1">Detailed Description TEXT</language>
        </description>
        <short_description>
            <language id="1">Short Description Test</language>
        </short_description>
        <meta_title>
            <language id="1">Meta Title information for SEO</language>
        </meta_title>
        <meta_description>
            <language id="1">Meta Description information for SEO</language>
        </meta_description>
    </manufacturer>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <manufacturer>
        <id>
            <![CDATA[29]]>
        </id>
        <active>
            <![CDATA[1]]>
        </active>
        <link_rewrite notFilterable="true">
            <![CDATA[printful]]>
        </link_rewrite>
        <name>
            <![CDATA[Printful]]>
        </name>
        <date_add>
            <![CDATA[2021-10-01 02:23:34]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-10-01 02:23:34]]>
        </date_upd>
        <description>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Detailed Description TEXT]]>
            </language>
        </description>
        <short_description>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Short Description Test]]>
            </language>
        </short_description>
        <meta_title>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Meta Title information for SEO]]>
            </language>
        </meta_title>
        <meta_description>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Meta Description information for SEO]]>
            </language>
        </meta_description>
    </manufacturer>
</groovekart>
														

Product Brands

Main Attributes

  • id required on update

    type: numeric

  • active required

    type: numeric

    1 - active, 0 - disabled

  • name required

    type: text

    Public name of a Brand

  • date_add optional

    type: date

    Date of adding a Brand

  • date_upd optional

    type: date

    Date update of a Brand

  • description optional

    type: html

    Long Desription

    Show child attributes

  • short_description optional

    type: html

    Short Description

    Show child attributes

  • meta_title optional

    type: text

    Meta title of a Brand Page

    If not set it will take a Brand Name

    Show child attributes

  • meta_description optional

    type: text

    Meta description of a Brand page

    If not set it will take Brand Description

    Show child attributes

Returns

Returns the update of products.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <manufacturer>
        <id>29</id>
        <active>1</active>
        <name>Printful</name>
        <date_add></date_add>
        <date_upd></date_upd>
        <description>
            <language id="1">Detailed description TEXT</language>
        </description>
        <short_description>
            <language id="1">Short description Test</language>
        </short_description>
        <meta_title>
            <language id="1">Meta title information for SEO</language>
        </meta_title>
        <meta_description>
            <language id="1">Meta description information for SEO</language>
        </meta_description>
    </manufacturer>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <manufacturer>
        <id>
            <![CDATA[29]]>
        </id>
        <active>
            <![CDATA[1]]>
        </active>
        <link_rewrite notFilterable="true">
            <![CDATA[printful]]>
        </link_rewrite>
        <name>
            <![CDATA[Printful]]>
        </name>
        <date_add>
            <![CDATA[2021-10-01 02:25:45]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-10-01 02:25:45]]>
        </date_upd>
        <description>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Detailed description TEXT]]>
            </language>
        </description>
        <short_description>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Short description Test]]>
            </language>
        </short_description>
        <meta_title>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Meta title information for SEO]]>
            </language>
        </meta_title>
        <meta_description>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Meta description information for SEO]]>
            </language>
        </meta_description>
        <associations>
            <addresses nodeType="address" api="addresses"/>
        </associations>
    </manufacturer>
</groovekart>
														

Product Brands

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

DELETE

No Attributes

Response

Successfully deleted

Stock Manipulations

Attributes

No Attributes.

Returns

Returns the List of all products.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <stock_availables>
        <stock_available id="2" xlink:href="https://domain.com/webapi/stock_availables/2"/>
        <stock_available id="3" xlink:href="https://domain.com/webapi/stock_availables/3"/>
        <stock_available id="4" xlink:href="https://domain.com/webapi/stock_availables/4"/>
        <stock_available id="5" xlink:href="https://domain.com/webapi/stock_availables/5"/>
        <stock_available id="6" xlink:href="https://domain.com/webapi/stock_availables/6"/>
        <stock_available id="7" xlink:href="https://domain.com/webapi/stock_availables/7"/>
        <stock_available id="8" xlink:href="https://domain.com/webapi/stock_availables/8"/>
        <stock_available id="9" xlink:href="https://domain.com/webapi/stock_availables/9"/>
        <stock_available id="334" xlink:href="https://domain.com/webapi/stock_availables/334"/>
        <stock_available id="335" xlink:href="https://domain.com/webapi/stock_availables/335"/>
    </stock_availables>
</groovekart>
														

Stock Manipulations

Attributes

No Attributes.

Returns

Returns the detail of the product.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <stock_available>
        <id>
            <![CDATA[334]]>
        </id>
        <id_product xlink:href="https://domain.com/webapi/products/62">
            <![CDATA[62]]>
        </id_product>
        <id_product_attribute>
            <![CDATA[0]]>
        </id_product_attribute>
        <id_shop xlink:href="https://domain.com/webapi/shops/1">
            <![CDATA[1]]>
        </id_shop>
        <quantity>
            <![CDATA[123]]>
        </quantity>
    </stock_available>
</groovekart>
														

Stock Manipulations

Main Attributes

  • id

    type: numeric

  • id_product

    type: numeric

  • id_product_attribute

    type: numeric

  • quantity

    type: numeric

Returns

Returns of new added product.

POST
Response
														

Stock Manipulations

Main Attributes

  • id

    type: numeric

  • id_product

    type: numeric

  • id_product_attribute

    type: numeric

  • quantity

    type: numeric

Returns

Returns the update of products.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <stock_available>
        <id>335</id>
        <id_product>63</id_product>
        <id_product_attribute>0</id_product_attribute>
        <id_shop>1</id_shop>
        <quantity>123</quantity>
    </stock_available>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <stock_available>
        <id>
            <![CDATA[335]]>
        </id>
        <id_product xlink:href="https://domain.com/webapi/products/63">
            <![CDATA[63]]>
        </id_product>
        <id_product_attribute>
            <![CDATA[0]]>
        </id_product_attribute>
        <id_shop xlink:href="https://domain.com/webapi/shops/1">
            <![CDATA[1]]>
        </id_shop>
        <quantity>
            <![CDATA[123]]>
        </quantity>
    </stock_available>
</groovekart>
														

Stock Manipulations

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

GET
Response
														

Customers

Attributes

No Attributes.

Returns

Returns the List of all Customers.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <stock_availables>
        <stock_available id="2" xlink:href="https://domain.com/webapi/stock_availables/2"/>
        <stock_available id="3" xlink:href="https://domain.com/webapi/stock_availables/3"/>
        <stock_available id="4" xlink:href="https://domain.com/webapi/stock_availables/4"/>
        <stock_available id="5" xlink:href="https://domain.com/webapi/stock_availables/5"/>
        <stock_available id="6" xlink:href="https://domain.com/webapi/stock_availables/6"/>
        <stock_available id="7" xlink:href="https://domain.com/webapi/stock_availables/7"/>
        <stock_available id="8" xlink:href="https://domain.com/webapi/stock_availables/8"/>
        <stock_available id="9" xlink:href="https://domain.com/webapi/stock_availables/9"/>
        <stock_available id="334" xlink:href="https://domain.com/webapi/stock_availables/334"/>
        <stock_available id="335" xlink:href="https://domain.com/webapi/stock_availables/335"/>
    </stock_availables>
</groovekart>
														

Customers

Attributes

No Attributes.

Returns

Returns the detail of the Customer.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <customer>
        <id>
            <![CDATA[13]]>
        </id>
        <id_lang xlink:href="https://domain.com/webapi/languages/1">
            <![CDATA[1]]>
        </id_lang>
        <deleted>
            <![CDATA[0]]>
        </deleted>
        <passwd>
            <![CDATA[$2y$10$oViWJUKB7XS764zXO0omDegVwTPQS9Yi4zC8aaI9285laxUPEzFQa]]>
        </passwd>
        <lastname>
            <![CDATA[lastname]]>
        </lastname>
        <firstname>
            <![CDATA[firstname]]>
        </firstname>
        <email>
            <![CDATA[groovekartuser@groovekart.com]]>
        </email>
        <id_gender>
            <![CDATA[0]]>
        </id_gender>
        <birthday>
            <![CDATA[0000-00-00]]>
        </birthday>
        <optin>
            <![CDATA[0]]>
        </optin>
        <active>
            <![CDATA[0]]>
        </active>
        <note></note>
        <is_guest>
            <![CDATA[0]]>
        </is_guest>
        <id_shop>
            <![CDATA[1]]>
        </id_shop>
        <date_add>
            <![CDATA[2021-08-03 02:57:32]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-08-03 02:57:32]]>
        </date_upd>
        <associations>
            <groups nodeType="group" api="groups"/>
        </associations>
    </customer>
</groovekart>
														

Customers

Main Attributes

  • id

    type: numeric

  • id_lang

    type: numeric

    English is having ID 1 on all the stores

  • deleted

    type: numeric

  • passwd

    type: numeric

  • lastname

    type: text

  • firstname

    type: text

  • email

    type: text

  • id_gender

    type: text

  • birthday

    type: date

  • optin

    type: numeric

  • active

    type: numeric

  • note

    type: text

  • is_guest

    type: numeric

  • date_add

    type: numeric

  • date_upd

    type: numeric

  • associations

    type: array

    Show child attributes

    • groups

      type: numeric

      Show child attributes

      • group

        type: numeric

        Show child attributes

        • id

          type: numeric

Returns

Returns of new added Customers.

POST
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
<customer>
        <id></id>
        <id_lang></id_lang>
        <deleted></deleted>
        <passwd></passwd>
        <lastname>lastname</lastname>
        <firstname>firstname</firstname>
        <email>customer@groovekart.com</email>
        <id_gender></id_gender>
        <birthday></birthday>
        <optin></optin>
        <active>1</active>
        <note></note>
        <is_guest></is_guest>
        <id_shop>1</id_shop>
        <date_add></date_add>
        <date_upd></date_upd>
<associations>
<groups>
        <group>
        <id></id>
        </group>
</groups>
</associations>
</customer>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <customer>
        <id>
            <![CDATA[85]]>
        </id>
        <id_lang xlink:href="https://domain.com/webapi/languages/1">
            <![CDATA[1]]>
        </id_lang>
        <deleted></deleted>
        <passwd>
            <![CDATA[$2y$10$S7fYaCD6eiBgGaYrCMX9IOpCRKVFUllZUAHfTNCeu61k1P4OUk8Hi]]>
        </passwd>
        <lastname>
            <![CDATA[lastname]]>
        </lastname>
        <firstname>
            <![CDATA[firstname]]>
        </firstname>
        <email>
            <![CDATA[customer@groovekart.com]]>
        </email>
        <id_gender></id_gender>
        <birthday></birthday>
        <optin></optin>
        <active>
            <![CDATA[1]]>
        </active>
        <note></note>
        <is_guest></is_guest>
        <id_shop>
            <![CDATA[1]]>
        </id_shop>
        <date_add>
            <![CDATA[2021-09-30 16:59:53]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-09-30 16:59:53]]>
        </date_upd>
        <associations>
            <groups nodeType="group" api="groups"/>
        </associations>
    </customer>
</groovekart>
														

Customers

Main Attributes

  • id

    type: numeric

  • id_lang

    type: numeric

    English is having ID 1 on all the stores

  • deleted

    type: numeric

  • passwd

    type: numeric

  • lastname

    type: text

  • firstname

    type: text

  • email

    type: text

  • id_gender

    type: text

  • birthday

    type: date

  • optin

    type: numeric

  • active

    type: numeric

  • note

    type: text

  • is_guest

    type: numeric

  • date_add

    type: numeric

  • date_upd

    type: numeric

  • associations

    type: array

    Show child attributes

    • groups

      type: numeric

      Show child attributes

      • group

        type: numeric

        Show child attributes

        • id

          type: numeric

Returns

Returns the update of Customers.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
<customer>
        <id>85</id>
        <id_lang></id_lang>
        <deleted></deleted>
        <passwd></passwd>
        <lastname>lastname</lastname>
        <firstname>first</firstname>
        <email>customer@gmail.com</email>
        <id_gender></id_gender>
        <birthday></birthday>
        <optin></optin>
        <active>1</active>
        <note></note>
        <is_guest></is_guest>
        <id_shop>1</id_shop>
        <date_add></date_add>
        <date_upd></date_upd>
<associations>
<groups>
        <group>
        <id></id>
        </group>
</groups>
</associations>
</customer>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <customer>
        <id>
            <![CDATA[85]]>
        </id>
        <id_lang></id_lang>
        <deleted></deleted>
        <passwd>
            <![CDATA[$2y$10$8cDxzi44OwpY8HFwYRv2MuIb6ge248o17hN66ZqYtEJ0c4zEAcp96]]>
        </passwd>
        <lastname>
            <![CDATA[lastname]]>
        </lastname>
        <firstname>
            <![CDATA[first]]>
        </firstname>
        <email>
            <![CDATA[customer@gmail.com]]>
        </email>
        <id_gender></id_gender>
        <birthday></birthday>
        <optin></optin>
        <active>
            <![CDATA[1]]>
        </active>
        <note></note>
        <is_guest></is_guest>
        <id_shop>
            <![CDATA[1]]>
        </id_shop>
        <date_add>
            <![CDATA[2021-09-30 17:11:09]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-09-30 17:11:09]]>
        </date_upd>
        <associations>
            <groups nodeType="group" api="groups"/>
        </associations>
    </customer>
</groovekart>
														

Customers

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

DELETE

No Attributes

Response

Successfully deleted

Shipping and Adresses

We can perform following operations.

Endpoints

GET http://domain.com/webapi/

POST http://domain.com/webapi/

PUT http://domain.com/webapi/

Countries

For now from API or from Store Dashboard you can only disable or enable Countries. THere is No way to completely delete or change ID of a Country. on every store the ID of a Country is the same

The only available action for Country is assign t oa Zone

Attributes

No Attributes.

Returns

Returns the List of Countries.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <countries>
        <country id="1" xlink:href="https://domain.com/webapi/countries/1"/>
        <country id="2" xlink:href="https://domain.com/webapi/countries/2"/>
        <country id="3" xlink:href="https://domain.com/webapi/countries/3"/>
        <country id="6" xlink:href="https://domain.com/webapi/countries/6"/>
        <country id="7" xlink:href="https://domain.com/webapi/countries/7"/>
        <country id="8" xlink:href="https://domain.com/webapi/countries/8"/>
        <country id="9" xlink:href="https://domain.com/webapi/countries/9"/>
        <country id="10" xlink:href="https://domain.com/webapi/countries/10"/>
    </countries>
</groovekart>
														

Countries

For now from API or from Store Dashboard you can only disable or enable Countries. THere is No way to completely delete or change ID of a Country. on every store the ID of a Country is the same

The only available action for Country is assign t oa Zone

Main Attributes

  • id

    type: numeric

  • id_zone

    type: numeric

  • active

    type: numeric

Returns

Returns the detail of the Country.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <country>
        <id>
            <![CDATA[21]]>
        </id>
        <id_zone xlink:href="https://domain.com/webapi/zones/2">
            <![CDATA[2]]>
        </id_zone>
        <active>
            <![CDATA[1]]>
        </active>
        <name>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[United States]]>
            </language>
        </name>
    </country>
</groovekart>
														

Countries

For now from API or from Store Dashboard you can only disable or enable Countries. THere is No way to completely delete or change ID of a Country. on every store the ID of a Country is the same

The only available action for Country is assign t oa Zone

Main Attributes

  • id

    type: numeric

  • id_zone

    type: numeric

  • active

    type: numeric

Returns

Returns the detail of the Country.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <country>
        <id>21</id>
        <id_zone>2</id_zone>
        <active>0</active>
        <name>
            <language id="1">United States</language>
        </name>
    </country>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <country>
        <id>
            <![CDATA[21]]>
        </id>
        <id_zone xlink:href="https://domain.com/webapi/zones/2">
            <![CDATA[2]]>
        </id_zone>
        <active>
            <![CDATA[0]]>
        </active>
        <name>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[United States]]>
            </language>
        </name>
    </country>
</groovekart>
														

States

Attributes

No Attributes.

Returns

Returns the List of States.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <states>
        <state id="1612" xlink:href="https://domain.com/webapi/states/1612"/>
        <state id="1613" xlink:href="https://domain.com/webapi/states/1613"/>
        <state id="1614" xlink:href="https://domain.com/webapi/states/1614"/>
        <state id="1615" xlink:href="https://domain.com/webapi/states/1615"/>
        <state id="1616" xlink:href="https://domain.com/webapi/states/1616"/>
        <state id="1617" xlink:href="https://domain.com/webapi/states/1617"/>
        <state id="1618" xlink:href="https://domain.com/webapi/states/1618"/>
        <state id="1619" xlink:href="https://domain.com/webapi/states/1619"/>
        <state id="1620" xlink:href="https://domain.com/webapi/states/1620"/>
        <state id="1621" xlink:href="https://domain.com/webapi/states/1621"/>
        <state id="1622" xlink:href="https://domain.com/webapi/states/1622"/>
        <state id="1623" xlink:href="https://domain.com/webapi/states/1623"/>
        <state id="1624" xlink:href="https://domain.com/webapi/states/1624"/>
        <state id="1625" xlink:href="https://domain.com/webapi/states/1625"/>
        <state id="1626" xlink:href="https://domain.com/webapi/states/1626"/>
    </states>
</groovekart>
														

States

Attributes

No Attributes.

Returns

Returns the detail of the State.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <state>
        <id>
            <![CDATA[1]]>
        </id>
        <id_zone xlink:href="https://domain.com/webapi/zones/2">
            <![CDATA[2]]>
        </id_zone>
        <id_country xlink:href="https://domain.com/webapi/countries/21">
            <![CDATA[21]]>
        </id_country>
        <iso_code>
            <![CDATA[AL]]>
        </iso_code>
        <name>
            <![CDATA[Alabama]]>
        </name>
        <active>
            <![CDATA[1]]>
        </active>
    </state>
</groovekart>
														

States

Main Attributes

  • id

    type: numeric

  • id_zone

    type: numeric

  • id_country

    type: numeric

  • iso_code

    type: numeric

  • name

    type: text

  • active

    type: numeric

Returns

Returns of new added States.

POST
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <state>
        <id></id>
        <id_zone>2</id_zone>
        <id_country>21</id_country>
        <iso_code>NS</iso_code>
        <name>New State</name>
        <active>1</active>
    </state>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <state>
        <id>
            <![CDATA[3974]]>
        </id>
        <id_zone xlink:href="https://domain.com/webapi/zones/2">
            <![CDATA[2]]>
        </id_zone>
        <id_country xlink:href="https://domain.com/webapi/countries/21">
            <![CDATA[21]]>
        </id_country>
        <iso_code>
            <![CDATA[NS]]>
        </iso_code>
        <name>
            <![CDATA[New State]]>
        </name>
        <active>
            <![CDATA[1]]>
        </active>
    </state>
</groovekart>
														

States

Main Attributes

  • id

    type: numeric

  • id_zone

    type: numeric

  • id_country

    type: numeric

  • iso_code

    type: numeric

  • name

    type: text

  • active

    type: numeric

Returns

Returns the update of States.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <state>
        <id>3974</id>
        <id_zone>2</id_zone>
        <id_country>21</id_country>
        <iso_code>NS</iso_code>
        <name>New State</name>
        <active>0</active>
    </state>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <state>
        <id>
            <![CDATA[3974]]>
        </id>
        <id_zone xlink:href="https://domain.com/webapi/zones/2">
            <![CDATA[2]]>
        </id_zone>
        <id_country xlink:href="https://domain.com/webapi/countries/21">
            <![CDATA[21]]>
        </id_country>
        <iso_code>
            <![CDATA[NS]]>
        </iso_code>
        <name>
            <![CDATA[New State]]>
        </name>
        <active>
            <![CDATA[0]]>
        </active>
    </state>
</groovekart>
														

States

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

DELETE

No Attributes

Response

Successfully deleted

Zones

Attributes

No Attributes.

Returns

Returns the List of Zones.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <zones>
        <zone id="1" xlink:href="https://domain.com/webapi/zones/1"/>
        <zone id="2" xlink:href="https://domain.com/webapi/zones/2"/>
        <zone id="3" xlink:href="https://domain.com/webapi/zones/3"/>
        <zone id="4" xlink:href="https://domain.com/webapi/zones/4"/>
        <zone id="5" xlink:href="https://domain.com/webapi/zones/5"/>
        <zone id="6" xlink:href="https://domain.com/webapi/zones/6"/>
        <zone id="7" xlink:href="https://domain.com/webapi/zones/7"/>
        <zone id="8" xlink:href="https://domain.com/webapi/zones/8"/>
    </zones>
</groovekart>
														

Zones

Attributes

No Attributes.

Returns

Returns the detail Zone.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <zone>
        <id>
            <![CDATA[2]]>
        </id>
        <name>
            <![CDATA[North America]]>
        </name>
        <active>
            <![CDATA[1]]>
        </active>
    </zone>
</groovekart>
														

Zones

Main Attributes

  • id

    type: numeric

  • name

    type: text

  • active

    type: numeric

Returns

Returns of new added Zone.

POST
Response
														

Zones

Main Attributes

  • id

    type: numeric

  • name

    type: text

  • active

    type: numeric

Returns

Returns the update of Zones.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <zone>
        <id>2</id>
        <name>North America</name>
        <active>0</active>
    </zone>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <zone>
        <id>
            <![CDATA[2]]>
        </id>
        <name>
            <![CDATA[North America]]>
        </name>
        <active>
            <![CDATA[0]]>
        </active>
    </zone>
</groovekart>
														

Zones

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

GET
Response
														

Address

Attributes

No Attributes.

Returns

Returns the List of all Address.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <addresses>
        <address id="1" xlink:href="https://domain.com/webapi/addresses/1"/>
        <address id="2" xlink:href="https://domain.com/webapi/addresses/2"/>
        <address id="3" xlink:href="https://domain.com/webapi/addresses/3"/>
        <address id="4" xlink:href="https://domain.com/webapi/addresses/4"/>
        <address id="5" xlink:href="https://domain.com/webapi/addresses/5"/>
        <address id="6" xlink:href="https://domain.com/webapi/addresses/6"/>
        <address id="7" xlink:href="https://domain.com/webapi/addresses/7"/>
        <address id="8" xlink:href="https://domain.com/webapi/addresses/8"/>
        <address id="9" xlink:href="https://domain.com/webapi/addresses/9"/>
        <address id="10" xlink:href="https://domain.com/webapi/addresses/10"/>
    </addresses>
</groovekart>
														

Address

Attributes

No Attributes.

Returns

Returns the detail of the Address.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <address>
        <id>
            <![CDATA[6]]>
        </id>
        <id_customer xlink:href="https://domain.com/webapi/customers/9">
            <![CDATA[9]]>
        </id_customer>
        <id_country xlink:href="https://domain.com/webapi/countries/21">
            <![CDATA[21]]>
        </id_country>
        <id_state xlink:href="https://domain.com/webapi/states/2">
            <![CDATA[2]]>
        </id_state>
        <alias>
            <![CDATA[Home]]>
        </alias>
        <lastname>
            <![CDATA[lastname]]>
        </lastname>
        <firstname>
            <![CDATA[firstname]]>
        </firstname>
        <address1>
            <![CDATA[India 1]]>
        </address1>
        <postcode>
            <![CDATA[99501]]>
        </postcode>
        <city>
            <![CDATA[Rohtak]]>
        </city>
        <phone>
            <![CDATA[9999923230]]>
        </phone>
        <deleted>
            <![CDATA[0]]>
        </deleted>
        <date_add>
            <![CDATA[2021-07-26 10:52:01]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-08-10 05:07:02]]>
        </date_upd>
    </address>
</groovekart>
														

Address

Main Attributes

  • id

    type: numeric

  • id_customer

    type: numeric

  • id_country

    type: numeric

  • id_state

    type: numeric

  • alias

    type: text

  • lastname

    type: text

  • firstname

    type: text

  • address1

    type: text

  • postcode

    type: numeric

  • phone_mobile

    type: numeric

  • deleted

    type: numeric

  • date_add

    type: date

  • date_upd

    type: date

Returns

Returns of new added Address.

POST
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <address>
        <id></id>
        <id_customer>12</id_customer>
        <id_country>21</id_country>
        <id_state>2</id_state>
        <alias>office</alias>
        <lastname>lastname</lastname>
        <firstname>firstname</firstname>
        <address1>STREET & FLAT</address1>
        <postcode>99501</postcode>
        <city>ALASKA</city>
        <phone>1234567890</phone>
        <deleted></deleted>
        <date_add></date_add>
        <date_upd></date_upd>
    </address>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <address>
        <id>
            <![CDATA[6]]>
        </id>
        <id_customer xlink:href="https://domain.com/webapi/customers/9">
            <![CDATA[9]]>
        </id_customer>
        <id_country xlink:href="https://domain.com/webapi/countries/21">
            <![CDATA[21]]>
        </id_country>
        <id_state xlink:href="https://domain.com/webapi/states/2">
            <![CDATA[2]]>
        </id_state>
        <alias>
            <![CDATA[Home]]>
        </alias>
        <lastname>
            <![CDATA[lastname]]>
        </lastname>
        <firstname>
            <![CDATA[firstname]]>
        </firstname>
        <address1>
            <![CDATA[India 1]]>
        </address1>
        <postcode>
            <![CDATA[99501]]>
        </postcode>
        <city>
            <![CDATA[Rohtak]]>
        </city>
        <phone>
            <![CDATA[9999923230]]>
        </phone>
        <deleted>
            <![CDATA[0]]>
        </deleted>
        <date_add>
            <![CDATA[2021-07-26 10:52:01]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-08-10 05:07:02]]>
        </date_upd>
    </address>
</groovekart>
														

Address

Main Attributes

  • id

    type: numeric

  • id_customer

    type: numeric

  • id_country

    type: numeric

  • id_state

    type: numeric

  • alias

    type: text

  • lastname

    type: text

  • firstname

    type: text

  • address1

    type: text

  • postcode

    type: numeric

  • phone_mobile

    type: numeric

  • deleted

    type: numeric

  • date_add

    type: date

  • date_upd

    type: date

Returns

Returns the update of Address.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <address>
        <id>58</id>
        <id_customer>12</id_customer>
        <id_country>21</id_country>
        <id_state>2</id_state>
        <alias>office</alias>
        <lastname>lastname</lastname>
        <firstname>firstname</firstname>
        <address1>STREET & FLAT</address1>
        <postcode>99501</postcode>
        <city>ALASKA</city>
        <phone>1234567890</phone>
        <deleted></deleted>
        <date_add></date_add>
        <date_upd></date_upd>
    </address>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <address>
        <id>
            <![CDATA[58]]>
        </id>
        <id_customer xlink:href="https://domain.com/webapi/customers/12">
            <![CDATA[12]]>
        </id_customer>
        <id_country xlink:href="https://domain.com/webapi/countries/21">
            <![CDATA[21]]>
        </id_country>
        <id_state xlink:href="https://domain.com/webapi/states/2">
            <![CDATA[2]]>
        </id_state>
        <alias>
            <![CDATA[ask]]>
        </alias>
        <company></company>
        <lastname>
            <![CDATA[lastname]]>
        </lastname>
        <firstname>
            <![CDATA[firstname]]>
        </firstname>
        <vat_number></vat_number>
        <address1>
            <![CDATA[India]]>
        </address1>
        <address2></address2>
        <postcode>
            <![CDATA[99501]]>
        </postcode>
        <city>
            <![CDATA[Rohtak]]>
        </city>
        <other></other>
        <phone>
            <![CDATA[1234567890]]>
        </phone>
        <phone_mobile></phone_mobile>
        <dni></dni>
        <deleted></deleted>
        <date_add>
            <![CDATA[2021-09-30 18:18:59]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-09-30 18:18:59]]>
        </date_upd>
    </address>
</groovekart>
														

Address

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

GET

No Attributes

Response

Successfully deleted

Shipping Options

For now for it's complexity. Shipping options are availabe only for read.

Attributes

No Attributes.

Returns

Returns the List of all Shipping Options.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <carriers>
        <carrier id="1" xlink:href="https://domain.com/webapi/carriers/1"/>
        <carrier id="9" xlink:href="https://domain.com/webapi/carriers/9"/>
        <carrier id="11" xlink:href="https://domain.com/webapi/carriers/11"/>
        <carrier id="12" xlink:href="https://domain.com/webapi/carriers/12"/>
        <carrier id="2" xlink:href="https://domain.com/webapi/carriers/2"/>
        <carrier id="3" xlink:href="https://domain.com/webapi/carriers/3"/>
        <carrier id="4" xlink:href="https://domain.com/webapi/carriers/4"/>
        <carrier id="5" xlink:href="https://domain.com/webapi/carriers/5"/>
        <carrier id="6" xlink:href="https://domain.com/webapi/carriers/6"/>
        <carrier id="7" xlink:href="https://domain.com/webapi/carriers/7"/>
        <carrier id="8" xlink:href="https://domain.com/webapi/carriers/8"/>
        <carrier id="10" xlink:href="https://domain.com/webapi/carriers/10"/>
    </carriers>
</groovekart>
														

Shipping Options

For now for it's complexity. Shippin options are availabe only for read

Attributes

No Attributes.

Returns

Returns the detail of the Shipping Option.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <carrier>
        <id>
            <![CDATA[11]]>
        </id>
        <deleted>
            <![CDATA[0]]>
        </deleted>
        <is_module>
            <![CDATA[0]]>
        </is_module>
        <id_tax_rules_group notFilterable="true">
            <![CDATA[0]]>
        </id_tax_rules_group>
        <id_reference>
            <![CDATA[11]]>
        </id_reference>
        <name>
            <![CDATA[Title]]>
        </name>
        <active>
            <![CDATA[1]]>
        </active>
        <is_free>
            <![CDATA[0]]>
        </is_free>
        <url></url>
        <shipping_handling>
            <![CDATA[0]]>
        </shipping_handling>
        <shipping_external>
            <![CDATA[0]]>
        </shipping_external>
        <range_behavior>
            <![CDATA[0]]>
        </range_behavior>
        <shipping_method>
            <![CDATA[2]]>
        </shipping_method>
        <max_width>
            <![CDATA[0]]>
        </max_width>
        <max_height>
            <![CDATA[0]]>
        </max_height>
        <max_depth>
            <![CDATA[0]]>
        </max_depth>
        <max_weight>
            <![CDATA[0.000000]]>
        </max_weight>
        <grade>
            <![CDATA[0]]>
        </grade>
        <external_module_name></external_module_name>
        <need_range>
            <![CDATA[0]]>
        </need_range>
        <position>
            <![CDATA[3]]>
        </position>
        <delay>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Description]]>
            </language>
        </delay>
    </carrier>
</groovekart>
														

Shipping Options

For now for it's complexity. Shippin options are availabe only for read

Main Attributes

  • id

    type: numeric

  • deleted

    type: numeric

  • is_module

    type: text

  • id_tax_rules_group

    type: numeric

  • id_reference

    type: text

  • name

    type: text

  • active

    type: numeric

  • is_free

    type: numeric

  • url

    type: text

  • shipping_handling

    type: text

  • shipping_external

    type: text

  • range_behavior

    type: text

  • shipping_method

    type: text

  • max_width

    type: numeric

  • max_height

    type: numeric

  • max_depth

    type: numeric

  • max_weight

    type: numeric

  • grade

    type: text

  • external_module_name

    type: text

  • need_range

    type: text

  • position

    type: numeric

  • delay

    type: numeric

    Show child attributes

    • language id

      type: numeric

Returns

Returns of new added Shipping Options.

POST
Response
														

Shipping Options

For now for it's complexity. Shippin options are availabe only for read

Main Attributes

  • id

    type: numeric

  • deleted

    type: numeric

  • is_module

    type: text

  • id_tax_rules_group

    type: numeric

  • id_reference

    type: text

  • name

    type: text

  • active

    type: numeric

  • is_free

    type: numeric

  • url

    type: text

  • shipping_handling

    type: text

  • shipping_external

    type: text

  • range_behavior

    type: text

  • shipping_method

    type: text

  • max_width

    type: numeric

  • max_height

    type: numeric

  • max_depth

    type: numeric

  • max_weight

    type: numeric

  • grade

    type: text

  • external_module_name

    type: text

  • need_range

    type: text

  • position

    type: numeric

  • delay

    type: numeric

    Show child attributes

    • language id

      type: numeric

Returns

Returns the update of Shipping Options.

PUT
Response
														

Shipping Options

For now for it's complexity. Shippin options are availabe only for read

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

DELETE
Response
														

Shopping Cart & Order

We can perform following operations.

Endpoints

GET http://domain.com/webapi/

POST http://domain.com/webapi/

PUT http://domain.com/webapi/

Customer Cart

Attributes

No Attributes.

Returns

Returns the List of Customer Cart.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <carts>
        <cart id="1" xlink:href="https://domain.com/webapi/carts/1"/>
        <cart id="2" xlink:href="https://domain.com/webapi/carts/2"/>
        <cart id="5" xlink:href="https://domain.com/webapi/carts/5"/>
        <cart id="6" xlink:href="https://domain.com/webapi/carts/6"/>
        <cart id="7" xlink:href="https://domain.com/webapi/carts/7"/>
        <cart id="8" xlink:href="https://domain.com/webapi/carts/8"/>
        <cart id="9" xlink:href="https://domain.com/webapi/carts/9"/>
    </carts>
</groovekart>
														

Customer Cart

Attributes

No Attributes.

Returns

Returns the detail of the Customer Cart.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <cart>
        <id>
            <![CDATA[48]]>
        </id>
        <id_address_delivery xlink:href="https://domain.com/webapi/addresses/3">
            <![CDATA[3]]>
        </id_address_delivery>
        <id_address_invoice xlink:href="https://domain.com/webapi/addresses/3">
            <![CDATA[3]]>
        </id_address_invoice>
        <id_currency xlink:href="https://domain.com/webapi/currencies/1">
            <![CDATA[1]]>
        </id_currency>
        <id_customer xlink:href="https://domain.com/webapi/customers/4">
            <![CDATA[4]]>
        </id_customer>
        <id_guest>
            <![CDATA[0]]>
        </id_guest>
        <id_lang xlink:href="https://domain.com/webapi/languages/1">
            <![CDATA[1]]>
        </id_lang>
        <id_carrier>
            <![CDATA[0]]>
        </id_carrier>
        <gift>
            <![CDATA[0]]>
        </gift>
        <gift_message></gift_message>
        <date_add>
            <![CDATA[2021-07-05 06:02:08]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-08-10 09:41:37]]>
        </date_upd>
        <associations>
            <cart_rows nodeType="cart_row" virtualEntity="true"/>
        </associations>
    </cart>
</groovekart>
														

Customer Cart

Main Attributes

  • id

    type: numeric

  • id_address_delivery

    type: numeric

  • id_address_invoice

    type: numeric

  • id_currency

    type: numeric

  • id_customer

    type: numeric

  • id_guest

    type: numeric

  • id_lang

    type: numeric

  • id_carrier

    type: numeric

  • gift

    type: numeric

  • gift_message

    type: text

  • date_add

    type: date

  • date_upd

    type: date

  • associations

    type: array

    Show child attributes

    • cart_rows

      type: numeric

      Show child attributes

      • cart_row

        type: numeric

        Show child attributes

        • id_product

          type: numeric

        • id_product_attribute

          type: numeric

        • id_address_delivery

          type: numeric

        • quantity

          type: numeric

Returns

Returns of new added Customer Cart.

POST
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <cart>
        <id></id>
        <id_address_delivery>10</id_address_delivery>
        <id_address_invoice>10</id_address_invoice>
        <id_currency>1</id_currency>
        <id_customer>12</id_customer>
        <id_guest></id_guest>
        <id_lang>1</id_lang>
        <id_carrier></id_carrier>
        <gift></gift>
        <gift_message></gift_message>
        <date_add></date_add>
        <date_upd></date_upd>
        <associations>
            <cart_rows>
                <cart_row>
                    <id_product>63</id_product>
                    <id_product_attribute>332</id_product_attribute>
                    <id_address_delivery>10</id_address_delivery>
                    <quantity>4</quantity>
                </cart_row>
                <cart_row>
                    <id_product>62</id_product>
                    <id_product_attribute>0</id_product_attribute>
                    <id_address_delivery>10</id_address_delivery>
                    <quantity>2</quantity>
                </cart_row>
            </cart_rows>
        </associations>
    </cart>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <cart>
        <id>
            <![CDATA[117]]>
        </id>
        <id_address_delivery xlink:href="https://domain.com/webapi/addresses/10">
            <![CDATA[10]]>
        </id_address_delivery>
        <id_address_invoice xlink:href="https://domain.com/webapi/addresses/10">
            <![CDATA[10]]>
        </id_address_invoice>
        <id_currency xlink:href="https://domain.com/webapi/currencies/1">
            <![CDATA[1]]>
        </id_currency>
        <id_customer xlink:href="https://domain.com/webapi/customers/12">
            <![CDATA[12]]>
        </id_customer>
        <id_guest></id_guest>
        <id_lang xlink:href="https://domain.com/webapi/languages/1">
            <![CDATA[1]]>
        </id_lang>
        <id_carrier></id_carrier>
        <gift></gift>
        <gift_message></gift_message>
        <date_add>
            <![CDATA[2021-10-01 03:15:43]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-10-01 03:15:43]]>
        </date_upd>
        <associations>
            <cart_rows nodeType="cart_row" virtualEntity="true">
                <cart_row>
                    <id_product xlink:href="https://domain.com/webapi/products/62">
                        <![CDATA[62]]>
                    </id_product>
                    <id_product_attribute xlink:href="https://domain.com/webapi/combinations/0">
                        <![CDATA[0]]>
                    </id_product_attribute>
                    <id_address_delivery xlink:href="https://domain.com/webapi/addresses/10">
                        <![CDATA[10]]>
                    </id_address_delivery>
                    <quantity>
                        <![CDATA[2]]>
                    </quantity>
                </cart_row>
                <cart_row>
                    <id_product xlink:href="https://domain.com/webapi/products/63">
                        <![CDATA[63]]>
                    </id_product>
                    <id_product_attribute xlink:href="https://domain.com/webapi/combinations/332">
                        <![CDATA[332]]>
                    </id_product_attribute>
                    <id_address_delivery xlink:href="https://domain.com/webapi/addresses/10">
                        <![CDATA[10]]>
                    </id_address_delivery>
                    <quantity>
                        <![CDATA[4]]>
                    </quantity>
                </cart_row>
            </cart_rows>
        </associations>
    </cart>
</groovekart>
														

Customer Cart

Main Attributes

  • id

    type: numeric

  • id_address_delivery

    type: numeric

  • id_address_invoice

    type: numeric

  • id_currency

    type: numeric

  • id_customer

    type: numeric

  • id_guest

    type: numeric

  • id_lang

    type: numeric

  • id_carrier

    type: numeric

  • gift

    type: numeric

  • gift_message

    type: text

  • date_add

    type: date

  • date_upd

    type: date

  • associations

    type: array

    Show child attributes

    • cart_rows

      type: numeric

      Show child attributes

      • cart_row

        type: numeric

        Show child attributes

        • id_product

          type: numeric

        • id_product_attribute

          type: numeric

        • id_address_delivery

          type: numeric

        • quantity

          type: numeric

Returns

Returns the update of Customer Cart.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <cart>
        <id>117</id>
        <id_address_delivery>10</id_address_delivery>
        <id_address_invoice>10</id_address_invoice>
        <id_currency>1</id_currency>
        <id_customer>12</id_customer>
        <id_guest></id_guest>
        <id_lang>1</id_lang>
        <id_carrier></id_carrier>
        <gift></gift>
        <gift_message></gift_message>
        <date_add></date_add>
        <date_upd></date_upd>
        <associations>
            <cart_rows>
                <cart_row>
                    <id_product>63</id_product>
                    <id_product_attribute>332</id_product_attribute>
                    <id_address_delivery>10</id_address_delivery>
                    <quantity>4</quantity>
                </cart_row>
                <cart_row>
                    <id_product>62</id_product>
                    <id_product_attribute>0</id_product_attribute>
                    <id_address_delivery>10</id_address_delivery>
                    <quantity>3</quantity>
                </cart_row>
            </cart_rows>
        </associations>
    </cart>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <cart>
        <id>
            <![CDATA[117]]>
        </id>
        <id_address_delivery xlink:href="https://domain.com/webapi/addresses/10">
            <![CDATA[10]]>
        </id_address_delivery>
        <id_address_invoice xlink:href="https://domain.com/webapi/addresses/10">
            <![CDATA[10]]>
        </id_address_invoice>
        <id_currency xlink:href="https://domain.com/webapi/currencies/1">
            <![CDATA[1]]>
        </id_currency>
        <id_customer xlink:href="https://domain.com/webapi/customers/12">
            <![CDATA[12]]>
        </id_customer>
        <id_guest></id_guest>
        <id_lang xlink:href="https://domain.com/webapi/languages/1">
            <![CDATA[1]]>
        </id_lang>
        <id_carrier></id_carrier>
        <gift></gift>
        <gift_message></gift_message>
        <delivery_option></delivery_option>
        <secure_key></secure_key>
        <allow_seperated_package></allow_seperated_package>
        <date_add>
            <![CDATA[2021-10-01 03:50:26]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-10-01 03:50:26]]>
        </date_upd>
        <associations>
            <cart_rows nodeType="cart_row" virtualEntity="true">
                <cart_row>
                    <id_product xlink:href="https://domain.com/webapi/products/62">
                        <![CDATA[62]]>
                    </id_product>
                    <id_product_attribute xlink:href="https://domain.com/webapi/combinations/0">
                        <![CDATA[0]]>
                    </id_product_attribute>
                    <id_address_delivery xlink:href="https://domain.com/webapi/addresses/10">
                        <![CDATA[10]]>
                    </id_address_delivery>
                    <quantity>
                        <![CDATA[3]]>
                    </quantity>
                </cart_row>
                <cart_row>
                    <id_product xlink:href="https://domain.com/webapi/products/63">
                        <![CDATA[63]]>
                    </id_product>
                    <id_product_attribute xlink:href="https://domain.com/webapi/combinations/332">
                        <![CDATA[332]]>
                    </id_product_attribute>
                    <id_address_delivery xlink:href="https://domain.com/webapi/addresses/10">
                        <![CDATA[10]]>
                    </id_address_delivery>
                    <quantity>
                        <![CDATA[4]]>
                    </quantity>
                </cart_row>
            </cart_rows>
        </associations>
    </cart>
</groovekart>
														

Customer Cart

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

GET

No Attributes

Response

Successfully deleted

Currency list

Attributes

No Attributes.

Returns

Returns the List of all Currencies.

GET
Response
														

Currency list

Attributes

No Attributes.

Returns

Returns the detail of the Currency.

GET
Response
														

Currency list

Attributes

No Attributes.

Returns

Returns of new added Currencies.

GET
Response
														

Currency list

Attributes

No Attributes.

Returns

Returns the update of Currency list.

GET
Response
														

Currency list

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

GET
Response
														

Discounts

Discounts can be read only

Attributes

No Attributes.

Returns

Returns the List of Discounts.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <cart_rules>
        <cart_rule id="1" xlink:href="https://domain.com/webapi/cart_rules/1"/>
        <cart_rule id="2" xlink:href="https://domain.com/webapi/cart_rules/2"/>
    </cart_rules>
</groovekart>
														

Discounts

Discounts can be read only

Attributes

No Attributes.

Returns

Returns the detail of the Discount.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <cart_rule>
        <id>
            <![CDATA[1]]>
        </id>
        <id_customer>
            <![CDATA[3]]>
        </id_customer>
        <date_from>
            <![CDATA[2021-07-23 04:06:38]]>
        </date_from>
        <date_to>
            <![CDATA[2021-08-02 04:06:38]]>
        </date_to>
        <description></description>
        <quantity>
            <![CDATA[1]]>
        </quantity>
        <quantity_per_user>
            <![CDATA[1]]>
        </quantity_per_user>
        <priority>
            <![CDATA[1]]>
        </priority>
        <partial_use>
            <![CDATA[1]]>
        </partial_use>
        <code>
            <![CDATA[BO_ORDER_42]]>
        </code>
        <minimum_amount>
            <![CDATA[0.00]]>
        </minimum_amount>
        <minimum_amount_tax>
            <![CDATA[0]]>
        </minimum_amount_tax>
        <minimum_amount_currency>
            <![CDATA[1]]>
        </minimum_amount_currency>
        <minimum_amount_shipping>
            <![CDATA[0]]>
        </minimum_amount_shipping>
        <country_restriction>
            <![CDATA[0]]>
        </country_restriction>
        <carrier_restriction>
            <![CDATA[0]]>
        </carrier_restriction>
        <group_restriction>
            <![CDATA[0]]>
        </group_restriction>
        <cart_rule_restriction>
            <![CDATA[0]]>
        </cart_rule_restriction>
        <product_restriction>
            <![CDATA[0]]>
        </product_restriction>
        <shop_restriction>
            <![CDATA[0]]>
        </shop_restriction>
        <free_shipping>
            <![CDATA[1]]>
        </free_shipping>
        <reduction_percent>
            <![CDATA[0.00]]>
        </reduction_percent>
        <reduction_amount>
            <![CDATA[0.00]]>
        </reduction_amount>
        <reduction_tax>
            <![CDATA[0]]>
        </reduction_tax>
        <reduction_currency>
            <![CDATA[1]]>
        </reduction_currency>
        <reduction_product>
            <![CDATA[0]]>
        </reduction_product>
        <gift_product>
            <![CDATA[0]]>
        </gift_product>
        <gift_product_attribute>
            <![CDATA[0]]>
        </gift_product_attribute>
        <highlight>
            <![CDATA[0]]>
        </highlight>
        <active>
            <![CDATA[1]]>
        </active>
        <date_add>
            <![CDATA[2021-07-23 04:06:38]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-07-23 04:06:38]]>
        </date_upd>
        <name>
            <language id="1" xlink:href="https://domain.com/webapi/languages/1">
                <![CDATA[Free Shipping]]>
            </language>
        </name>
    </cart_rule>
</groovekart>
														

Discounts

Discounts can be read only

Main Attributes

  • id

    type: numeric

  • id_customer

    type: numeric

  • date_from

    type: date

  • date_to

    type: date

  • description

    type: text

  • quantity

    type: numeric

  • quantity_per_user

    type: numeric

  • priority

    type: text

  • partial_use

    type: text

  • minimum_amount

    type: numeric

  • minimum_amount_tax

    type: numeric

  • minimum_amount_currency

    type: numeric

  • minimum_amount_shipping

    type: numeric

  • country_restriction

    type: text

  • carrier_restriction

    type: text

  • group_restriction

    type: text

  • cart_rule_restriction

    type: text

  • product_restriction

    type: text

  • shop_restriction

    type: text

  • free_shipping

    type: text

  • reduction_percent

    type: numeric

  • reduction_amount

    type: numeric

  • reduction_tax

    type: numeric

  • reduction_currency

    type: numeric

  • reduction_product

    type: text

  • gift_product

    type: text

  • gift_product_attribute

    type: text

  • highlight

    type: text

  • active

    type: numeric

  • date_add

    type: date

  • date_upd

    type: date

  • name

    type: text

    Show child attributes

    • language id

      type: numeric

Returns

Returns of new added Discounts.

GET
Response
														

Discounts

Discounts can be read only

Main Attributes

  • id

    type: numeric

  • id_customer

    type: numeric

  • date_from

    type: date

  • date_to

    type: date

  • description

    type: text

  • quantity

    type: numeric

  • quantity_per_user

    type: numeric

  • priority

    type: text

  • partial_use

    type: text

  • minimum_amount

    type: numeric

  • minimum_amount_tax

    type: numeric

  • minimum_amount_currency

    type: numeric

  • minimum_amount_shipping

    type: numeric

  • country_restriction

    type: text

  • carrier_restriction

    type: text

  • group_restriction

    type: text

  • cart_rule_restriction

    type: text

  • product_restriction

    type: text

  • shop_restriction

    type: text

  • free_shipping

    type: text

  • reduction_percent

    type: numeric

  • reduction_amount

    type: numeric

  • reduction_tax

    type: numeric

  • reduction_currency

    type: numeric

  • reduction_product

    type: text

  • gift_product

    type: text

  • gift_product_attribute

    type: text

  • highlight

    type: text

  • active

    type: numeric

  • date_add

    type: date

  • date_upd

    type: date

  • name

    type: text

    Show child attributes

    • language id

      type: numeric

Returns

Returns the update of Discounts.

GET
Response
														

Discounts

Discounts can be read only

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

GET
Response
														

Orders

Attributes

No paramAttributeseters.

Returns

Returns the List of all Orders.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <orders>
        <order id="1" xlink:href="https://domain.com/webapi/orders/1"/>
        <order id="2" xlink:href="https://domain.com/webapi/orders/2"/>
        <order id="3" xlink:href="https://domain.com/webapi/orders/3"/>
        <order id="4" xlink:href="https://domain.com/webapi/orders/4"/>
        <order id="5" xlink:href="https://domain.com/webapi/orders/5"/>
        <order id="6" xlink:href="https://domain.com/webapi/orders/6"/>
        <order id="7" xlink:href="https://domain.com/webapi/orders/7"/>
        <order id="8" xlink:href="https://domain.com/webapi/orders/8"/>
        <order id="9" xlink:href="https://domain.com/webapi/orders/9"/>
    </orders>
</groovekart>
														

Orders

Attributes

No Attributes.

Returns

Returns the detail of the Order.

GET

No Attributes

Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <order>
        <id>
            <![CDATA[20]]>
        </id>
        <id_address_delivery xlink:href="https://domain.com/webapi/addresses/3">
            <![CDATA[3]]>
        </id_address_delivery>
        <id_address_invoice xlink:href="https://domain.com/webapi/addresses/3">
            <![CDATA[3]]>
        </id_address_invoice>
        <id_cart xlink:href="https://domain.com/webapi/carts/47">
            <![CDATA[47]]>
        </id_cart>
        <id_currency xlink:href="https://domain.com/webapi/currencies/1">
            <![CDATA[1]]>
        </id_currency>
        <id_lang xlink:href="https://domain.com/webapi/languages/1">
            <![CDATA[1]]>
        </id_lang>
        <id_customer xlink:href="https://domain.com/webapi/customers/4">
            <![CDATA[4]]>
        </id_customer>
        <id_carrier xlink:href="https://domain.com/webapi/carriers/1">
            <![CDATA[1]]>
        </id_carrier>
        <current_state xlink:href="https://domain.com/webapi/order_states/4">
            <![CDATA[4]]>
        </current_state>
        <invoice_number>
            <![CDATA[20]]>
        </invoice_number>
        <invoice_date>
            <![CDATA[2021-07-14 05:48:04]]>
        </invoice_date>
        <delivery_number>
            <![CDATA[3]]>
        </delivery_number>
        <delivery_date>
            <![CDATA[2021-09-27 08:51:00]]>
        </delivery_date>
        <date_add>
            <![CDATA[2021-07-14 05:48:04]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-09-28 16:14:36]]>
        </date_upd>
        <shipping_number notFilterable="true">
            <![CDATA[TESTRNUM25215]]>
        </shipping_number>
        <id_shop_group>
            <![CDATA[1]]>
        </id_shop_group>
        <id_shop>
            <![CDATA[1]]>
        </id_shop>
        <secure_key>
            <![CDATA[c3cc43cdffbbac3a72819051b93532c3]]>
        </secure_key>
        <recyclable>
            <![CDATA[0]]>
        </recyclable>
        <gift>
            <![CDATA[0]]>
        </gift>
        <gift_message></gift_message>
        <mobile_theme>
            <![CDATA[0]]>
        </mobile_theme>
        <total_discounts>
            <![CDATA[0.000000]]>
        </total_discounts>
        <total_discounts_tax_incl>
            <![CDATA[0.000000]]>
        </total_discounts_tax_incl>
        <total_discounts_tax_excl>
            <![CDATA[0.000000]]>
        </total_discounts_tax_excl>
        <total_paid>
            <![CDATA[69.950000]]>
        </total_paid>
        <total_paid_tax_incl>
            <![CDATA[69.950000]]>
        </total_paid_tax_incl>
        <total_paid_tax_excl>
            <![CDATA[69.950000]]>
        </total_paid_tax_excl>
        <total_products>
            <![CDATA[69.950000]]>
        </total_products>
        <total_products_wt>
            <![CDATA[69.950000]]>
        </total_products_wt>
        <total_shipping>
            <![CDATA[0.000000]]>
        </total_shipping>
        <total_shipping_tax_incl>
            <![CDATA[0.000000]]>
        </total_shipping_tax_incl>
        <total_shipping_tax_excl>
            <![CDATA[0.000000]]>
        </total_shipping_tax_excl>
        <total_wrapping>
            <![CDATA[0.000000]]>
        </total_wrapping>
        <total_wrapping_tax_incl>
            <![CDATA[0.000000]]>
        </total_wrapping_tax_incl>
        <total_wrapping_tax_excl>
            <![CDATA[0.000000]]>
        </total_wrapping_tax_excl>
        <reference>
            <![CDATA[IHRSTFPVD]]>
        </reference>
        <associations>
            <order_rows nodeType="order_row" virtualEntity="true">
                <order_row>
                    <id>
                        <![CDATA[20]]>
                    </id>
                    <product_id>
                        <![CDATA[2]]>
                    </product_id>
                    <product_attribute_id>
                        <![CDATA[1]]>
                    </product_attribute_id>
                    <product_quantity>
                        <![CDATA[1]]>
                    </product_quantity>
                    <product_name>
                        <![CDATA[This Girl Loves To Groove - Style : Mens Sneakers - White- Size : US6 (EU39)]]>
                    </product_name>
                    <product_reference>
                        <![CDATA[CASCS32-799307]]>
                    </product_reference>
                    <product_price>
                        <![CDATA[69.950000]]>
                    </product_price>
                    <unit_price_tax_incl>
                        <![CDATA[69.950000]]>
                    </unit_price_tax_incl>
                    <unit_price_tax_excl>
                        <![CDATA[69.950000]]>
                    </unit_price_tax_excl>
                </order_row>
            </order_rows>
        </associations>
    </order>
</groovekart>
														

Orders

Main Attributes

  • id

    type: numeric

  • id_address_delivery

    type: numeric

  • id_address_invoice

    type: numeric

  • id_cart

    type: numeric

  • id_currency

    type: numeric

  • id_lang

    type: numeric

  • id_customer

    type: numeric

  • id_carrier

    type: numeric

  • current_state

    type: text

  • invoice_number

    type: numeric

  • invoice_date

    type: date

  • delivery_number

    type: numeric

  • delivery_date

    type: date

  • gift

    type: numeric

  • gift_message

    type: text

  • total_discounts

    type: numeric

  • total_discounts_tax_incl

    type: numeric

  • total_discounts_tax_excl

    type: numeric

  • total_paid

    type: numeric

  • total_paid_tax_incl

    type: numeric

  • total_paid_tax_excl

    type: numeric

  • total_products

    type: numeric

  • total_products_wt

    type: numeric

  • total_shipping

    type: numeric

  • total_shipping_tax_incl

    type: numeric

  • total_shipping_tax_excl

    type: numeric

  • total_wrapping

    type: numeric

  • total_wrapping_tax_incl

    type: numeric

  • total_wrapping_tax_excl

    type: numeric

  • reference

    type: numeric

  • associations

    type: array

    Show child attributes

    • order_rows

      type: numeric

      Show child attributes

      • order_row

        type: numeric

        Show child attributes

        • id

          type: numeric

        • product_id

          type: numeric

        • product_attribute_id

          type: numeric

        • product_quantity

          type: numeric

        • product_name

          type: numeric

        • product_reference

          type: numeric

        • product_price

          type: numeric

        • unit_price_tax_incl

          type: numeric

        • unit_price_tax_excl

          type: numeric

Returns

Returns of new added Orders.

POST
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
  <order>
    <id></id>
    <id_address_delivery>10</id_address_delivery>
    <id_address_invoice>10</id_address_invoice>
    <id_cart>53</id_cart>
    <id_currency>1</id_currency>
    <id_lang>1</id_lang>
    <id_customer>13</id_customer>
    <id_carrier>1</id_carrier>
    <current_state>2</current_state>
    <module>cashondelivery</module>
    <invoice_number></invoice_number>
    <invoice_date></invoice_date>
    <delivery_number></delivery_number>
    <delivery_date></delivery_date>
    <valid>1</valid>
    <date_add></date_add>
    <date_upd></date_upd>
    <shipping_number></shipping_number>
    <note></note>
    <id_shop_group>1</id_shop_group>
    <id_shop>1</id_shop>
    <secure_key></secure_key>
    <payment>Cash on delivery</payment>
    <recyclable></recyclable>
    <gift></gift>
    <gift_message></gift_message>
    <mobile_theme></mobile_theme>
    <total_discounts>0</total_discounts>
    <total_discounts_tax_incl>0</total_discounts_tax_incl>
    <total_discounts_tax_excl>0</total_discounts_tax_excl>
    <total_paid>156.00</total_paid>
    <total_paid_tax_incl>156.00</total_paid_tax_incl>
    <total_paid_tax_excl>156.00</total_paid_tax_excl>
    <total_products>151.00</total_products>
    <total_products_wt>151.00</total_products_wt>
    <total_shipping>5</total_shipping>
    <total_shipping_tax_incl>5</total_shipping_tax_incl>
    <total_shipping_tax_excl>5</total_shipping_tax_excl>
    <total_wrapping>0</total_wrapping>
    <total_wrapping_tax_incl>0</total_wrapping_tax_incl>
    <total_wrapping_tax_excl>0</total_wrapping_tax_excl>
    <reference></reference>
    <associations>
      <order_rows>
        <order_row>
          <id></id>
          <product_id>63</product_id>
          <product_attribute_id>332</product_attribute_id>
          <product_quantity>1</product_quantity>
          <product_name>This guy loves to Groove Backpack</product_name>
          <product_reference></product_reference>
          <product_price>151.00</product_price>
          <id_customization></id_customization>
          <unit_price_tax_incl>151.00</unit_price_tax_incl>
          <unit_price_tax_excl>151.00</unit_price_tax_excl>
        </order_row>
      </order_rows>
    </associations>
  </order>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <order>
        <id>
            <![CDATA[20]]>
        </id>
        <id_address_delivery xlink:href="https://domain.com/webapi/addresses/3">
            <![CDATA[3]]>
        </id_address_delivery>
        <id_address_invoice xlink:href="https://domain.com/webapi/addresses/3">
            <![CDATA[3]]>
        </id_address_invoice>
        <id_cart xlink:href="https://domain.com/webapi/carts/47">
            <![CDATA[47]]>
        </id_cart>
        <id_currency xlink:href="https://domain.com/webapi/currencies/1">
            <![CDATA[1]]>
        </id_currency>
        <id_lang xlink:href="https://domain.com/webapi/languages/1">
            <![CDATA[1]]>
        </id_lang>
        <id_customer xlink:href="https://domain.com/webapi/customers/4">
            <![CDATA[4]]>
        </id_customer>
        <id_carrier xlink:href="https://domain.com/webapi/carriers/1">
            <![CDATA[1]]>
        </id_carrier>
        <current_state xlink:href="https://domain.com/webapi/order_states/4">
            <![CDATA[4]]>
        </current_state>
        <invoice_number>
            <![CDATA[20]]>
        </invoice_number>
        <invoice_date>
            <![CDATA[2021-07-14 05:48:04]]>
        </invoice_date>
        <delivery_number>
            <![CDATA[3]]>
        </delivery_number>
        <delivery_date>
            <![CDATA[2021-09-27 08:51:00]]>
        </delivery_date>
        <date_add>
            <![CDATA[2021-07-14 05:48:04]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-09-28 16:14:36]]>
        </date_upd>
        <shipping_number notFilterable="true">
            <![CDATA[TESTRNUM25215]]>
        </shipping_number>
        <id_shop_group>
            <![CDATA[1]]>
        </id_shop_group>
        <id_shop>
            <![CDATA[1]]>
        </id_shop>
        <secure_key>
            <![CDATA[c3cc43cdffbbac3a72819051b93532c3]]>
        </secure_key>
        <recyclable>
            <![CDATA[0]]>
        </recyclable>
        <gift>
            <![CDATA[0]]>
        </gift>
        <gift_message></gift_message>
        <mobile_theme>
            <![CDATA[0]]>
        </mobile_theme>
        <total_discounts>
            <![CDATA[0.000000]]>
        </total_discounts>
        <total_discounts_tax_incl>
            <![CDATA[0.000000]]>
        </total_discounts_tax_incl>
        <total_discounts_tax_excl>
            <![CDATA[0.000000]]>
        </total_discounts_tax_excl>
        <total_paid>
            <![CDATA[69.950000]]>
        </total_paid>
        <total_paid_tax_incl>
            <![CDATA[69.950000]]>
        </total_paid_tax_incl>
        <total_paid_tax_excl>
            <![CDATA[69.950000]]>
        </total_paid_tax_excl>
        <total_products>
            <![CDATA[69.950000]]>
        </total_products>
        <total_products_wt>
            <![CDATA[69.950000]]>
        </total_products_wt>
        <total_shipping>
            <![CDATA[0.000000]]>
        </total_shipping>
        <total_shipping_tax_incl>
            <![CDATA[0.000000]]>
        </total_shipping_tax_incl>
        <total_shipping_tax_excl>
            <![CDATA[0.000000]]>
        </total_shipping_tax_excl>
        <total_wrapping>
            <![CDATA[0.000000]]>
        </total_wrapping>
        <total_wrapping_tax_incl>
            <![CDATA[0.000000]]>
        </total_wrapping_tax_incl>
        <total_wrapping_tax_excl>
            <![CDATA[0.000000]]>
        </total_wrapping_tax_excl>
        <reference>
            <![CDATA[IHRSTFPVD]]>
        </reference>
        <associations>
            <order_rows nodeType="order_row" virtualEntity="true">
                <order_row>
                    <id>
                        <![CDATA[20]]>
                    </id>
                    <product_id>
                        <![CDATA[2]]>
                    </product_id>
                    <product_attribute_id>
                        <![CDATA[1]]>
                    </product_attribute_id>
                    <product_quantity>
                        <![CDATA[1]]>
                    </product_quantity>
                    <product_name>
                        <![CDATA[This Girl Loves To Groove - Style : Mens Sneakers - White- Size : US6 (EU39)]]>
                    </product_name>
                    <product_reference>
                        <![CDATA[CASCS32-799307]]>
                    </product_reference>
                    <product_price>
                        <![CDATA[69.950000]]>
                    </product_price>
                    <unit_price_tax_incl>
                        <![CDATA[69.950000]]>
                    </unit_price_tax_incl>
                    <unit_price_tax_excl>
                        <![CDATA[69.950000]]>
                    </unit_price_tax_excl>
                </order_row>
            </order_rows>
        </associations>
    </order>
</groovekart>
														

Orders

Main Attributes

  • id

    type: numeric

  • id_address_delivery

    type: numeric

  • id_address_invoice

    type: numeric

  • id_cart

    type: numeric

  • id_currency

    type: numeric

  • id_lang

    type: numeric

  • id_customer

    type: numeric

  • id_carrier

    type: numeric

  • current_state

    type: text

  • invoice_number

    type: numeric

  • invoice_date

    type: date

  • delivery_number

    type: numeric

  • delivery_date

    type: date

  • gift

    type: numeric

  • gift_message

    type: text

  • total_discounts

    type: numeric

  • total_discounts_tax_incl

    type: numeric

  • total_discounts_tax_excl

    type: numeric

  • total_paid

    type: numeric

  • total_paid_tax_incl

    type: numeric

  • total_paid_tax_excl

    type: numeric

  • total_products

    type: numeric

  • total_products_wt

    type: numeric

  • total_shipping

    type: numeric

  • total_shipping_tax_incl

    type: numeric

  • total_shipping_tax_excl

    type: numeric

  • total_wrapping

    type: numeric

  • total_wrapping_tax_incl

    type: numeric

  • total_wrapping_tax_excl

    type: numeric

  • reference

    type: numeric

  • associations

    type: array

    Show child attributes

    • order_rows

      type: numeric

      Show child attributes

      • order_row

        type: numeric

        Show child attributes

        • id

          type: numeric

        • product_id

          type: numeric

        • product_attribute_id

          type: numeric

        • product_quantity

          type: numeric

        • product_name

          type: numeric

        • product_reference

          type: numeric

        • product_price

          type: numeric

        • unit_price_tax_incl

          type: numeric

        • unit_price_tax_excl

          type: numeric

Returns

Returns the update of Orders.

PUT
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
  <order>
    <id>20</id>
    <id_address_delivery>10</id_address_delivery>
    <id_address_invoice>10</id_address_invoice>
    <id_cart>53</id_cart>
    <id_currency>1</id_currency>
    <id_lang>1</id_lang>
    <id_customer>13</id_customer>
    <id_carrier>1</id_carrier>
    <current_state>3</current_state>
    <module>cashondelivery</module>
    <invoice_number></invoice_number>
    <invoice_date></invoice_date>
    <delivery_number></delivery_number>
    <delivery_date></delivery_date>
    <valid>1</valid>
    <date_add></date_add>
    <date_upd></date_upd>
    <shipping_number></shipping_number>
    <note></note>
    <id_shop_group>1</id_shop_group>
    <id_shop>1</id_shop>
    <secure_key></secure_key>
    <payment>Cash on delivery</payment>
    <recyclable></recyclable>
    <gift></gift>
    <gift_message></gift_message>
    <mobile_theme></mobile_theme>
    <total_discounts>0</total_discounts>
    <total_discounts_tax_incl>0</total_discounts_tax_incl>
    <total_discounts_tax_excl>0</total_discounts_tax_excl>
    <total_paid>156.00</total_paid>
    <total_paid_tax_incl>156.00</total_paid_tax_incl>
    <total_paid_tax_excl>156.00</total_paid_tax_excl>
    <total_paid_real>156.00</total_paid_real>
    <total_products>151.00</total_products>
    <total_products_wt>151.00</total_products_wt>
    <total_shipping>5</total_shipping>
    <total_shipping_tax_incl>5</total_shipping_tax_incl>
    <total_shipping_tax_excl>5</total_shipping_tax_excl>
    <carrier_tax_rate>0</carrier_tax_rate>
    <total_wrapping>0</total_wrapping>
    <total_wrapping_tax_incl>0</total_wrapping_tax_incl>
    <total_wrapping_tax_excl>0</total_wrapping_tax_excl>
    <round_mode>2</round_mode>
    <round_type>2</round_type>
    <conversion_rate>1</conversion_rate>
    <store_status>1</store_status>
    <reference></reference>
    <associations>
      <order_rows>
        <order_row>
          <id></id>
          <product_id>63</product_id>
          <product_attribute_id>332</product_attribute_id>
          <product_quantity>1</product_quantity>
          <product_name>This guy loves to Groove Backpack</product_name>
          <product_reference></product_reference>
          <product_ean13></product_ean13>
          <product_isbn></product_isbn>
          <product_upc></product_upc>
          <product_price>151.00</product_price>
          <id_customization></id_customization>
          <unit_price_tax_incl>151.00</unit_price_tax_incl>
          <unit_price_tax_excl>151.00</unit_price_tax_excl>
        </order_row>
      </order_rows>
    </associations>
  </order>
</groovekart>
														
Response
<?xml version="1.0" encoding="UTF-8"?>
<groovekart xmlns:xlink="http://www.w3.org/1999/xlink">
    <order>
        <id>
            <![CDATA[20]]>
        </id>
        <id_address_delivery xlink:href="https://domain.com/webapi/addresses/10">
            <![CDATA[10]]>
        </id_address_delivery>
        <id_address_invoice xlink:href="https://domain.com/webapi/addresses/10">
            <![CDATA[10]]>
        </id_address_invoice>
        <id_cart xlink:href="https://domain.com/webapi/carts/53">
            <![CDATA[53]]>
        </id_cart>
        <id_currency xlink:href="https://domain.com/webapi/currencies/1">
            <![CDATA[1]]>
        </id_currency>
        <id_lang xlink:href="https://domain.com/webapi/languages/1">
            <![CDATA[1]]>
        </id_lang>
        <id_customer xlink:href="https://domain.com/webapi/customers/13">
            <![CDATA[13]]>
        </id_customer>
        <id_carrier xlink:href="https://domain.com/webapi/carriers/1">
            <![CDATA[1]]>
        </id_carrier>
        <current_state xlink:href="https://domain.com/webapi/order_states/3">
            <![CDATA[3]]>
        </current_state>
        <invoice_number></invoice_number>
        <invoice_date></invoice_date>
        <delivery_number></delivery_number>
        <delivery_date></delivery_date>
        <date_add>
            <![CDATA[2021-10-01 04:17:09]]>
        </date_add>
        <date_upd>
            <![CDATA[2021-10-01 04:17:09]]>
        </date_upd>
        <shipping_number notFilterable="true"></shipping_number>
        <id_shop_group>
            <![CDATA[1]]>
        </id_shop_group>
        <id_shop>
            <![CDATA[1]]>
        </id_shop>
        <secure_key></secure_key>
        <recyclable></recyclable>
        <gift></gift>
        <gift_message></gift_message>
        <mobile_theme></mobile_theme>
        <total_discounts>
            <![CDATA[0]]>
        </total_discounts>
        <total_discounts_tax_incl>
            <![CDATA[0]]>
        </total_discounts_tax_incl>
        <total_discounts_tax_excl>
            <![CDATA[0]]>
        </total_discounts_tax_excl>
        <total_paid>
            <![CDATA[156.00]]>
        </total_paid>
        <total_paid_tax_incl>
            <![CDATA[156.00]]>
        </total_paid_tax_incl>
        <total_paid_tax_excl>
            <![CDATA[156.00]]>
        </total_paid_tax_excl>
        <total_products>
            <![CDATA[151.00]]>
        </total_products>
        <total_products_wt>
            <![CDATA[151.00]]>
        </total_products_wt>
        <total_shipping>
            <![CDATA[5]]>
        </total_shipping>
        <total_shipping_tax_incl>
            <![CDATA[5]]>
        </total_shipping_tax_incl>
        <total_shipping_tax_excl>
            <![CDATA[5]]>
        </total_shipping_tax_excl>
        <total_wrapping>
            <![CDATA[0]]>
        </total_wrapping>
        <total_wrapping_tax_incl>
            <![CDATA[0]]>
        </total_wrapping_tax_incl>
        <total_wrapping_tax_excl>
            <![CDATA[0]]>
        </total_wrapping_tax_excl>
        <reference></reference>
        <associations>
            <order_rows nodeType="order_row" virtualEntity="true">
                <order_row>
                    <id>
                        <![CDATA[20]]>
                    </id>
                    <product_id>
                        <![CDATA[2]]>
                    </product_id>
                    <product_attribute_id>
                        <![CDATA[1]]>
                    </product_attribute_id>
                    <product_quantity>
                        <![CDATA[1]]>
                    </product_quantity>
                    <product_name>
                        <![CDATA[This Girl Loves To Groove - Style : Mens Sneakers - White- Size : US6 (EU39)]]>
                    </product_name>
                    <product_reference>
                        <![CDATA[CASCS32-799307]]>
                    </product_reference>
                    <product_price>
                        <![CDATA[69.950000]]>
                    </product_price>
                    <unit_price_tax_incl>
                        <![CDATA[69.950000]]>
                    </unit_price_tax_incl>
                    <unit_price_tax_excl>
                        <![CDATA[69.950000]]>
                    </unit_price_tax_excl>
                </order_row>
            </order_rows>
        </associations>
    </order>
</groovekart>
														

Orders

Attributes

No Attributes.

Returns

Return the message if successfully deleted.

GET

No Attributes

Response

Successfully deleted