Skip to content

Commit 17089a1

Browse files
chore(catalog): CATALOG-12212 Updade product option value parameters in catalog API documentation (#1169)
<!-- Ticket number or summary of work --> # [CATALOG-12212](https://bigcommercecloud.atlassian.net/browse/CATALOG-12212) ## What changed? <!-- Provide a bulleted list in the present tense --> Corrected the exemplary values for the following parameters: - `include_fields` should be `Allowed: label | sort_order | value_data | is_default`. - `exclude_fields` should be `Allowed: label | sort_order | value_data | is_default`. It applies to endpoints: - `GET: stores/{store_hash}/v3/catalog/products/{product_id}/options/{option_id}/values`; - `GET :stores/{store_hash}/v3/catalog/products/{product_id}/options/{option_id}/values/{value_id}`. ## 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]. --> Now the docs are accurate and carry valid information. ## Anything else? <!-- Add related PRs, salient notes, additional ticket numbers, etc. --> Tested Locally: <img width="1377" height="913" alt="Screenshot 2025-11-25 at 16 14 39" src="https://github.com/user-attachments/assets/137b7322-3c66-49a1-a1df-d169269a2367" /> <img width="1385" height="919" alt="Screenshot 2025-11-25 at 16 15 00" src="https://github.com/user-attachments/assets/87f772a1-df50-42ae-a3ef-807208576731" /> ping {names} [CATALOG-12212]: https://bigcommercecloud.atlassian.net/browse/CATALOG-12212?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
1 parent 2417f6a commit 17089a1

File tree

1 file changed

+34
-4
lines changed

1 file changed

+34
-4
lines changed

reference/catalog/product-variant-options_catalog.v3.yml

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1452,8 +1452,8 @@ paths:
14521452
parameters:
14531453
- $ref: '#/components/parameters/PageParam'
14541454
- $ref: '#/components/parameters/LimitParam'
1455-
- $ref: '#/components/parameters/IncludeFieldsParam'
1456-
- $ref: '#/components/parameters/ExcludeFieldsParam'
1455+
- $ref: '#/components/parameters/ProductOptionValueIncludeFieldsParam'
1456+
- $ref: '#/components/parameters/ProductOptionValueExcludeFieldsParam'
14571457
responses:
14581458
'200':
14591459
description: ''
@@ -1712,8 +1712,8 @@ paths:
17121712
description: Returns a single *Variant Option Value*. Optional parameters can be passed in.
17131713
operationId: getProductVariantOptionValue
17141714
parameters:
1715-
- $ref: '#/components/parameters/IncludeFieldsParam'
1716-
- $ref: '#/components/parameters/ExcludeFieldsParam'
1715+
- $ref: '#/components/parameters/ProductOptionValueIncludeFieldsParam'
1716+
- $ref: '#/components/parameters/ProductOptionValueExcludeFieldsParam'
17171717
responses:
17181718
'200':
17191719
description: ''
@@ -2350,6 +2350,36 @@ components:
23502350
type: array
23512351
items:
23522352
type: string
2353+
ProductOptionValueIncludeFieldsParam:
2354+
name: include_fields
2355+
in: query
2356+
description: Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
2357+
style: form
2358+
explode: false
2359+
schema:
2360+
type: array
2361+
items:
2362+
type: string
2363+
enum:
2364+
- label
2365+
- sort_order
2366+
- value_data
2367+
- is_default
2368+
ProductOptionValueExcludeFieldsParam:
2369+
name: exclude_fields
2370+
in: query
2371+
description: Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
2372+
style: form
2373+
explode: false
2374+
schema:
2375+
type: array
2376+
items:
2377+
type: string
2378+
enum:
2379+
- label
2380+
- sort_order
2381+
- value_data
2382+
- is_default
23532383
Accept:
23542384
name: Accept
23552385
in: header

0 commit comments

Comments
 (0)