Add Order Statuses and Promotions Translation Documentation #1221
Conversation
- Add order-statuses.mdx with list/by-id/update/delete examples - Add promotions.mdx with list/by-id/update/delete examples - Update index.mdx to include Order Statuses and Promotions
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| This query returns up to 50 order status translations for the specified resource type, channel, and locale. | ||
|
|
||
| The request below uses several variables for reusability. Replace `{{channel_id}}` and `{{locale_code}}` with the appropriate values for your use case. |
There was a problem hiding this comment.
reusability is misspelt; did you mean readability? retext-spell retext-spell
|
|
||
| ### Query a Translation by Resource ID | ||
|
|
||
| This query returns translation(s) by resourceId. |
There was a problem hiding this comment.
resourceId is misspelt; did you mean resourceD? retext-spell retext-spell
|
|
||
| This query returns translation(s) by resourceId. | ||
|
|
||
| The request below uses several variables for reusability. Replace `{{resourceId}}`, `{{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. |
There was a problem hiding this comment.
reusability is misspelt; did you mean readability? retext-spell retext-spell
|
|
||
| This query returns up to 50 promotion translations for the specified resource type, channel, and locale. | ||
|
|
||
| The request below uses several variables for reusability. Replace `{{channel_id}}` and `{{locale_code}}` with the appropriate values for your use case. |
There was a problem hiding this comment.
reusability is misspelt; did you mean readability? retext-spell retext-spell
|
|
||
| ### Query a Translation by Resource ID | ||
|
|
||
| This query returns translation(s) by resourceId. |
There was a problem hiding this comment.
resourceId is misspelt; did you mean resourceD? retext-spell retext-spell
| When querying a translation by `resourceId`, you must provide the full `resourceId` in the format `bc/store/promotion/{promotion_id}`. | ||
| </Callout> | ||
|
|
||
| The request below uses several variables for reusability. Replace `{{resourceId}}`, `{{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. |
There was a problem hiding this comment.
reusability is misspelt; did you mean readability? retext-spell retext-spell
| * Brands | ||
| * [Product Filters](/docs/store-operations/translations/filters) | ||
| * [Locations](/docs/store-operations/translations/locations) | ||
| * [Order Statuses](/docs/store-operations/translations/order-statuses) |
There was a problem hiding this comment.
Link to /docs/store-operations/translations/order-statuses is dead no-dead-urls remark-lint
| * [Product Filters](/docs/store-operations/translations/filters) | ||
| * [Locations](/docs/store-operations/translations/locations) | ||
| * [Order Statuses](/docs/store-operations/translations/order-statuses) | ||
| * [Promotions](/docs/store-operations/translations/promotions) |
There was a problem hiding this comment.
Link to /docs/store-operations/translations/promotions is dead no-dead-urls remark-lint
| - [Product Listing Page Translations](/docs/store-operations/translations/listings) | ||
| - [Product Filter Translations](/docs/store-operations/translations/filters) | ||
| - [Inventory Locations Translations](/docs/store-operations/translations/locations) | ||
| - [Order Status Translations](/docs/store-operations/translations/order-statuses) |
There was a problem hiding this comment.
Link to /docs/store-operations/translations/order-statuses is dead no-dead-urls remark-lint
| - [Product Filter Translations](/docs/store-operations/translations/filters) | ||
| - [Inventory Locations Translations](/docs/store-operations/translations/locations) | ||
| - [Order Status Translations](/docs/store-operations/translations/order-statuses) | ||
| - [Promotions Translations](/docs/store-operations/translations/promotions) |
There was a problem hiding this comment.
Link to /docs/store-operations/translations/promotions is dead no-dead-urls remark-lint
|
@bc-vincent-zhao @YevenLourance @matt-evangelidis can you please have a final look at this PR and let @bc-terra know if this one is ready to be merged and released to public dev docs. |
CSS-1937 / CSS-1953
What/Why?
Add documentation for Order Statuses and Promotions translations in the Translations Admin GraphQL API. Two new docs (order-statuses.mdx, promotions.mdx) follow the existing pattern with list/by-id/update/delete examples.
Rollout/Rollback Plan
Testing Details
Manual Testing
- TBD