Update Product

Update some properties of a product.

put

Path parameters

idstringRequired

Body

multipart/form-dataapplication/json

iconstring · binaryOptional

Responses

200

OK

application/json

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

put

HTTPcURLJavaScriptPython

PUT /public/v1/catalog/products/{id} HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 143

{
  "product": {
    "Name": "text",
    "ShortDescription": "text",
    "LongDescription": "text",
    "ExternalIds.Operations": "text",
    "Website": "text"
  },
  "icon": "binary"
}

multipart/form-dataapplication/json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-06-01T17:12:58.269Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-06-01T17:12:58.269Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "published": {
      "at": "2025-06-01T17:12:58.269Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "pending": {
      "at": "2025-06-01T17:12:58.269Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "unpublished": {
      "at": "2025-06-01T17:12:58.269Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "shortDescription": "text",
  "longDescription": "text",
  "externalIds": {
    "operations": "text"
  },
  "website": "text",
  "icon": "text",
  "status": "text",
  "vendor": {
    "id": "text",
    "icon": "text",
    "type": "text",
    "status": "text",
    "name": "text"
  },
  "settings": {
    "productOrdering": true,
    "productRequests": {
      "enabled": true,
      "name": "text",
      "label": "text"
    },
    "itemSelection": true,
    "orderQueueChanges": true,
    "preValidation": {
      "purchaseOrderDraft": true,
      "purchaseOrderQuerying": true,
      "changeOrderDraft": true,
      "configurationOrderDraft": true,
      "terminationOrder": true,
      "productRequest": true
    },
    "splitBilling": {
      "enabled": true,
      "type": "text"
    },
    "subscriptionCessation": {
      "enabled": true,
      "mode": "Termination"
    }
  },
  "statistics": {
    "itemCount": 1,
    "ordersPlacedCount": 1,
    "agreementCount": 1,
    "subscriptionCount": 1,
    "requestCount": 1
  }
}