Skip to content

Commit 45a6393

Browse files
DEVDOCS-6713 - Clarify resourceId construction from filterName in product filter translations (#1244)
<!-- Ticket number or summary of work --> # [DEVDOCS-6713] ## What changed? <!-- Provide a bulleted list in the present tense --> * Clarify that `resourceId` values are constructed from `filterName` values in the product filter translations query section * Add concrete example showing how `brand` `filterName` becomes `bc/store/productFilters/brand` `resourceId` * Update callout and description to explicitly explain the relationship between `filterName` and `resourceId` ## Release notes draft <!-- Provide an entry for the release notes using simple, conversational language. Don't be too technical. Explain how the change will benefit the merchant and link to the feature. Examples: * The newly-released [X feature] is now available to use. Now, you'll be able to [perform Y action]. * We're happy to announce [X feature], which can help you [perform Y action]. * [X feature] helps you to create [Y response] using the [Z query parameter]. Now, you can deliver [ex, localized shopping experiences for your customers]. * Fixed a bug in the [X endpoint]. Now the [Y field] will appear when you click [Z option]. --> * Improved clarity in the product filter translations documentation. The query section now clearly explains how to construct `resourceId` values from `filterName` values, making it easier to query translations for specific product filters. ## Anything else? <!-- Add related PRs, salient notes, additional ticket numbers, etc. --> This change resolves confusion about the relationship between `filterName` and `resourceId` when querying product filter translations. ping @jamesqquick @bc-terra [DEVDOCS-6713]: https://bigcommercecloud.atlassian.net/browse/DEVDOCS-6713?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: Terra Hyde <terra.hyde@bigcommerce.com>
1 parent b351ec8 commit 45a6393

1 file changed

Lines changed: 2 additions & 8 deletions

File tree

docs/store-operations/translations/filters.mdx

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,6 @@ The product filter translatable fields are:
1919
| Category, Brand, Variants, Custom Fields, Price, Rating | Display Name as the field name (e.g. `brand` or `category`) |
2020
| Other Filters | Display Name as `display_name` <br /> Has Free Shipping as `has_free_shipping` <br /> Is Featured as `is_featured` <br /> In Stock as `in_stock` |
2121

22-
<Callout type='warning'>
23-
While most translatable entities use a `resourceId` format of `bc/store/{{type}}/{id}}`, product filters use a different format.
24-
25-
Use `bc/store/ProductFilters/{filterName}`, using the filters above for reference.
26-
</Callout>
27-
2822
<Callout type='info'>
2923
Only string values are translatable. Numeric content such as product count or price values are not translatable.
3024
</Callout>
@@ -97,10 +91,10 @@ query {
9791
### Query a translation by `resourceId`
9892

9993
<Callout type='warning'>
100-
When querying a translation by `resourceId`, you must provide the full `resourceId` in the format `bc/store/product-filter/{filter_id}`.
94+
When querying by `resourceId`, the `resourceId` value must be constructed from the `filterName` using the format `bc/store/productFilters/{filterName}`. For example, the `filterName` `brand` becomes the `resourceId` `bc/store/productFilters/brand`.
10195
</Callout>
10296

103-
This query returns translation(s) by `resourceId`.
97+
This query returns translation(s) filtered by `resourceId`. For product filters, the `resourceId` is constructed from the `filterName` as shown in the callout above.
10498

10599
<Tabs items={['Request', 'Response']}>
106100
<Tab>

0 commit comments

Comments
 (0)