For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
  • Overview
    • Quick Start
    • Sandboxes
    • Tools & SDKs
    • Support
  • Docs
      • Getting Started
          • Overview
          • Products
          • Product Modifiers
          • Product Listings
          • Product Filters
          • Product URLs (Beta)
          • Customer Form Fields
          • Promotions
          • Address Form Fields
          • Checkout Settings
          • Shipping Methods
          • Tax Rates
          • Order Statuses
          • Locations
          • Payment Methods
          • Error Handling
    • Archive
    • Closed Beta Programs
Dev Portal
LogoLogo
On this page
  • Resource fields
  • Examples
  • Query a List of Translations
  • Query a Translation by Resource ID
  • Update a Translation
  • Delete a Translation
DocsAdminStore ConfigurationTranslations

Translations for Shipping Methods (Beta)

Was this page helpful?
Previous

Checkout Settings

Next

Tax Rates

Built with

The Translations Admin GraphQL API is currently available on Catalyst storefronts only.

The following entities are translatable for shipping methods:

  • Shipping Method Name as shipping_method_name

Resource fields

Entity TyperesourceTyperesourceId Format
Shipping MethodSHIPPING_METHODSbc/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).

Request
Response
Example query: Query a list of translations
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
      }
    }
  }
}

Query a Translation by Resource ID

This query returns a translation by resourceId.

When querying by resourceId, provide the full ID in the format bc/store/shippingMethod/{id}.

Request
Response
Example query: Query a translation by id
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
      }
    }
  }
}

Update a Translation

Request
Response
Example mutation: Update a translation
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
        }
      }
    }
  }
}

Delete a Translation

Request
Response
Example mutation: Delete a translation
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
        }
      }
    }
  }
}