This topic describes the custom options fields for catalog uploads and includes a sample csv template and provides details on multi-lingual support in custom options.
Catalog Upload - Custom Options
Full or Delta Load Accommodated
Custom Options may be a full or delta upload.
Delta Upload Behavior
A delta upload allows supplier import of additional or updated custom options for products that exist in the system.
A delta import of custom options is handled as described below.
If the SKU does not exist in the system or is empty, a warning should be generated and the line should be skipped.
-
If the SKU does exist, for each valid SKU in the file:
-
if the product has existing custom options
replace the existing custom options with the values in the file. For example: If a SKU A has 4 custom options associated to it and the file has 2, the 2 in the file will now be associated to it instead of the 4.
if the product does not have existing custom options, add the ones in the file to the product.
-
Custom Options Upload Template
Custom Options Multi-lingual Sample File
CustomOptionsMultilingualSample.csv
Custom Options Fields Details
| Column Name | Description | Required | Max Length | Sample Value |
|
part_number |
This is the Supplier's part number.
Use the part number that your customer would search for. |
Yes |
40 |
ABC123 |
|
custom_option_title |
This is the Title or Description of the option
The option title will be displayed below the heading. Clear description is advised. |
Yes |
40 |
Color |
|
custom_option_type |
The Custom Option Type is one of the following: (Checkbox, Radio Button, Dropdown, Text Box) |
Yes |
N/A |
Dropdown |
|
custom_option_value |
This is the Value of the option in the type
Option value is displayed as the option for the given type. One option value goes in each row. |
Yes |
255 |
Red |
|
custom_option_is_required |
This determines if the custom option is required (Yes=1 or No=0)
Set to No by default. |
No |
1 digit |
1 |
|
custom_option_sku |
This is the SKU for each option. Additional SKU to be appended to the end of the product SKU.
Not required, but recommended. |
No |
40 |
RD |
|
custom_option_price |
This is the price of the upcharge |
No |
2 Decimal Places |
0.00 |
|
custom_option_price_type |
This allows you to specify if the optional price is fixed or a percent of the actual product. (Fixed=1or Percent= 0) |
No |
N/A |
1 |
|
custom_option_sort_order |
This is the sort order for the custom option |
No |
N/A |
1 |
|
custom_option_value_sort |
This is the display order for the values of the custom option |
No |
N/A |
3 |
|
custom_option_title_<store view code> |
Relevant only when catalog is being loaded into a multi- lingual environment.
This is the Title or Description of the option followed by the storeview code representing the language code
<store view> features this format: <language code>_<region code> |
No |
40 |
Terminer |
|
custom_option_value_<store view code> |
Relevant only when catalog is being loaded into a multi- lingual environment.
This is the value of the option in the type followed by the storeview code which represents the language code
<store view> features this format: <language code>_<region code> |
No |
N/A |
Argent |
Custom Options Validation and Change Reports
The table below provides details on the validation and change reports generated based on file status.
Generation of reports applies to both Full and Delta uploads.
|
File Status |
Reason (If Status is Failed) | Validation Report is Created | Change Report is Created |
|
Failed |
A file of the same type is being processed by the system | ||
| Failed | File failed validation | Y | |
| Failed | File failed to be updated due to system issues | Y | |
| Processed Successfully | Y | Y |
Multi-lingual Custom Options
There are two values that support product information in additional languages in the Custom Options file:
- custom_option_title
- custom_option_value
These language-specific columns are added at the end of the Custom Options file. There is no limit to the number of language specific columns that can be added.
|
Custom Option Value Stock Management and Storefront Validation (Added in Release 16.4.0)
Overview
Starting in BuyerQuest Release 16.4.0, custom option value stock availability can be maintained through the existing Custom Options Catalog Import process and enforced during product configuration and ordering.
This enhancement introduces support for maintaining stock availability at the individual custom option value level and provides optional storefront validation that prevents buyers from ordering custom option values marked as unavailable.
Together, these enhancements allow catalog administrators to:
- Maintain custom option availability in bulk through catalog imports.
- Mark individual custom option values as available or unavailable.
- Prevent buyers from selecting unavailable custom option values.
- Block Add to Cart and checkout actions when out-of-stock custom option values are used.
- Ensure consistent validation across storefront, cart, checkout, imports, and reorder flows.
Business Case
Many organizations sell configurable products where specific option values may become temporarily unavailable while the parent product remains available for purchase.
Examples include:
- Clothing sizes that are temporarily unavailable.
- Product colors that are discontinued.
- Equipment configurations awaiting replenishment.
- Region-specific product variations that cannot currently be fulfilled.
Prior to Release 16.4.0, custom option values could be marked as unavailable administratively, but buyers could still order them as long as the parent product remained in stock.
This enhancement enables organizations to maintain option-level inventory availability and prevent invalid product configurations from entering the purchasing process.
Custom Option Stock Maintenance Through Catalog Import
New Optional Import Field
A new optional column is available in the existing Custom Options Catalog Upload file:
| Field Name |
|---|
| custom_option_in_stock |
This field applies to individual custom option values and does not apply to:
- The parent product
- The entire custom option group
Each custom option value can have its own availability status.
Supported Values
The field supports the following values:
| Value | Result |
|---|---|
| 1 | In Stock |
| Yes | In Stock |
| 0 | Out of Stock |
| No | Out of Stock |
Value matching is case-insensitive.
Examples:
- Yes
- YES
- yes
- No
- NO
- no
are all supported.
Default Behavior
If the custom_option_in_stock column is not included in the import file:
| Behavior |
|---|
| Custom option value defaults to In Stock = Yes |
This preserves backward compatibility with existing catalog files.
Backward Compatibility
Existing Custom Options catalog files continue to import successfully without modification.
The new field is optional and does not impact existing uploads that do not include the column.
Custom Options Template Updates
The existing Custom Options template has been enhanced to include:
| New Column |
|---|
| custom_option_in_stock |
Documentation for the template should indicate:
- The field controls stock availability at the custom option value level.
- Accepted values are:
- 1
- 0
- Yes
- No
- The field is optional.
- Missing values default to In Stock = Yes.
- The field is not multilingual.
Multilingual Support
Custom option titles and values continue to support multilingual columns where applicable.
Stock availability is language-independent and uses only:
| Field |
|---|
| custom_option_in_stock |
No language-specific stock columns are supported.
Downloaded Custom Options Files
When downloading current Custom Options data from Catalog Management, the exported file now includes:
| Field |
|---|
| custom_option_in_stock |
This allows catalog teams to use exported files as a starting point for maintenance and re-import activities.
Full and Delta Upload Support
The enhancement works with all existing Custom Options maintenance methods, including:
- Full Custom Options uploads
- Delta Custom Options uploads
- FTP-based Custom Options processing
- Catalog upload screens
No new upload type is required.
Important Delta Upload Behavior
The existing Custom Options delta behavior remains unchanged.
If a SKU already contains custom options and a delta upload is processed:
- Existing custom options for that SKU are replaced by the rows contained in the uploaded file.
- Catalog teams should provide the complete desired custom option set for that SKU.
When updating stock values through a delta upload, do not submit only the changed row unless replacement of the remaining option values is intended.
Storefront Validation Configuration
The imported stock value is stored regardless of storefront validation settings.
Whether ordering is blocked depends on a new configuration.
Navigation
Go to:
System Administration → Settings and Configurations → Manage System Configurations → Marketplace Configuration → General Configuration
Configuration Section
Custom Option Stock Validation
Configuration Field
| Field |
|---|
| Enable Custom Option Value Stock Validation |
| Type | Values | Default |
|---|---|---|
| Dropdown | Yes / No | No |
Configuration Behavior
Yes
When enabled:
- Custom option values marked In Stock = No are treated as unavailable.
- Buyers cannot select unavailable values.
- Add to Cart validation is enforced.
- Cart validation is enforced.
- Checkout validation is enforced.
No
When disabled:
- Parent product stock continues to determine orderability.
- Custom option value stock remains informational only.
- Buyers can continue ordering unavailable custom option values.
Configuration Note
When enabled, Product configuration and Add to Cart validation will treat Custom Option values with In Stock = No as unavailable.
Buyer Experience
Product Configuration
When storefront validation is enabled:
BuyerQuest evaluates custom option value availability during product configuration.
Dropdown Custom Options
Unavailable values:
- Remain visible.
- Cannot be selected.
- Display the suffix:
- Out of Stock
Radio Button and Checkbox Options
Unavailable values:
- Remain visible.
- Cannot be selected.
- Display:
Out of Stock
next to the option value.
Required Options With No Available Values
If a required custom option contains only unavailable values:
- The option remains visible.
- All values remain visible but disabled.
- Buyers see a message similar to:
No in-stock values are available.
Add to Cart Validation
The storefront prevents buyers from selecting unavailable values.
In addition, BuyerQuest performs server-side validation before adding items to the cart.
This protects against:
- Stale browser sessions
- Browser manipulation
- Saved URLs
- Direct requests
- Non-UI submissions
If an unavailable custom option value is submitted:
- The item is not added to the cart.
- The cart remains unchanged.
Example message:
The selected option Size: S/M is out of stock and cannot be added to cart.
Whenever possible, the validation message identifies the exact option and value that caused the failure.
Cart and Checkout Revalidation
BuyerQuest continuously validates configured products after they have been added to the cart.
Validation occurs during:
- Cart page load
- Checkout entry
- Checkout submission
If a selected custom option value becomes unavailable after the item was added to the cart:
- Checkout is blocked.
- Request submission is blocked.
- Buyers must update or remove the item.
Example message:
This item contains an out-of-stock configuration. Please update the selected option(s) or remove the item.
Supported Ordering Flows
When storefront validation is enabled, validation applies across all supported configuration and ordering flows, including:
- Product Details Page → Add to Cart
- Quick View / Configure → Add to Cart
- Search Results Configure → Add to Cart
- Quick Order configuration for products with custom options
- Saved Shopping List Add to Cart
- Reorder functionality
- Bundle configuration when bundled products contain custom options
Parent Product Stock Validation
This enhancement does not replace existing product-level stock validation.
Parent product stock remains the primary inventory validation.
Custom option value stock validation acts as an additional validation layer for configurable products.
Validation Reports and Change Reports
Catalog reporting has been enhanced to support custom option stock maintenance.
Validation Reports
Validation reports identify:
- Invalid custom_option_in_stock values
- Skipped records
- Import errors
The report includes:
- Affected row
- Column name
- Invalid value
Change Reports
Change reports show stock-related updates, including:
- In Stock → Out of Stock
- Out of Stock → In Stock
changes for custom option values.
FTP Processing
Where FTP-based Custom Options uploads are supported, the custom_option_in_stock field is processed through the existing Custom Options upload process.
No FTP configuration changes are required.
Troubleshooting
If buyers cannot order a custom option value, administrators should verify:
- The custom option value's In Stock status.
- The imported custom_option_in_stock value.
- The Enable Custom Option Value Stock Validation configuration.
- Catalog validation and change reports.
Support teams can use:
- Catalog file status
- Validation reports
- Change reports
- System logs
to determine why a specific custom option configuration was rejected.
For troubleshooting purposes, validation logging may include:
- Product SKU
- Custom Option Title
- Custom Option Value
- User ID (when available)
- Site or Store context
Keywords: Custom Options Import, Custom Option Stock Validation, custom_option_in_stock, Catalog Upload, Delta Upload, Full Upload, Product Configuration, Add to Cart Validation, Out of Stock Options, Custom Option Availability, Catalog Management, Storefront Validation, Product Options, Configurable Products, Release 16.4.0
Comments
0 comments
Article is closed for comments.