Update Product Settings

Update a product’s setting.

PUT/v1/catalog/products/{id}/settings

Path parameters

id*string

Body

application/jsontext/jsonapplication/*+json

productOrderingnullable boolean

productRequestsProductRequestsInput (object)

itemSelectionnullable boolean

orderQueueChangesnullable boolean

preValidationPreValidationInput (object)

splitBillingProductSplitBillingRequestsInput (object)

Response

200400403500

OK

Body

application/json

idstring

auditProductQueryModelAudit (object)

$metaQueryModelMetadata (object)

hrefstring

namestring

shortDescriptionnullable string

longDescriptionnullable string

externalIdsProductExternalIdBag (object)

websitestring

iconstring

statusstring

vendorAccountQueryModel (object)

settingsProductSettings (object)

statisticsProductStatistics (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v1/catalog/products/{id}/settings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-01-23T20:58:56.858Z",
      "by": {
        "id": "text",
        "audit": {},
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-01-23T20:58:56.858Z",
      "by": {
        "id": "text",
        "audit": {},
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "published": {
      "at": "2025-01-23T20:58:56.858Z",
      "by": {
        "id": "text",
        "audit": {},
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "pending": {
      "at": "2025-01-23T20:58:56.858Z",
      "by": {
        "id": "text",
        "audit": {},
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "unpublished": {
      "at": "2025-01-23T20:58:56.858Z",
      "by": {
        "id": "text",
        "audit": {},
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "href": "text",
  "name": "text",
  "shortDescription": "text",
  "longDescription": "text",
  "externalIds": {
    "operations": "text"
  },
  "website": "text",
  "icon": "text",
  "status": "text",
  "vendor": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-01-23T20:58:56.858Z",
        "by": {
          "id": "text",
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "updated": {
        "at": "2025-01-23T20:58:56.858Z",
        "by": {
          "id": "text",
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "href": "text",
    "externalId": "text",
    "externalName": "text",
    "type": "Client",
    "status": "Active",
    "serviceLevel": "Express",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "icon": "text",
    "technicalSupportEmail": "[e-mail]",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-01-23T20:58:56.858Z",
            "by": {
              "id": "text",
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "href": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "updated": {
            "at": "2025-01-23T20:58:56.858Z",
            "by": {
              "id": "text",
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "href": "text",
              "name": "text",
              "icon": "text"
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "description": "text",
        "modules": [
          {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-01-23T20:58:56.858Z",
                "by": {
                  "id": "text",
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              },
              "updated": {
                "at": "2025-01-23T20:58:56.858Z",
                "by": {
                  "id": "text",
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "description": "text",
            "name": "text",
            "accountTypes": [
              "text"
            ],
            "filters": {
              "group.buyers": [
                "text"
              ]
            },
            "settings": {
              "sharedAccount": false,
              "configurable": false,
              "default": false,
              "paid": false,
              "type": [
                "text"
              ]
            }
          }
        ],
        "logo": "text",
        "isDefault": false,
        "users": [
          {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-01-23T20:58:56.858Z",
                "by": {
                  "id": "text",
                  "audit": {},
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              },
              "updated": {
                "at": "2025-01-23T20:58:56.858Z",
                "by": {
                  "id": "text",
                  "audit": {},
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              },
              "invitationAcceptedAt": "2025-01-23T20:58:56.858Z"
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "email": "text",
            "status": "text",
            "phone": {
              "prefix": "text",
              "number": "text"
            },
            "firstName": "text",
            "lastName": "text",
            "icon": "text",
            "lastLoginAt": "2025-01-23T20:58:56.858Z",
            "settings": {
              "cultureCode": "text",
              "languageCode": "text"
            },
            "name": "text",
            "accounts": []
          }
        ],
        "buyers": [
          {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-01-23T20:58:56.858Z",
                "by": {
                  "id": "text",
                  "audit": {},
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              },
              "updated": {
                "at": "2025-01-23T20:58:56.858Z",
                "by": {
                  "id": "text",
                  "audit": {},
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              },
              "activated": {
                "at": "2025-01-23T20:58:56.858Z",
                "by": {
                  "id": "text",
                  "audit": {},
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              },
              "unassigned": {
                "at": "2025-01-23T20:58:56.858Z",
                "by": {
                  "id": "text",
                  "audit": {},
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "contact": {
              "name": "text",
              "firstName": "text",
              "lastName": "text",
              "email": "[e-mail]",
              "phone": {
                "prefix": "text",
                "number": "text"
              },
              "user": {
                "id": "text",
                "audit": {
                  "created": {
                    "at": "2025-01-23T20:58:56.858Z",
                    "by": {
                      "id": "text",
                      "audit": {},
                      "$meta": {
                        "omitted": [
                          "text"
                        ]
                      },
                      "href": "text",
                      "name": "text",
                      "icon": "text"
                    }
                  },
                  "updated": {
                    "at": "2025-01-23T20:58:56.858Z",
                    "by": {
                      "id": "text",
                      "audit": {},
                      "$meta": {
                        "omitted": [
                          "text"
                        ]
                      },
                      "href": "text",
                      "name": "text",
                      "icon": "text"
                    }
                  },
                  "invitationAcceptedAt": "2025-01-23T20:58:56.858Z"
                },
                "$meta": {
                  "omitted": [
                    "text"
                  ]
                },
                "href": "text",
                "email": "text",
                "status": "text",
                "phone": {
                  "prefix": "text",
                  "number": "text"
                },
                "firstName": "text",
                "lastName": "text",
                "icon": "text",
                "lastLoginAt": "2025-01-23T20:58:56.858Z",
                "settings": {
                  "cultureCode": "text",
                  "languageCode": "text"
                },
                "name": "text",
                "accounts": []
              },
              "type": "text"
            },
            "externalIds": {
              "erpCompanyContact": "text",
              "erpCustomer": "text",
              "accountExternalId": "text"
            },
            "status": "Active",
            "icon": "text",
            "address": {
              "addressLine1": "text",
              "addressLine2": "text",
              "postCode": "text",
              "city": "text",
              "state": "text",
              "country": "text"
            },
            "taxId": "text",
            "name": "text",
            "errors": [
              {
                "id": "text",
                "message": "text"
              }
            ],
            "sellers": [
              {
                "id": "text",
                "audit": {
                  "created": {
                    "at": "2025-01-23T20:58:56.858Z",
                    "by": {
                      "id": "text",
                      "$meta": {
                        "omitted": [
                          "text"
                        ]
                      },
                      "href": "text",
                      "name": "text",
                      "icon": "text"
                    }
                  },
                  "updated": {
                    "at": "2025-01-23T20:58:56.858Z",
                    "by": {
                      "id": "text",
                      "$meta": {
                        "omitted": [
                          "text"
                        ]
                      },
                      "href": "text",
                      "name": "text",
                      "icon": "text"
                    }
                  }
                },
                "$meta": {
                  "omitted": [
                    "text"
                  ]
                },
                "href": "text",
                "externalId": "text",
                "status": "Active",
                "icon": "text",
                "currencies": [
                  "text"
                ],
                "address": {
                  "addressLine1": "text",
                  "addressLine2": "text",
                  "postCode": "text",
                  "city": "text",
                  "state": "text",
                  "country": "text"
                },
                "name": "text"
              }
            ]
          }
        ]
      }
    ]
  },
  "settings": {
    "productOrdering": false,
    "productRequests": {
      "enabled": false,
      "name": "text",
      "label": "text"
    },
    "itemSelection": false,
    "orderQueueChanges": false,
    "preValidation": {
      "purchaseOrderDraft": false,
      "purchaseOrderQuerying": false,
      "changeOrderDraft": false,
      "terminationOrder": false,
      "productRequest": false
    },
    "splitBilling": {
      "enabled": false,
      "type": "text"
    }
  },
  "statistics": {
    "itemCount": 0,
    "ordersPlacedCount": 0,
    "agreementCount": 0,
    "subscriptionCount": 0,
    "requestCount": 0
  }
}