validateProduct | BigCommerce Developer Center

query ExampleQuery($productId: Int, $variantId: Int, $quantity: Int, $productOptions: [GenericScalar], $storeHash: String, $channelId: Int, $target: String) {
  validateProduct(productId: $productId, variantId: $variantId, quantity: $quantity, productOptions: $productOptions, storeHash: $storeHash, channelId: $channelId, target: $target) {
    responseType
    message
    errorCode
    product {
      productId
      variantId
      sku
      availableToSell
      unlimitedBackorder
    }
  }
}

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

{
  "data": {
    "validateProduct": {
      "responseType": "example",
      "message": "example",
      "errorCode": "example",
      "product": {
        "productId": 0,
        "variantId": 0,
        "sku": "example",
        "availableToSell": 0,
        "unlimitedBackorder": true
      }
    }
  }
}

Arguments

productIdIntegerRequired

Product ID

variantIdIntegerRequired

Variant ID

quantityIntegerRequired

Quantity

productOptionslist of optional GenericScalarOptional

Product options list

storeHashStringOptional

Store hash

channelIdIntegerOptional

Channel ID

targetStringOptional

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

Returns

an optional Object

responseTypeString

The type of response returned. Possible values are SUCCESS | WARNING | ERROR.

messageString

The message returned if the product is not valid.

errorCodeString

The error code returned if the product is not valid. Possible values are NON_PURCHASABLE | OOS | INVALID_FIELDS | OTHER.

productObject

Details of the product