Reference - Internationalization REST API 1.0.0

Document View

This API specification is available for download as an Open API 3.0 YAML file:

icm-b2b-internationalization-1x0x0.yaml

References

The following page lists available REST APIs for ICM 11 and their version dependencies:

Reference - Intershop Commerce Management 11 REST API

API Specification

Introduction

OpenAPI Version: 3.0.1

Internationalization Version: 1.0.0

The Internationalization REST API provides localizations and country details.

Changelog

Version 1.0.0

Created a separate REST API 'Internationalization' out of 'Shop'

Country API

/countries

GET: Returns the available countries for the channel.

Description

This operation returns the list of countries currently available for the channel. A country is considered available if it is included in an active region as part of an active freight class of a shipping eligibility. Moreover, the region and eligibility must have at least one shipping method assigned. It is not mandatory that the assigned shipping method is active.

Java Method

public jakarta.ws.rs.core.Response com.intershop.sellside.rest.country.v1.capi.resource.country.CountryListResource.getCountries_V1()

Request Body

Request Parameters

Response

200 - OK The list of available countries.

GeoObjectListCtnrRO_v1 application/vnd.intershop.country.v1+json

/countries/{countryCode}

GET: Returns the country details for given country code.

Description

Returns the country details for given country code. If country with this code is not found a 404 error will be returned.

Java Method

public jakarta.ws.rs.core.Response com.intershop.sellside.rest.country.v1.capi.resource.country.CountryItemResource.getCountry_V1()

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in path	countryCode	string			Required

Response

200 - OK The requested country details.

GeoObjectCtnrRO_v1 application/vnd.intershop.country.v1+json

404 - Not Found If a country with the given code is not found.

FeedbackCtnrRO_v1 application/vnd.intershop.country.v1+json

/countries/{countryCode}/main-divisions

GET: Returns the available maindivisions for given country code.

Description

Returns the available maindivisions for given country code. If country with this code is not found a 404 error will be returned.

Java Method

public jakarta.ws.rs.core.Response com.intershop.sellside.rest.country.v1.capi.resource.maindivision.MainDivisionListResource.getMainDivisions_V1()

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in path	countryCode	string			Required

Response

200 - OK The list of available maindivisions.

GeoObjectListCtnrRO_v1 application/vnd.intershop.country.v1+json

404 - Not Found If a country with the given code is not found.

FeedbackCtnrRO_v1 application/vnd.intershop.country.v1+json

Localizations API

Localizations

The localization API endpoint allows clients to obtain a list of localized texts or specific localization keys. All operations support different locales. In order to
select texts for a particular locale, use the matrix parameter loc.

The returned localization value is the imported or defined value without any replacements or formatting (the server location functionality requires the Java Message Format for these values).

Example Usage

Following (JUnit Test) example shows how to retrieve localized texts for a site:

curl https://<SERVER>/INTERSHOP/rest/WFS/<SITE>/-/localizations

{loc}/localizations

GET: Returns localized texts

Description

This operation returns a map that contains localized texts for the requested locale.

Java Method

public java.util.Map com.intershop.beehive.platformrest.resource.localization.LocalizationResource.getLocalizations(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in path	loc	string	`en_US`		The locale ID (submitted as optional matrix parameter `;loc=<LOCALE>`). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. `en_US`.
in query	searchKeys	string		`error,webform`	An optional comma separated list of search keys. If given, only localizations which keys contain at least one of the search keys are returned.

Response

default - Unknown default response

{loc}/localizations/{key}

GET: Returns localized text for a given key

Description

This operation returns the localized text for the given key in the requested locale passed in as matrix parameter '''loc'''.

Java Method

public java.lang.String com.intershop.beehive.platformrest.resource.localization.LocalizationResource.getLocalization(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in path	loc	string	`en_US`		The locale ID (submitted as optional matrix parameter `;loc=<LOCALE>`). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. `en_US`.
in path	key	string		`account.giftcard.form.ok`	Required \| The localization key

Response

200 - OK

204 - No Content - Occurs if key is not available

Request and Response Object Schemata

FeedbackCtnrRO_v1 application/vnd.intershop.country.v1+json

{

"errors":
array
Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1: An error or piece of information related to the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback information.
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale. | Example: The product name must be specified.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
- "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: product.name.required.error
- "message":
  string
  Required | A human readable message in the request's locale. | Example: The product name must be specified.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
- "status":
  string
  The HTTP status code that is applicable to this problem. | Example: 422
}
]
"included":
object
Optionally included related data objects.
"infos":
array
Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1: An error or piece of information related to the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback information.
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale. | Example: The product name must be specified.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
- "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: product.name.required.error
- "message":
  string
  Required | A human readable message in the request's locale. | Example: The product name must be specified.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
- "status":
  string
  The HTTP status code that is applicable to this problem. | Example: 422
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.

}

GeoObjectCtnrRO_v1 application/vnd.intershop.country.v1+json

{

"data":
object
A GeoObjectRO_v1 object. Describes a geoobject which can be a country or maindivision/state.
{
- "id":
  string
  Readonly | The id of the geoobject. | Example: US
- "name":
  string
  Readonly | The name of an element | Example: United States
}
"errors":
array
Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1: An error or piece of information related to the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback information.
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale. | Example: The product name must be specified.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
- "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: product.name.required.error
- "message":
  string
  Required | A human readable message in the request's locale. | Example: The product name must be specified.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
- "status":
  string
  The HTTP status code that is applicable to this problem. | Example: 422
}
]
"included":
object
Optionally included related data objects.
"infos":
array
Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1: An error or piece of information related to the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback information.
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale. | Example: The product name must be specified.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
- "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: product.name.required.error
- "message":
  string
  Required | A human readable message in the request's locale. | Example: The product name must be specified.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
- "status":
  string
  The HTTP status code that is applicable to this problem. | Example: 422
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.

}

GeoObjectListCtnrRO_v1 application/vnd.intershop.country.v1+json

{

"data":
array
An array of GeoObjectRO_v1 objects. The core data of the response object.
[
GeoObjectRO_v1: Describes a geoobject which can be a country or maindivision/state.
{
- "id":
  string
  Readonly | The id of the geoobject. | Example: US
- "name":
  string
  Readonly | The name of an element | Example: United States
}
]
"errors":
array
Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1: An error or piece of information related to the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback information.
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale. | Example: The product name must be specified.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
- "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: product.name.required.error
- "message":
  string
  Required | A human readable message in the request's locale. | Example: The product name must be specified.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
- "status":
  string
  The HTTP status code that is applicable to this problem. | Example: 422
}
]
"included":
object
Optionally included related data objects.
"infos":
array
Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1: An error or piece of information related to the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback information.
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale. | Example: The product name must be specified.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
- "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: product.name.required.error
- "message":
  string
  Required | A human readable message in the request's locale. | Example: The product name must be specified.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
- "status":
  string
  The HTTP status code that is applicable to this problem. | Example: 422
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.

}

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.