--- title: "Get the locale information for an individual or base product" method: GET path: "/v1/products/{productId}/locales/{locale}" tags: ["Retrieve Product (Synchronous API)"] --- # Get the locale information for an individual or base product `GET /v1/products/{productId}/locales/{locale}` Get the localized locale information for an individual or base product. The product identifier should be for an individual or base product. ## Path parameters - `productId` string, required - `locale` string, required ## Query parameters - `version` 'DEPLOYED' | 'RETIRED' ## Headers - `x-erid-as-pid` boolean ## Response `200` Successful response. - object[] - `productType` 'BASE' | 'INDIVIDUAL' — Indicates the type of product as either an individual or base product. A base product has one or more product variations such as different colors, sizes, or versions. An individual product a single item or many single items sold as a single product (such as a colection or box set. - `companyId` string — The company identifier. - `siteIds` string[] — The site identifier. - `id` string — The individual product identifier or base product identifier for the product. - `state` 'Deployed' | 'Design' | 'Retired' | 'Deployed: Pending Start' | 'Deployed: Partially Started' — The status of the product. * Deployed: The current product setup is the same product setup that is available for sale on your store. * Design: The current product setup (also called in the version) has not yet been deployed to your store. * Retired: The version of the product cannot be purchased or seen on your store. * Deployed: Pending Start: This state appears when a future Start Date is set for base, individual or variation product, and also the product is deployed. Meaning there is a version that is available for sale on your store. And there is another newer version will be available for sale on your store when the Start Date arrived. * Deployed: Partially Started: This state appears when the base product is now ready for sale, but a future Start Date is set for any of its variations, and also the product is deployed. - `locked` boolean — When the product is locked, the product is not editable. - `version` integer — Version of the product. - `deploymentRequiredChanges` ProductDeploymentChanges — You must deploy the product to publish these changes. - `fulfillmentTypes` string[] — A fulfillment type defines how products are delivered or sent to shoppers. - `otherFulfillmentIntegration` object — The Other Fulfillment Integration setting allows you to provide a unique fulfillment for your products. If you have special fulfillment needs that you think could benefit from Other Fulfillment Requirements and integrations, contact your Store Operations team. - `fulfillerIds` string[] — The fulfiller's identifier. - `transferProduct` string — The transfer product identifier. This is a subscription product term. You can use the product identifier (productID) or the external reference identifier (ERID). The base product cannot be a transfer product. - `upgradeProducts` string[] — The upgrade product identifier. This is a subscription product term. You can use the product identifier (productID) or the external reference identifier (ERID). The base product cannot be an upgrade product. - `downgradeProducts` string[] — The downgrade product identifier. This is a subscription product term. You can use the product identifier (productID) or the external reference identifier (ERID). The base product cannot be an downgrade product. - `liveChanges` GetProductLiveChange — These changes do not require a deployment. - `externalReferenceId` string — The external reference identifier. This is a unique product identifier for your product. - `catalogs` object[] — A collection of products for sale on your site. A catalog contains categories to organize your products. - `catalogId` string — The catalog identifier. - `catalogName` string — The catalog's name. Once your create a catalog name it becomes read only. No need to provide this attribute in the request. It will be ignored when you create or update the product. - `categories` object[] — Use categories to organize products within a catalog. Catalogs often appear in the store to help shoppers locate products and navigate the store or site. - `categoryId` string - `categoryName` string — The name of the category. This field is read only. You do not need to provide this attribute in the request. It will be ignored when you create or update the product. - `prices` object[] — List the prices of the product. - `type` 'listPrice' | 'msrp' — The type of the price list. Used to classify the prices in a price list. A price list type may also indicate how the price list or pricing will be used. For example, you can create a MSRP list, a subscription renewal price list, and so on. - `priceListName` string — Name of the price list. This field is read only. You do not need to provide this attribute in the request. It will be ignored when you create or update the product. - `taxInclusive` boolean — The price list setup for the currency. * If true, the price list is set to tax inclusive. * If false, the price list is set to tax exclusive. The price list setup for the currency. This field is read only. You do not need to arovide this attribute in the request. It will be ignored when you create or update the product. - `prices` object[] — The price of the product by currency and locale. - `currency` string — A three-letter ISO 4217 currency code. - `locale` string — Optional. If your store supports multiple locales, your price list will contain space for you to enter pricing in currencies used by the locales supported by your store. The price you enter for a product in a currency will be used by any locale that uses the currency in which you entered the price. - `configuredPrice` number — The configured price for the product. - `calculatedPrice` number — If there is no configured price for a product in a specific currency, the price set for the product in the default currency will be converted and calculated for use. This field is read only. You do not need to provide this attribute in the request. It will be ignored when you create or update the product. - `localizations` GetLocalization[] — The locales supported by the product. - `locale` string — The product's supported locale. - `isDefault` boolean — When set to "true", the locale is the default locale. - `groups` object[] — Grouped attributes. - `groupId` string — The group identifier for the attributes. This field is read-only. You do not need to provide this attribute in the request. It will be ignored when creating or updating the product. - `groupName` string — The group name for the attributes. This field is read-only. You do not need to provide this attribute in the request. It will be ignored when creating or updating the product. - `attributes` object ## Other responses - `401` — * The API key is invalid if you are using HTTP Basic Authentication. - `403` — * The token is invalid if you are using Bearer Token Authentication. - `404` — * Product was not found. --- [API](https://skmtc.net/digitalriver/apis/commerce-api-suite-admin-apis.md) · [All operations](https://skmtc.net/digitalriver/apis/commerce-api-suite-admin-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalriver/commerce-api-suite-admin-apis/revisions/a6efafc1669c/schema)