Update Product Settings

Update a product’s setting.

put

Path parameters

idstringRequired

Body

application/jsontext/jsonapplication/*+json

productOrderingboolean | nullableOptional

productRequestsall ofOptional

itemSelectionboolean | nullableOptional

orderQueueChangesboolean | nullableOptional

preValidationall ofOptional

splitBillingall ofOptional

subscriptionCessationall ofOptional

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}/settings HTTP/1.1
Host: api.s1.today
Content-Type: application/json
Accept: */*
Content-Length: 422

{
  "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": "OrderBased"
  },
  "subscriptionCessation": {
    "enabled": true,
    "mode": "Termination"
  }
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-08-09T11:45:25.321Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2025-08-09T11:45:25.321Z",
      "by": "[Circular Reference]"
    },
    "published": {
      "at": "2025-08-09T11:45:25.321Z",
      "by": "[Circular Reference]"
    },
    "pending": {
      "at": "2025-08-09T11:45:25.321Z",
      "by": "[Circular Reference]"
    },
    "unpublished": {
      "at": "2025-08-09T11:45:25.321Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "shortDescription": "text",
  "longDescription": "text",
  "externalIds": {
    "operations": "text",
    "defaultErpItem": "text"
  },
  "website": "text",
  "icon": "text",
  "status": "text",
  "vendor": {
    "id": "text",
    "icon": "text",
    "type": "Client",
    "status": "Active",
    "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
  }
}