validateProducts | BigCommerce Developer Center

query ExampleQuery($products: [ValidateProductInputType], $channelId: Int, $storeHash: String, $target: String) {
  validateProducts(products: $products, channelId: $channelId, storeHash: $storeHash, target: $target) {
    isValid
    products {
      responseType
      message
      errorCode
      product
    }
  }
}

{
  "products": [
    {
      "productId": 0,
      "variantId": 0,
      "quantity": 0,
      "productOptions": [
        "GenericScalar"
      ]
    }
  ],
  "channelId": 0,
  "storeHash": "example",
  "target": "QUOTE"
}

{
  "data": {
    "validateProducts": {
      "isValid": true,
      "products": [
        {
          "responseType": "example",
          "message": "example",
          "errorCode": "example",
          "product": {
            "productId": null,
            "variantId": null,
            "sku": null,
            "availableToSell": null,
            "unlimitedBackorder": null
          }
        }
      ]
    }
  }
}

Arguments

productslist of optional ObjectsRequired

Products list to validate

channelIdIntegerOptional

Channel ID

storeHashStringOptional

Store hash

targetStringOptional

Validation target: ‘CART’ or ‘QUOTE’ (default). Controls whether OOS/Non-Purchasable products return errors or warnings.

Returns

an optional Object

isValidBoolean

Whether the general validation was successful.

productslist of optional Objects

Validation details of each product.