BigCommerce Docs

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 ValidateProductInputTypeRequired

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 ValidateProductsType

isValidBoolean

Whether the general validation was successful.

productslist of optional ValidateProductType

Validation details of each product.

1	query ExampleQuery($products: [ValidateProductInputType], $channelId: Int, $storeHash: String, $target: String) {
2	validateProducts(products: $products, channelId: $channelId, storeHash: $storeHash, target: $target) {
3	isValid
4	products {
5	responseType
6	message
7	errorCode
8	product
9	}
10	}
11	}

1	{
2	"products": [
3	{
4	"productId": 0,
5	"variantId": 0,
6	"quantity": 0,
7	"productOptions": [
8	"GenericScalar"
9	]
10	}
11	],
12	"channelId": 0,
13	"storeHash": "example",
14	"target": "QUOTE"
15	}

1	{
2	"data": {
3	"validateProducts": {
4	"isValid": true,
5	"products": [
6	{
7	"responseType": "example",
8	"message": "example",
9	"errorCode": "example",
10	"product": {
11	"productId": null,
12	"variantId": null,
13	"sku": null,
14	"availableToSell": null,
15	"unlimitedBackorder": null
16	}
17	}
18	]
19	}
20	}
21	}