PATCH
/
products
/
{id}
curl --request PATCH \
  --url https://api.aasaan.shop/api/v1/stores/products/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "Head & Shoulders Anti Hairfall Anti Dandruff Shampoo",
  "sku": "000-000-000-000",
  "quantity": 1,
  "description": "Now, ensure the good health of your hair with Head & Shoulders Anti Hairfall Anti Dandruff Shampoo that strengthens hair from its roots and cures dandruff. Be it dry, frizzy, or damaged, this shampoo can bring back the younger days of your hair within just a few days. The shampoo is richly indulgent and improves the experience of washing your hair. It makes your hair dandruff-free up to 100%. Do not fret over chemicals as the product is gentle in use and can be used every day.",
  "shortDescription": "Anti Dandruff Shampoo that strengthens hair from its roots and cures dandruff",
  "active": true,
  "outOfStock": true,
  "width": 100,
  "height": 200,
  "depth": 20,
  "weight": 500,
  "isShippingEnabled": true,
  "isProductLevelTaxEnabled": true,
  "displayOrder": 1,
  "tax": {
    "CGST": 2,
    "SGST": 2,
    "GST": 4
  },
  "seo": {
    "title": "Head and Shoulders",
    "description": "Head & Shoulders Anti Hairfall Anti Dandruff Shampoo that strengthens hair",
    "image": {
      "url": "https://images.aasaan.app/123412421",
      "type": "image/png"
    }
  },
  "variantAttributeValues": [
    {
      "name": "color",
      "value": [
        "blue, yellow, green"
      ]
    }
  ],
  "prices": [
    {
      "channelId": "636f2e876e9de14bfe1b02f1",
      "salesPrice": "45",
      "regularPrice": "50",
      "hide": true
    }
  ],
  "quantities": [
    {
      "warehouseId": "636f2e876e9de14bfe1b02f1",
      "quantity": "45"
    }
  ],
  "categories": [
    {
      "id": "636f2e876e9de14bfe1b02f1"
    }
  ],
  "images": [
    {
      "id": "<string>",
      "url": "https://images.aasaan.app/123412421",
      "type": "https://images.aasaan.app/123412421"
    }
  ],
  "brand": {
    "id": "636f2e876e9de14bfe1b02f2"
  }
}'
{
  "id": "623d3455ec3c4b3548eb4a343",
  "sku": "000-000-000-000",
  "name": "Head & Shoulders Anti Hairfall Anti Dandruff Shampoo",
  "slug": "head_shoulders_anti_hairfall_anti_dandruff_shampoo_650_ml_22",
  "quantity": 1,
  "description": "Now, ensure the good health of your hair with Head & Shoulders Anti Hairfall Anti Dandruff Shampoo that strengthens hair from its roots and cures dandruff. Be it dry, frizzy, or damaged, this shampoo can bring back the younger days of your hair within just a few days. The shampoo is richly indulgent and improves the experience of washing your hair. It makes your hair dandruff-free up to 100%. Do not fret over chemicals as the product is gentle in use and can be used every day.",
  "shortDescription": "Anti Dandruff Shampoo that strengthens hair from its roots and cures dandruff",
  "active": true,
  "outOfStock": true,
  "width": 100,
  "height": 200,
  "depth": 20,
  "weight": 500,
  "prices": [
    {
      "channelId": "636f2e876e9de14bfe1b02f1",
      "salesPrice": "45",
      "regularPrice": "50",
      "hide": true
    }
  ],
  "isShippingEnabled": true,
  "isProductLevelTaxEnabled": true,
  "tax": {
    "CGST": 2,
    "SGST": 2,
    "GST": 4
  },
  "isVariantEnabled": true,
  "seo": {
    "title": "Head and Shoulders",
    "description": "Head & Shoulders Anti Hairfall Anti Dandruff Shampoo that strengthens hair",
    "image": {
      "url": "https://images.aasaan.app/123412421",
      "type": "image/png"
    }
  },
  "categories": [
    {
      "id": "1231231",
      "name": "Shampoos and Soaps"
    }
  ],
  "images": [
    {
      "id": "<string>",
      "url": "https://images.aasaan.app/123412421",
      "type": "image/png"
    }
  ],
  "variantAttributeValues": [
    {
      "name": "color",
      "value": [
        "blue, yellow, green"
      ]
    }
  ],
  "brand": {
    "id": "636f2e876e9de14bfe1b02fa",
    "name": "P&G"
  },
  "variants": [
    {
      "id": "567152378158871683",
      "name": "Head & Shoulders Anti Hairfall Anti Dandruff Shampoo 600ml",
      "quantity": 10,
      "description": "<string>",
      "shortDescription": "<string>",
      "active": true,
      "outOfStock": true,
      "width": 10,
      "height": 10,
      "depth": 10,
      "weight": 10,
      "isShippingEnabled": true,
      "isProductLevelTaxEnabled": true,
      "images": [
        {
          "id": "<string>",
          "url": "https://images.aasaan.app/123412421",
          "type": "image/png"
        }
      ],
      "date_created": "2022-03-25T03:17:44.092Z",
      "date_modified": "2022-06-10T07:51:12.510Z"
    }
  ],
  "date_created": "2022-03-25T03:17:44.092Z",
  "date_modified": "2022-06-10T07:51:12.510Z"
}

Authorizations

x-api-key
string
headerrequired

Path Parameters

id
string
required

Product Id

Body

application/json
name
string
required

Name

sku
string
required

Stock keeping Unit

quantity
integer
required

Product quantity

description
string

Product description

shortDescription
string

Product short description

active
boolean

Active indicator

outOfStock
boolean

Out of stock product

width
integer

Width(cm)

height
integer

Height(cm)

depth
integer

Depth(cm)

weight
integer
required

Weight(kg)

isShippingEnabled
boolean

Enable to enter shipping details

isProductLevelTaxEnabled
boolean

Enable to enter CGST and SGST taxes

displayOrder
integer

Product display order

tax
object

Tax information for this product

seo
object

SEO metadata for this product

variantAttributeValues
object[]

All Possible Variant Attribute Values that this parent product can have

prices
object[]

Price Information across various channels

quantities
object[]

Quantity Information across various warehouses

categories
object[]
required

Associated Categories

images
object[]

Product images

brand
object

Brand

Response

200 - application/json
id
string

Unique identifier for the resource

sku
string

Stock keeping Unit

name
string

Name

slug
string

Slug

quantity
integer

Product quantity

description
string

Product description

shortDescription
string

Product short description

active
boolean

Active indicator

outOfStock
boolean

Out of stock product

width
integer

Width(cm)

height
integer

Height(cm)

depth
integer

Depth(cm)

weight
integer

Weight(kg)

prices
object[]

Price Information across various channels

isShippingEnabled
boolean

Enable to enter shipping details

isProductLevelTaxEnabled
boolean

Enable to enter CGST and SGST taxes

tax
object

Tax information for this product

isVariantEnabled
boolean

Enable to enter product variants

seo
object

SEO metadata for this product

categories
object[]

Associated Categories

images
object[]

Product images

variantAttributeValues
object[]

All Possible Variant Attribute Values that this parent product can have

brand
object

Brand

variants
object[]

Images

date_created
string

Created date

date_modified
string

Modified date