Products

Update Name and Description

Updates product's name and description.

PUT

/v1/products/variations/{id}/description

curl --request PUT \
  --url 'https://public-api.bladepro.io/v1/products/variations/{id}/description?expand=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "full_description": "<string>",
  "locale": "<string>",
  "name": "<string>"
}
'

{
  "data": {
    "created": "2019-11-25T14:52:56.000Z",
    "full_description": "Example product description",
    "id": 1,
    "locale": {
      "code": "en",
      "created": "2019-11-25T14:52:56.000Z",
      "id": 1,
      "modified": "2019-11-25T14:52:56.000Z",
      "name": "English"
    },
    "locale_id": 1,
    "modified": "2019-11-25T14:52:56.000Z",
    "name": "Example product",
    "product_variation_id": 1
  },
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

Scope(s): APP::PRODUCTS::MANAGE

Path Parameters

idstringrequired

Path parameter: id

Pattern: [1-9][0-9]{0,}

Query Parameters

expandstringquery

Usage: expand=*

Expand locale

Body

full_descriptionstringrequired

Description.

localestringrequired

ID or code of locale.

namestringrequired

Name.

Response

successful operation

createdany

The created date.

full_descriptionstring

The description of the product.

idnumber

The product variation description id.

localeobject

The locale for this description.

Show child attributes

locale_idnumber

The description locale.

modifiedany

The last modified date.

namestring

The product name.

product_variation_idnumber

The product variation id.

Still need help? Share an idea