BigCommerce Check Product Stock

Searches the BigCommerce catalog for a product by name and returns its stock level, availability and pre-order flag. Uses the BigCommerce module connection.

What it does

  • Searches the BigCommerce catalog for products by name, using BigCommerce's name filter.
  • Returns the first product whose name contains the Product Name input, ignoring upper and lower case.
  • Returns the matching product's stock level, availability and pre-order flag, plus the full product object.

Notes

  • Authentication: the action uses the BigCommerce module connection only. It reads the auth header (X-Auth-Token) and the Store Key field from the connection. The action has no credential inputs.
  • The connection's API token needs the Products read scope.
  • The Store Key can contain only letters and digits. If the connection has no valid Store Key, the action fails with a "The BigCommerce connection has no valid Store Key field" error and makes no request to BigCommerce.
  • If no BigCommerce connection is set on the action, it fails with a "Missing BigCommerce connection" error.
  • A product that isn't found still counts as a successful search: Success is true and Item Found is false. Check Item Found before using the stock outputs.
  • The action treats some BigCommerce replies as errors, not as "not found" or a stock level of 0:
    • A reply that isn't a list of named products.
    • A matched product with a missing or invalid inventory_level, availability or is_preorder_only field.
  • Stock Level is the product's inventory_level for the default location. It applies only when stock is tracked by product. Check inventory_tracking in Item Details to confirm.
  • Pre-order Only is BigCommerce's is_preorder_only flag. It shows whether BigCommerce removes the product's pre-order status automatically on the release date. To check whether a product is on pre-order now, check whether Availability is preorder.
  • Error messages include only the HTTP status code. They never include BigCommerce's response body or the access token.
  • Safe Mode: when enabled, the action returns errors in outputs instead of stopping the flow.

Inputs

NameTypeDescription
Product NameStringProduct name to look up, as plain text (spaces are allowed). The action returns the first product whose name contains this value, ignoring upper and lower case
Safe ModeBoolean (optional)If true, errors go to outputs instead of stopping the flow. Defaults to false

Outputs

NameTypeDescription
SuccessBooleanWhether the catalog search worked. Also true when the product isn't found, so check Item Found
Item FoundBooleanWhether a product with this name exists in the catalog
Item DetailsObjectThe matching BigCommerce product object. Empty when the product isn't found
Stock LevelNumberThe product's inventory_level for the default location. Applies only when stock is tracked by product. 0 when the product isn't found
AvailabilityStringThe product's availability: available, disabled or preorder. Empty when the product isn't found
Pre-order OnlyBooleanThe product's is_preorder_only flag: whether BigCommerce removes its pre-order status automatically on the release date
Error MessageStringError details when Safe Mode is enabled and the action fails

API reference


Did this page help you?