Update product settings

Update a product’s setting.

PUT/v1/products/{id}/settings

Path parameters

id*string

Body

productOrderingnullable boolean

productRequestsProductRequestsInput (object)

itemSelectionnullable boolean

orderQueueChangesnullable boolean

preValidationPreValidationInput (object)

Response

Success

Body

idstring

auditQueryModelAudit (object)

$metaQueryModelMetadata (object)

hrefstring

namestring

shortDescriptionnullable string

longDescriptionnullable string

externalIdsProductExternalIdBag (object)

websitestring

iconRelativeInternalUrl (object)

statusstring

vendorAccountQueryModel (object)

settingsProductSettings (object)

statisticsProductStatistics (object)

Request

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

Response

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2024-06-26T04:20:02.130Z",
      "by": {
        "id": "text",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2024-06-26T04:20:02.130Z",
      "by": {
        "id": "text",
        "$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": {
    "path": "text",
    "apiVersion": "text"
  },
  "status": "text",
  "vendor": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2024-06-26T04:20:02.130Z",
        "by": {
          "id": "text",
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "updated": {
        "at": "2024-06-26T04:20:02.130Z",
        "by": {
          "id": "text",
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "href": "text",
    "externalId": "text",
    "externalName": "text",
    "type": "text",
    "status": "text",
    "serviceLevel": "text",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "icon": {
      "path": "text",
      "apiVersion": "text"
    },
    "technicalSupportEmail": "name@gmail.com",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      {
        "id": "text",
        "audit": {
          "created": {
            "at": "2024-06-26T04:20:02.130Z",
            "by": {
              "id": "text",
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "href": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "updated": {
            "at": "2024-06-26T04:20:02.130Z",
            "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": "2024-06-26T04:20:02.130Z",
                "by": {
                  "id": "text",
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              },
              "updated": {
                "at": "2024-06-26T04:20:02.130Z",
                "by": {
                  "id": "text",
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "description": "text",
            "isConfigurable": false,
            "isEnabledByDefault": false,
            "name": "text",
            "accountTypes": [
              "text"
            ]
          }
        ],
        "logo": "text",
        "isDefault": false,
        "users": [
          {
            "id": "text",
            "audit": {
              "created": {
                "at": "2024-06-26T04:20:02.130Z",
                "by": {
                  "id": "text",
                  "audit": {},
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              },
              "updated": {
                "at": "2024-06-26T04:20:02.130Z",
                "by": {
                  "id": "text",
                  "audit": {},
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              },
              "invitationAcceptedAt": "2024-06-26T04:20:02.130Z"
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "email": "text",
            "status": "text",
            "phone": {
              "prefix": "text",
              "number": "text"
            },
            "firstName": "text",
            "lastName": "text",
            "icon": "text",
            "lastLoginAt": "2024-06-26T04:20:02.130Z",
            "settings": {
              "cultureCode": "text",
              "languageCode": "text"
            },
            "name": "text",
            "accounts": []
          }
        ]
      }
    ],
    "buyers": [
      {
        "id": "text",
        "audit": {
          "created": {
            "at": "2024-06-26T04:20:02.130Z",
            "by": {
              "id": "text",
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "href": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "updated": {
            "at": "2024-06-26T04:20:02.130Z",
            "by": {
              "id": "text",
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "href": "text",
              "name": "text",
              "icon": "text"
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "contact": {
          "name": "text",
          "firstName": "text",
          "lastName": "text",
          "email": "name@gmail.com",
          "phone": {
            "prefix": "text",
            "number": "text"
          },
          "user": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2024-06-26T04:20:02.130Z",
                "by": {
                  "id": "text",
                  "audit": {},
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              },
              "updated": {
                "at": "2024-06-26T04:20:02.130Z",
                "by": {
                  "id": "text",
                  "audit": {},
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              },
              "invitationAcceptedAt": "2024-06-26T04:20:02.130Z"
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "email": "text",
            "status": "text",
            "phone": {
              "prefix": "text",
              "number": "text"
            },
            "firstName": "text",
            "lastName": "text",
            "icon": "text",
            "lastLoginAt": "2024-06-26T04:20:02.130Z",
            "settings": {
              "cultureCode": "text",
              "languageCode": "text"
            },
            "name": "text",
            "accounts": []
          },
          "type": "text"
        },
        "externalIds": {
          "erpCompanyContact": "text",
          "erpCustomer": "text"
        },
        "status": "text",
        "icon": "text",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "taxId": "text",
        "name": "text",
        "sellers": [
          {
            "id": "text",
            "audit": {
              "created": {
                "at": "2024-06-26T04:20:02.130Z",
                "by": {
                  "id": "text",
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              },
              "updated": {
                "at": "2024-06-26T04:20:02.130Z",
                "by": {
                  "id": "text",
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "externalId": "text",
            "status": "text",
            "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
    }
  },
  "statistics": {}
}

PreviousUnpublish product NextParameter Group

Last updated 1 month ago

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

{ "id": "text", "audit": { "created": { "at": "2024-06-26T04:20:02.130Z", "by": { "id": "text", "$meta": { "omitted": [ "text" ] }, "href": "text", "name": "text", "icon": "text" } }, "updated": { "at": "2024-06-26T04:20:02.130Z", "by": { "id": "text", "$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": { "path": "text", "apiVersion": "text" }, "status": "text", "vendor": { "id": "text", "audit": { "created": { "at": "2024-06-26T04:20:02.130Z", "by": { "id": "text", "$meta": { "omitted": [ "text" ] }, "href": "text", "name": "text", "icon": "text" } }, "updated": { "at": "2024-06-26T04:20:02.130Z", "by": { "id": "text", "$meta": { "omitted": [ "text" ] }, "href": "text", "name": "text", "icon": "text" } } }, "$meta": { "omitted": [ "text" ] }, "href": "text", "externalId": "text", "externalName": "text", "type": "text", "status": "text", "serviceLevel": "text", "address": { "addressLine1": "text", "addressLine2": "text", "postCode": "text", "city": "text", "state": "text", "country": "text" }, "icon": { "path": "text", "apiVersion": "text" }, "technicalSupportEmail": "name@gmail.com", "website": "text", "description": "text", "name": "text", "groups": [ { "id": "text", "audit": { "created": { "at": "2024-06-26T04:20:02.130Z", "by": { "id": "text", "$meta": { "omitted": [ "text" ] }, "href": "text", "name": "text", "icon": "text" } }, "updated": { "at": "2024-06-26T04:20:02.130Z", "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": "2024-06-26T04:20:02.130Z", "by": { "id": "text", "$meta": { "omitted": [ "text" ] }, "href": "text", "name": "text", "icon": "text" } }, "updated": { "at": "2024-06-26T04:20:02.130Z", "by": { "id": "text", "$meta": { "omitted": [ "text" ] }, "href": "text", "name": "text", "icon": "text" } } }, "$meta": { "omitted": [ "text" ] }, "href": "text", "description": "text", "isConfigurable": false, "isEnabledByDefault": false, "name": "text", "accountTypes": [ "text" ] } ], "logo": "text", "isDefault": false, "users": [ { "id": "text", "audit": { "created": { "at": "2024-06-26T04:20:02.130Z", "by": { "id": "text", "audit": {}, "$meta": { "omitted": [ "text" ] }, "href": "text", "name": "text", "icon": "text" } }, "updated": { "at": "2024-06-26T04:20:02.130Z", "by": { "id": "text", "audit": {}, "$meta": { "omitted": [ "text" ] }, "href": "text", "name": "text", "icon": "text" } }, "invitationAcceptedAt": "2024-06-26T04:20:02.130Z" }, "$meta": { "omitted": [ "text" ] }, "href": "text", "email": "text", "status": "text", "phone": { "prefix": "text", "number": "text" }, "firstName": "text", "lastName": "text", "icon": "text", "lastLoginAt": "2024-06-26T04:20:02.130Z", "settings": { "cultureCode": "text", "languageCode": "text" }, "name": "text", "accounts": [] } ] } ], "buyers": [ { "id": "text", "audit": { "created": { "at": "2024-06-26T04:20:02.130Z", "by": { "id": "text", "$meta": { "omitted": [ "text" ] }, "href": "text", "name": "text", "icon": "text" } }, "updated": { "at": "2024-06-26T04:20:02.130Z", "by": { "id": "text", "$meta": { "omitted": [ "text" ] }, "href": "text", "name": "text", "icon": "text" } } }, "$meta": { "omitted": [ "text" ] }, "href": "text", "contact": { "name": "text", "firstName": "text", "lastName": "text", "email": "name@gmail.com", "phone": { "prefix": "text", "number": "text" }, "user": { "id": "text", "audit": { "created": { "at": "2024-06-26T04:20:02.130Z", "by": { "id": "text", "audit": {}, "$meta": { "omitted": [ "text" ] }, "href": "text", "name": "text", "icon": "text" } }, "updated": { "at": "2024-06-26T04:20:02.130Z", "by": { "id": "text", "audit": {}, "$meta": { "omitted": [ "text" ] }, "href": "text", "name": "text", "icon": "text" } }, "invitationAcceptedAt": "2024-06-26T04:20:02.130Z" }, "$meta": { "omitted": [ "text" ] }, "href": "text", "email": "text", "status": "text", "phone": { "prefix": "text", "number": "text" }, "firstName": "text", "lastName": "text", "icon": "text", "lastLoginAt": "2024-06-26T04:20:02.130Z", "settings": { "cultureCode": "text", "languageCode": "text" }, "name": "text", "accounts": [] }, "type": "text" }, "externalIds": { "erpCompanyContact": "text", "erpCustomer": "text" }, "status": "text", "icon": "text", "address": { "addressLine1": "text", "addressLine2": "text", "postCode": "text", "city": "text", "state": "text", "country": "text" }, "taxId": "text", "name": "text", "sellers": [ { "id": "text", "audit": { "created": { "at": "2024-06-26T04:20:02.130Z", "by": { "id": "text", "$meta": { "omitted": [ "text" ] }, "href": "text", "name": "text", "icon": "text" } }, "updated": { "at": "2024-06-26T04:20:02.130Z", "by": { "id": "text", "$meta": { "omitted": [ "text" ] }, "href": "text", "name": "text", "icon": "text" } } }, "$meta": { "omitted": [ "text" ] }, "href": "text", "externalId": "text", "status": "text", "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 } }, "statistics": {} }