Light Mode

Update Product Option

PUT/products/options/{option}

Last modified: 2 months ago

This endpoint allows you to update specific option details for a specific product by passing the option as a path parameter.

:::tip[Note]

For the product.type variable set to product, updating product option with new values will generate new variants for these new values
When the old values are updated, they are removed as the new values are added.
:::

`products.read_write`- Products Read & Write

Request

Authorization

Inherited from project

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Path Params

option

integer

required

The Option ID. List of Products Options ID can be found here.

No schema defined

{
  "name": "text update",
  "required": false,
  "sort": 44,
  "display_type": "text",
  "associated_with_order_time": false,
  "not_same_day_order": false,
  "availability_range": true,
  "visibility": "on_condition",
  "visibility_condition_type": "=",
  "visibility_condition_option": 131932457,
  "visibility_condition_value": 1516487768,
  "advance": true,
  "values": [
    {
      "name": "value new"
    },
    {
      "name": "value new 2"
    }
  ]
}

Request samples

Responses

Updated Successfully(201)

Not Found(404)

Error Validation(422)

Unauthorized(401)

Updated Successfully

HTTP Code: 201

Content Type : JSONapplication/json

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

#/definitions/1307306

optional

{
  "status": 201,
  "success": true,
  "data": {
    "id": 1130246629,
    "name": "size",
    "description": "This product is best seller",
    "type": "radio",
    "required": false,
    "associated_with_order_time": 0,
    "sort": 9,
    "display_type": "text",
    "visibility": "always",
    "values": [
      {
        "id": 322122678,
        "name": "XL",
        "price": {
          "amount": 180,
          "currency": "SAR"
        },
        "display_value": "XL",
        "option_id": 1130246629,
        "image_url": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
        "hashed_display_value": "XL"
      }
    ],
    "skus": [
      {
        "id": 652911549,
        "price": {
          "amount": 150,
          "currency": "SAR"
        },
        "regular_price": {
          "amount": 234,
          "currency": "SAR"
        },
        "stock_quantity": 3000,
        "barcode": "barcode-ABC",
        "sku": "sku-variant-1551119600",
        "related_option_values": [
          667315336,
          322122678
        ]
      }
    ]
  }
}

Last modified: 2 months ago