Update Product Attributes

PUT/api/v2/public/products/attributes

Replaces one attribute value across every product that carries it, for example when a brand is renamed in the source system. attribute accepts only product_name, brand_code, brand_description or volume; any other name is ignored and the call still reports success. Matching is on the whole value, not a partial one.

Body ParametersJSONExpand Collapse

attribute: string

Which attribute to change. One of product_name, brand_code, brand_description or volume. Any other value is ignored.

minLength1

new_value: string

The value to write in its place.

minLength1

old_value: string

The existing value to look for. Products are matched on the whole value, not a part of it.

minLength1

ReturnsExpand Collapse

data: boolean

code: optional number

formatint32

message: optional string

status: optional string

Update Product Attributes

curl https://api.colleqtive.net/api/v2/public/products/attributes \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" \
    -d '{
          "attribute": "x",
          "new_value": "x",
          "old_value": "x"
        }'

{
  "data": true,
  "code": 0,
  "message": "message",
  "status": "status"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}

Returns Examples

{
  "data": true,
  "code": 0,
  "message": "message",
  "status": "status"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}