Actions25
- Coupon Actions
- Customer Actions
- Customer Form Field Values Actions
- Customer Address Actions
- Customer Group Actions
- Line Items Actions
- Order Actions
- Order Shipping Address Actions
- Order Shipment Actions
- Product Actions
- Refunds Actions
- Subscriber Actions
- Variant Actions
Product → Get All
AI-generatedOverview
This node interacts with the BigCommerce API to retrieve all products with pagination and optional custom properties. It is useful for scenarios where users need to fetch a list of products from their BigCommerce store, such as for inventory management, reporting, or synchronization with other systems. For example, a user can fetch the first 25 products or specify a different page and limit to control the amount of data retrieved.
Use Case Examples
- Fetch the first 25 products from a BigCommerce store.
- Retrieve products from page 2 with a limit of 50 products per page.
- Add custom properties to the product data request to tailor the output based on specific API documentation.
Properties
| Name | Meaning |
|---|---|
| Page | The page number of product data to retrieve, allowing pagination through product listings. |
| Limit | The maximum number of products to retrieve per request, controlling the size of the returned dataset. |
| Custom Properties | Additional custom properties to include in the product data request, allowing users to specify extra fields based on BigCommerce API documentation. |
Output
JSON
id- Unique identifier of the product.name- Name of the product.price- Price of the product.description- Description of the product.customProperties- Any additional custom properties included in the request and returned in the product data.
Dependencies
- BigCommerce API access with appropriate API key credentials
Troubleshooting
- Ensure the BigCommerce API credentials are correctly configured and have the necessary permissions to access product data.
- Verify that the page and limit values are within the allowed ranges (page: 1-100, limit: 25-250).
- Check the custom properties names and values against the BigCommerce API documentation to avoid invalid requests.
- Common error: 'The resource "products" is not known!' indicates an incorrect resource name; ensure 'products' is selected as the resource.
Links
- BigCommerce Products API Documentation - Official documentation for the BigCommerce Products API, useful for understanding available properties and request parameters.