Skip to content

Conversation

@bc-terra
Copy link
Collaborator

@bc-terra bc-terra commented Nov 19, 2025

DEVDOCS-6592

What changed?

  • Consolidated docs for readability and maintainability
  • Added product option translations

Release notes draft

  • GraphQL Translations API now supports Product Options!

Anything else?

This PR will require a companion PR in developer-center at the time of merging.

ping { @dev-docs-team }

| Entity Type | `resourceType` | `resourceId` Format |
| --- | --- | --- |
| Category | `CATEGORIES` | `bc/store/category/{{category_id}}` |
| Brand | `BRANDS` | `bc/store/brand/{{brand_id}}` |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
Hard to read sentence (confidence: 4/7) retext-readability retext-readability


### Query a List of Translations

This query returns a paginated list of translations by resourceType, channel and locale with a maximum of 50 results per request.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
resourceType is misspelt retext-spell retext-spell


This query returns a paginated list of translations by resourceType, channel and locale with a maximum of 50 results per request.

The request below uses several variables for reusability. Replace `{{resourceType}}`, `{{channel_id}}`, and `{{locale_code}}` with the appropriate values for your use case.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
reusability is misspelt; did you mean readability? retext-spell retext-spell


### Query a Translation by Resource ID

This query returns a translation by resourceId.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
resourceId is misspelt; did you mean resourceD? retext-spell retext-spell


This query returns a translation by resourceId.

The request below uses several variables for reusability. Replace `{{resourceId}}`, `{{resourceType}}`, `{{channel_id}}`, and `{{locale_code}}` with appropriate values for your use case. Make sure `resourceId` follows the format from the [Resource fields](#resource-fields) table.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
reusability is misspelt; did you mean readability? retext-spell retext-spell

* [Product Data](/docs/store-operations/translations/products)
* Product Options
* Custom Fields
* [Catalog Pages](/docs/store-operations/translations/listings)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
Link to /docs/store-operations/translations/listings is dead no-dead-urls remark-lint

- Cache translations to minimize API calls
- Check existing translations before creating duplicates
- Use pagination effectively for large translation sets
- Validate resourceIds match resourceType format requirements

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
resourceIds is misspelt retext-spell retext-spell

- Cache translations to minimize API calls
- Check existing translations before creating duplicates
- Use pagination effectively for large translation sets
- Validate resourceIds match resourceType format requirements

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
resourceType is misspelt retext-spell retext-spell

* [Translations for Categories (Beta)](/docs/store-operations/translations/categories)
* [Translations for Locations (Beta)](/docs/store-operations/translations/locations)

- [Product Translations](/docs/store-operations/translations/products)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
Link to /docs/store-operations/translations/products is dead no-dead-urls remark-lint

* [Translations for Locations (Beta)](/docs/store-operations/translations/locations)

- [Product Translations](/docs/store-operations/translations/products)
- [Catalog Page Translations](/docs/store-operations/translations/listings)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
Link to /docs/store-operations/translations/listings is dead no-dead-urls remark-lint

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants