PUT
/
catalog
/
products
/
{id}
curl --request PUT \
  --url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/catalog/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "status": "draft",
  "active": true,
  "stock_available": true,
  "short_description": "<string>",
  "description": "<string>",
  "metadata": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "tags": [
    "<string>"
  ],
  "hsn_code": "<string>",
  "categories": [
    "<string>"
  ],
  "attributes": [
    {
      "attribute_id": "<string>",
      "attribute_value": "<string>"
    }
  ],
  "is_featured": true,
  "on_subscription": true,
  "on_promotion": true,
  "has_variant": true,
  "variants": [
    {
      "name": "<string>",
      "associated_options": {}
    }
  ],
  "sku": "<string>",
  "pricing": [
    {
      "customer_group_id": "<string>",
      "cost_price": 123,
      "listing_price": 123,
      "selling_price": 123,
      "min_order_quantity": 123,
      "max_order_quantity": 123,
      "incremental_quantity": 123,
      "tax_type": "<string>",
      "tax_rate": 123
    }
  ],
  "images": [
    {
      "title": "<string>",
      "alternate_text": "<string>",
      "sort_order": 123,
      "url_tiny": "<string>",
      "url_thumbnail": "<string>",
      "url_standard": "<string>",
      "url_zoom": "<string>",
      "other_details": {}
    }
  ],
  "shipping": {
    "is_free_shipping": false,
    "is_fixed_cost_shipping": false,
    "fixed_cost_shipping_price": 123,
    "is_shipping_price_include_tax": true,
    "availability_description": "<string>",
    "ships_internationally": true,
    "mid_code": "<string>",
    "country_of_origin": "<string>"
  },
  "packaging": {
    "pack_width": 123,
    "pack_height": 123,
    "pack_length": 123,
    "pack_dry_weight": 123,
    "units_per_pack": 123,
    "vertical_rotation": true,
    "shipper_width": 123,
    "shipper_height": 123,
    "shipper_length": 123,
    "shipper_dry_weight": 123,
    "units_per_shipper": 123
  },
  "promotions": [
    {
      "promotion_type": "<string>",
      "starts_at": "<string>",
      "expires_at": "<string>",
      "details": [
        {
          "discount_type": "percentage",
          "discount_percent": 123,
          "discount_fixed_amount": 123,
          "customer_group_id": "<string>"
        }
      ]
    }
  ],
  "subscriptions": [
    {
      "subscription_plan": "<string>",
      "billing_interval": 123,
      "billing_frequency": "<string>",
      "billing_limit": 123,
      "billing_trial_days": 123,
      "order_interval": 123,
      "order_frequency": "<string>",
      "order_limit": 123,
      "fulfill_separately": true,
      "subscription_price": [
        {
          "customer_group_id": "<string>",
          "min_quantity": 123,
          "suscription_price": 123
        }
      ],
      "quantity": 123
    }
  ],
  "sales_channels": [
    {
      "id": "<string>",
      "sales_channel_sku": "<string>"
    }
  ],
  "related_products": {
    "cross_sell": [
      "<string>"
    ],
    "upsell": [
      "<string>"
    ]
  },
  "seo": {
    "meta_title": "<string>",
    "meta_description": "<string>",
    "meta_keywords": [
      "<string>"
    ],
    "slug": "<string>"
  },
  "bundle_items": [
    {
      "product_id": "<string>",
      "quantity": 123
    }
  ]
}'
{
  "message": "<string>",
  "success": true,
  "content": {
    "product": {
      "id": "<string>",
      "name": "<string>",
      "status": "draft",
      "active": true,
      "stock_available": true,
      "short_description": "<string>",
      "metadata": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "tags": [
        "<string>"
      ],
      "product_type": "<string>",
      "hsn_code": "<string>",
      "categories": [
        {
          "id": "<string>",
          "name": "<string>",
          "active": true
        }
      ],
      "attributes": [
        {
          "attribute_id": "<string>",
          "attribute_name": "<string>",
          "attribute_value": "<string>",
          "attribute_type": "Text"
        }
      ],
      "variant_options": [
        {
          "option_name": "<string>",
          "option_value": [
            "<string>"
          ]
        }
      ],
      "reviews_rating_sum": 123,
      "reviews_count": 123,
      "is_featured": true,
      "on_offer": true,
      "on_promotion": true,
      "on_subscription": true,
      "has_variant": true,
      "variant_count": 123,
      "modified_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "sku": "<string>",
      "images": [
        {
          "id": 123,
          "title": "<string>",
          "alternate_text": "<string>",
          "sort_order": 123,
          "url_tiny": "<string>",
          "url_thumbnail": "<string>",
          "url_standard": "<string>",
          "url_zoom": "<string>",
          "other_details": {}
        }
      ],
      "description": "<string>",
      "pricing": [
        {
          "id": 123,
          "customer_group_id": "<string>",
          "cost_price": 123,
          "listing_price": 123,
          "selling_price": 123,
          "min_order_quantity": 123,
          "max_order_quantity": 123,
          "incremental_quantity": 123,
          "tax_type": "<string>",
          "tax_rate": 123
        }
      ],
      "shipping": {
        "is_free_shipping": false,
        "is_fixed_cost_shipping": false,
        "fixed_cost_shipping_price": 123,
        "is_shipping_price_include_tax": true,
        "availability_description": "<string>",
        "ships_internationally": true,
        "mid_code": "<string>",
        "country_of_origin": "<string>"
      },
      "packaging": {
        "pack_width": 123,
        "pack_height": 123,
        "pack_length": 123,
        "pack_dry_weight": 123,
        "units_per_pack": 123,
        "vertical_rotation": true,
        "shipper_width": 123,
        "shipper_height": 123,
        "shipper_length": 123,
        "shipper_dry_weight": 123,
        "units_per_shipper": 123
      },
      "promotions": [
        {
          "promotion_type": "<string>",
          "starts_at": "<string>",
          "expires_at": "<string>",
          "details": [
            {
              "discount_type": "percentage",
              "discount_percent": 123,
              "discount_fixed_amount": 123,
              "customer_group_id": "<string>"
            }
          ]
        }
      ],
      "subscriptions": [
        {
          "subscription_plan": "<string>",
          "billing_interval": 123,
          "billing_frequency": "<string>",
          "billing_limit": 123,
          "billing_trial_days": 123,
          "order_interval": 123,
          "order_frequency": "<string>",
          "order_limit": 123,
          "fulfill_separately": true,
          "subscription_price": [
            {
              "customer_group_id": "<string>",
              "min_quantity": 123,
              "suscription_price": 123
            }
          ],
          "quantity": 123
        }
      ],
      "sales_channels": [
        {
          "id": "<string>",
          "name": "<string>",
          "sales_channel_sku": "<string>"
        }
      ],
      "related_products": {
        "upsell": [
          {
            "id": "<string>",
            "name": "<string>",
            "status": "draft",
            "active": true,
            "stock_available": true,
            "short_description": "<string>",
            "metadata": [
              {
                "name": "<string>",
                "value": "<string>"
              }
            ],
            "tags": [
              "<string>"
            ],
            "product_type": "<string>",
            "hsn_code": "<string>",
            "categories": [
              {
                "id": "<string>",
                "name": "<string>",
                "active": true
              }
            ],
            "attributes": [
              {
                "attribute_id": "<string>",
                "attribute_name": "<string>",
                "attribute_value": "<string>",
                "attribute_type": "Text"
              }
            ],
            "variant_options": [
              {
                "option_name": "<string>",
                "option_value": [
                  "<string>"
                ]
              }
            ],
            "reviews_rating_sum": 123,
            "reviews_count": 123,
            "is_featured": true,
            "on_offer": true,
            "on_promotion": true,
            "on_subscription": true,
            "has_variant": true,
            "variant_count": 123,
            "modified_at": "2023-11-07T05:31:56Z",
            "created_at": "2023-11-07T05:31:56Z",
            "sku": "<string>",
            "images": [
              {
                "id": 123,
                "title": "<string>",
                "alternate_text": "<string>",
                "sort_order": 123,
                "url_tiny": "<string>",
                "url_thumbnail": "<string>",
                "url_standard": "<string>",
                "url_zoom": "<string>",
                "other_details": {}
              }
            ]
          }
        ],
        "cross_sell": [
          {
            "id": "<string>",
            "name": "<string>",
            "status": "draft",
            "active": true,
            "stock_available": true,
            "short_description": "<string>",
            "metadata": [
              {
                "name": "<string>",
                "value": "<string>"
              }
            ],
            "tags": [
              "<string>"
            ],
            "product_type": "<string>",
            "hsn_code": "<string>",
            "categories": [
              {
                "id": "<string>",
                "name": "<string>",
                "active": true
              }
            ],
            "attributes": [
              {
                "attribute_id": "<string>",
                "attribute_name": "<string>",
                "attribute_value": "<string>",
                "attribute_type": "Text"
              }
            ],
            "variant_options": [
              {
                "option_name": "<string>",
                "option_value": [
                  "<string>"
                ]
              }
            ],
            "reviews_rating_sum": 123,
            "reviews_count": 123,
            "is_featured": true,
            "on_offer": true,
            "on_promotion": true,
            "on_subscription": true,
            "has_variant": true,
            "variant_count": 123,
            "modified_at": "2023-11-07T05:31:56Z",
            "created_at": "2023-11-07T05:31:56Z",
            "sku": "<string>",
            "images": [
              {
                "id": 123,
                "title": "<string>",
                "alternate_text": "<string>",
                "sort_order": 123,
                "url_tiny": "<string>",
                "url_thumbnail": "<string>",
                "url_standard": "<string>",
                "url_zoom": "<string>",
                "other_details": {}
              }
            ]
          }
        ]
      },
      "variants": [
        {
          "id": "<string>",
          "name": "<string>",
          "sku": "<string>",
          "active": true,
          "hsn_code": "<string>",
          "images": [
            {
              "id": 123,
              "title": "<string>",
              "alternate_text": "<string>",
              "sort_order": 123,
              "url_tiny": "<string>",
              "url_thumbnail": "<string>",
              "url_standard": "<string>",
              "url_zoom": "<string>",
              "other_details": {}
            }
          ],
          "pricing": [
            {
              "id": 123,
              "customer_group_id": "<string>",
              "cost_price": 123,
              "listing_price": 123,
              "selling_price": 123,
              "min_order_quantity": 123,
              "max_order_quantity": 123,
              "incremental_quantity": 123,
              "tax_type": "<string>",
              "tax_rate": 123
            }
          ],
          "packaging": {
            "pack_width": 123,
            "pack_height": 123,
            "pack_length": 123,
            "pack_dry_weight": 123,
            "units_per_pack": 123,
            "vertical_rotation": true,
            "shipper_width": 123,
            "shipper_height": 123,
            "shipper_length": 123,
            "shipper_dry_weight": 123,
            "units_per_shipper": 123
          },
          "associated_options": {}
        }
      ],
      "bundle_items": [
        {
          "product_id": "<string>",
          "product_name": "<string>",
          "quantity": 123,
          "sku": "<string>",
          "stock_available": true,
          "pricing": {
            "id": 123,
            "customer_group_id": "<string>",
            "cost_price": 123,
            "listing_price": 123,
            "selling_price": 123,
            "min_order_quantity": 123,
            "max_order_quantity": 123,
            "incremental_quantity": 123,
            "tax_type": "<string>",
            "tax_rate": 123
          },
          "images": [
            {
              "id": 123,
              "title": "<string>",
              "alternate_text": "<string>",
              "sort_order": 123,
              "url_tiny": "<string>",
              "url_thumbnail": "<string>",
              "url_standard": "<string>",
              "url_zoom": "<string>",
              "other_details": {}
            }
          ],
          "reviews_rating_sum": 123,
          "reviews_count": 123
        }
      ],
      "seo": {
        "meta_title": "<string>",
        "meta_description": "<string>",
        "meta_keywords": [
          "<string>"
        ],
        "slug": "<string>"
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

product Ulid

Body

application/json
name
string
Maximum length: 128
status
enum<string>
Available options:
draft,
active,
inactive
active
boolean
stock_available
boolean
short_description
string
Maximum length: 256
description
string
metadata
object[]
tags
string[]
hsn_code
string
categories
string[]

array of category ulid

attributes
object[]
on_subscription
boolean
on_promotion
boolean
has_variant
boolean
variants
object[]

Use this field only for creating variants of a draft product having variants.

sku
string

required if has_variant is false.

Maximum length: 64
pricing
object[]
images
object[]
shipping
object
packaging
object
promotions
object[]
subscriptions
object[]
sales_channels
object[]

array of sales channel ulid

seo
object
bundle_items
object[]

Response

200 - application/json
OK
message
string
success
boolean
content
object