Sign in

v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB
Products

Update a product

patch/v3/products/{id}

Path parameters

idstring required
Example:123e4567-e89b-12d3-a456-426614174000

Product ID

Request body

namestring

Internal catalog name of the product

displayNamestring

Customer-facing display name of the product

status'ACTIVE' | 'INACTIVE'

Product status (active or inactive)

descriptionstring

Product description

integrationItemIdstring

ERP integration item ID

erpClassIdstring

ERP class ID

Example request

{
  "name": "string",
  "status": "ACTIVE"
}

Response

Product updated successfully

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "manufacturerId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Enterprise License",
    "displayName": "Enterprise License",
    "status": "ACTIVE",
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z"
  }
}