-
Notifications
You must be signed in to change notification settings - Fork 57
Add Shipping Methods and Tax Rates Translation Docs #1222
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
kristinapototska
wants to merge
3
commits into
main
Choose a base branch
from
PROJECT-5681-5682-shipping-tax-translations
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
291 changes: 291 additions & 0 deletions
291
docs/store-operations/translations/shipping-methods.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,291 @@ | ||
| # Translations for Shipping Methods (Beta) | ||
|
|
||
| <Callout type='info'> | ||
| The Translations Admin GraphQL API is currently available on Catalyst | ||
| storefronts only. | ||
| </Callout> | ||
|
|
||
| The following entities are translatable for shipping methods: | ||
|
|
||
| - Shipping Method Name as `shipping_method_name` | ||
|
|
||
| ## Resource fields | ||
|
|
||
| | Entity Type | `resourceType` | `resourceId` Format | | ||
| | ------------------ | ------------------ | ---------------------------------------- | | ||
| | Shipping Method | `SHIPPING_METHODS` | `bc/store/shippingMethod/{id}` | | ||
|
|
||
| ## Examples | ||
|
|
||
| Below are examples of GraphQL queries and mutations for retrieving and managing translation settings for shipping methods. | ||
|
|
||
| ### Query a List of Translations | ||
|
|
||
| This query returns shipping method translations for the specified resource type, channel, and locale (up to 50). | ||
|
|
||
| <Tabs items={['Request', 'Response']}> | ||
| <Tab> | ||
|
|
||
| ```graphql filename="Example query: Query a list of translations" showLineNumbers copy | ||
| GRAPHQL https://api.bigcommerce.com/stores/{{store_hash}}/graphql | ||
| X-Auth-Token: {{token}} | ||
|
|
||
| query { | ||
| store { | ||
| translations(filters: { | ||
| resourceType: SHIPPING_METHODS, | ||
| channelId: "bc/store/channel/{{channel_id}}", | ||
| localeId: "bc/store/locale/{{locale_code}}" | ||
| }) { | ||
| edges { | ||
| node { | ||
| resourceId | ||
| fields { | ||
| fieldName | ||
| original | ||
| translation | ||
| } | ||
| } | ||
| cursor | ||
| } | ||
| pageInfo { | ||
| hasNextPage | ||
| hasPreviousPage | ||
| startCursor | ||
| endCursor | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </Tab> | ||
| <Tab> | ||
|
|
||
| ```json filename="Example query: Query a list of translations" showLineNumbers copy | ||
| { | ||
| "data": { | ||
| "store": { | ||
| "translations": { | ||
| "edges": [ | ||
| { | ||
| "node": { | ||
| "resourceId": "bc/store/shippingMethod/1", | ||
| "fields": [ | ||
| { | ||
| "fieldName": "shipping_method_name", | ||
| "original": "Dev Test 1", | ||
| "translation": "espanol" | ||
| } | ||
| ] | ||
| }, | ||
| "cursor": "" | ||
| } | ||
| ], | ||
| "pageInfo": { | ||
| "hasNextPage": false, | ||
| "hasPreviousPage": false, | ||
| "startCursor": "eyJyZXNvdXJjZUlkIjoxfQ", | ||
| "endCursor": "eyJyZXNvdXJjZUlkIjoxfQ" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ### Query a Translation by Resource ID | ||
|
|
||
| This query returns a translation by `resourceId`. | ||
|
|
||
| <Callout type='info'> | ||
| When querying by `resourceId`, provide the full ID in the format `bc/store/shippingMethod/{id}`. | ||
| </Callout> | ||
|
|
||
| <Tabs items={['Request', 'Response']}> | ||
| <Tab> | ||
|
|
||
| ```graphql filename="Example query: Query a translation by id" showLineNumbers copy | ||
| GRAPHQL https://api.bigcommerce.com/stores/{{store_hash}}/graphql | ||
| X-Auth-Token: {{token}} | ||
|
|
||
| query { | ||
| store { | ||
| translations( | ||
| filters: { | ||
| resourceType: SHIPPING_METHODS | ||
| channelId: "bc/store/channel/{{channel_id}}" | ||
| localeId: "bc/store/locale/{{locale_code}}" | ||
| resourceIds: ["bc/store/shippingMethod/1"] | ||
| } | ||
| ) { | ||
| edges { | ||
| node { | ||
| resourceId | ||
| fields { | ||
| fieldName | ||
| original | ||
| translation | ||
| } | ||
| } | ||
| cursor | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </Tab> | ||
| <Tab> | ||
|
|
||
| ```json filename="Example query: Query a translation by id" showLineNumbers copy | ||
| { | ||
| "data": { | ||
| "store": { | ||
| "translations": { | ||
| "edges": [ | ||
| { | ||
| "node": { | ||
| "resourceId": "bc/store/shippingMethod/1", | ||
| "fields": [ | ||
| { | ||
| "fieldName": "shipping_method_name", | ||
| "original": "Dev Test 1", | ||
| "translation": "espanol" | ||
| } | ||
| ] | ||
| }, | ||
| "cursor": "" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ### Update a Translation | ||
|
|
||
| <Tabs items={['Request', 'Response']}> | ||
| <Tab> | ||
|
|
||
| ```graphql filename="Example mutation: Update a translation" showLineNumbers copy | ||
| GRAPHQL https://api.bigcommerce.com/stores/{{store_hash}}/graphql | ||
| X-Auth-Token: {{token}} | ||
|
|
||
| mutation { | ||
| translation { | ||
| updateTranslations(input: { | ||
| resourceType: SHIPPING_METHODS, | ||
| channelId: "bc/store/channel/{{channel_id}}", | ||
| localeId: "bc/store/locale/{{locale_code}}", | ||
| entities: [ | ||
| { | ||
| resourceId: "bc/store/shippingMethod/1", | ||
| fields: [ | ||
| { | ||
| fieldName: "shipping_method_name", | ||
| value: "Nuevo Nombre de Envío" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }) { | ||
| errors { | ||
| __typename | ||
| ... on Error { | ||
| message | ||
| } | ||
| ... on EntityNotFoundError { | ||
| message | ||
| } | ||
| ... on ValidationError { | ||
| message | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </Tab> | ||
| <Tab> | ||
|
|
||
| ```json filename="Example mutation: Update a translation" showLineNumbers copy | ||
| { | ||
| "data": { | ||
| "translation": { | ||
| "updateTranslations": { | ||
| "errors": [] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ### Delete a Translation | ||
|
|
||
| <Tabs items={['Request', 'Response']}> | ||
| <Tab> | ||
|
|
||
| ```graphql filename="Example mutation: Delete a translation" showLineNumbers copy | ||
| GRAPHQL https://api.bigcommerce.com/stores/{{store_hash}}/graphql | ||
| X-Auth-Token: {{token}} | ||
|
|
||
| mutation { | ||
| translation { | ||
| deleteTranslations(input: { | ||
| resourceType: SHIPPING_METHODS, | ||
| channelId: "bc/store/channel/{{channel_id}}", | ||
| localeId: "bc/store/locale/{{locale_code}}", | ||
| resources: [ | ||
| { | ||
| resourceId: "bc/store/shippingMethod/1", | ||
| fields: ["shipping_method_name"] | ||
| } | ||
| ] | ||
| }) { | ||
| errors { | ||
| __typename | ||
| ... on Error { | ||
| message | ||
| } | ||
| ... on EntityNotFoundError { | ||
| message | ||
| } | ||
| ... on ValidationError { | ||
| message | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </Tab> | ||
| <Tab> | ||
|
|
||
| ```json filename="Example mutation: Delete a translation" showLineNumbers copy | ||
| { | ||
| "data": { | ||
| "translation": { | ||
| "deleteTranslations": { | ||
| "errors": [] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </Tab> | ||
| </Tabs> | ||
|
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.