This API specification is available for download as an Open API 3.0 YAML file:
References
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
API Specification
{loc}/attachments/{AttachmentResourceKey}
GET: Returns the content of an attachment
Description
This operation returns the content of an attachment with a given descriptor and locale ID.
Normally, this endpoint is not called directly. Rather, it is used in the Product and Promotion details to provide links to attachments.
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.attachment.AttachmentResource.getAttachment(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 site's or user's default locale is used. |
in path | AttachmentResourceKey | string | | testDomain%253A%252Fmanual.pdf | Required | The content descriptor or URI of the attachment, double encoded. |
in query | type | string | | promotion | The optional type of the attachment |
Response
default - Unknown default response
/configurations
GET: Returns the configuration details for given application.
Description
This operation returns the configuration details for the given application.
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.configuration.v1.capi.resource.configuration.ConfigurationListResource.getConfiguration()
Request Body
--
Request Parameters
--
Response
200 - OK The request was successful.
ConfigurationCtnrRO application/vnd.intershop.configuration.v1+json
404 - Not Found No application with this ID was found.
FeedbackCtnrRO_v1 application/vnd.intershop.configuration.v1+json
/contact
GET: Get subjects for "Contact Us"
Description
Returns a list of subject that has to be used when "Contact Us" e-mail is requested.
Java Method
public com.intershop.sellside.rest.common.capi.resource.contact.ContactResource$ContactUsROResourceCollection com.intershop.sellside.rest.common.capi.resource.contact.ContactResource.getSubjects()
Request Body
--
Request Parameters
--
Response
200 - OK
ContactUsROResourceCollection application/json
POST: Send "Contact us" e-mail
Description
Triggers sending of "Contact Us" e-mail with data submitted with the request.
Java Method
public void com.intershop.sellside.rest.common.capi.resource.contact.ContactResource.sendMessage(com.intershop.sellside.rest.common.capi.resourceobject.ContactRO)
Request Body
ContactRO application/json
Request Parameters
--
Response
201 - Created
400 - Bad Request in case the submitted data is missing or invalid.
404 - Not Found possible values for header error-key:
- helpdesk.contact_us_not_found.error
500 - Internal Server Error possible values for header error-key:
- helpdesk.mail_not_sent.message
/countries
GET: Returns the available countries for the channel.
Description
Returns the available countries for the channel.
Java Method
public javax.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 javax.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 javax.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
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 site's or user's default locale is used. |
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 site's or user's default locale is used. |
in path | key | string | | account.giftcard.form.ok | Required | The localization key |
Response
200 - OK
204 - No Content - Occurs if key is not available
/stores
GET: Store locator
Description
Retrieves a list of stores and returns them to the client
Java Method
public com.intershop.sellside.rest.common.capi.resource.store.locator.StoreLocatorResource$StoreROResourceCollection com.intershop.sellside.rest.common.capi.resource.store.locator.StoreLocatorResource.getStores(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Boolean)
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in query | postalCode | string | | | a postal code, search expressions are supported |
in query | countryCode | string | | | country code in ISO format |
in query | city | string | | | city, search expressions are supported |
in query | storeName | string | | | name of the store, search expressions are supported |
in query | usePreference | boolean | | | If set to true, than request check if pick up in store preference is enabled. If usePreference is set to true and the pick up in store preference is disabled, than response contains no stores. If usePreference is set to false, the pick up in store preference will ignored and response contains all listed stores. |
Response
200 - OK
StoreROResourceCollection application/json
204 - No Content
ConfigurationCtnrRO application/vnd.intershop.configuration.v1+json
{"data":
object
A ConfigurationRO
object. Describes a configuration.
{
"application":
object
A ApplicationRO
object. This resource holds information on an application and the URLs to use it.
{
"id":
string
Readonly | Identifier of configuration. | Example: application
"applicationId":
string
Readonly | The unique id of the application. | Example: 2vIKABsmU9oAAAFprwgZvAHX
"applicationType":
string
Readonly | The application's type. Defines the application's code base (pipelines, ISML templates, ...). | Example: intershop.SMBResponsive
"displayName":
string
Readonly | The application's type | Example: SMB - Responsive
"urlIdentifier":
string
Readonly | The url identifier of the application. | Example: b2c-responsive
"default":
boolean
Readonly | Is the application used as default flag. | Example: true
}
"attributes":
array
Readonly | An array of AttributeRO_v1
objects.
[
Either BooleanAttributeRO_v1
: A representation of a boolean attribute.
{}
Or DateAttributeRO_v1
: A representation of a date/time attribute.
{}
Or DecimalAttributeRO_v1
: A representation of a decimal attribute.
{}
Or DoubleAttributeRO_v1
: A representation of a double attribute.
{}
Or IntegerAttributeRO_v1
: A representation of an integer attribute.
{}
Or LongAttributeRO_v1
: A representation of a long attribute.
{}
Or MoneyAttributeRO_v1
: A representation of a money attribute.
{}
Or QuantityAttributeRO_v1
: A representation of a quantity attribute.
{}
Or StringAttributeRO_v1
: A representation of a string attribute.
{}
Or TextAttributeRO_v1
: A representation of a text attribute.
{}
Or MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.
{}
Or MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.
{}
Or MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.
{}
Or MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.
{}
Or MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.
{}
Or MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.
{}
Or MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.
{}
]
"basket":
object
A BasketSettingsRO
object. Describes a basket configuration.
{
"id":
string
Readonly | Identifier of configuration. | Example: basket
"expirationType":
string
Readonly | The basket expiration type. | Example: Session
"addProductBehaviour":
string
Readonly | The strategy for add products. | Example: Allow Repeats
"lifetime":
string
Readonly | The basket lifetime. | Example: 28,800
"maxItemSize":
string
Readonly | The maximum number of line items. | Example: 50
"maxItemQuantity":
string
Readonly | The maximum item quantity per basket. | Example: 100
"minTotalValue":
array
Readonly | An array of MoneyRO_v1
objects. The minimum total value per basket. | Example: 10
[
MoneyRO_v1
:
Describes a money object.{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
]
"maxTotalValue":
array
Readonly | An array of MoneyRO_v1
objects. The maximum total value per basket. | Example: 100
[
MoneyRO_v1
:
Describes a money object.{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
]
"acceleration":
boolean
Readonly | Is checkout acceleration enabled flag. | Example: false
"termsAndConditions":
boolean
Readonly | Is terms and conditions enabled flag. | Example: true
"emailOptIn":
boolean
Readonly | Is auto email Opt-In enabled flag. | Example: true
"displayTaxesAndFees":
string
Readonly | The display taxes strategy. | Example: No taxes are displayed
"desiredDeliveryDate":
boolean
Deprecated | Readonly | Is desired delivery date enabled flag. (Deprecated, please use data.shipping.desiredDeliveryDate) | Example: true
"deliveryExcludeSaturday":
boolean
Deprecated | Readonly | Is saturday excluded for delivery flag.(Deprecated, please use data.shipping.deliveryExcludeSaturday) | Example: false
"deliveryExcludeSunday":
boolean
Deprecated | Readonly | Is sunday excluded for delivery flag. (Deprecated, please use data.shipping.deliveryExcludeSunday) | Example: true
"packSlipMessage":
boolean
Readonly | Is pack slip message enabled flag. | Example: true
"packSlipMessageMaxLength":
string
Readonly | The pack slip message maximum length. | Example: 42
"giftWrap":
boolean
Readonly | Is gift wrap enabled flag. | Example: true
"giftMessage":
boolean
Readonly | Is gift message enabled flag. | Example: true
"giftMessageMaxLength":
string
Readonly | The gift message maximum length. | Example: 450
}
"captcha":
object
A CaptchaRO
object. Describes the channel captcha preference.
{
"id":
string
Readonly | Identifier of configuration. | Example: captcha
"redemptionOfGiftCardsAndCertificates":
boolean
Readonly | Is captcha for redemption of giftcards and certificates enabled flag. | Example: true
"forgotPassword":
boolean
Readonly | Is captcha for forgot password enabled flag. | Example: true
"contactUs":
boolean
Readonly | Is captcha for contact us enabled flag. | Example: false
"emailShoppingCart":
boolean
Readonly | Is captcha for email shopping cart enabled flag. | Example: true
"register":
boolean
Readonly | Is captcha for register enabled flag. | Example: true
}
"general":
object
A GeneralSettingsRO
object. Describes a general configuration values of an application.
{
"id":
string
Readonly | Identifier of configuration. | Example: general
"defaultCurrency":
string
Readonly | The default currency. | Example: USD
"defaultLocale":
string
Readonly | The default locale. | Example: en_US
"currencies":
array
Readonly | An array of string
literals. The available currencies. | Example: "USD","EUR"
"locales":
array
Readonly | An array of string
literals. The available locales. | Example: "en_US","fr_FR"
}
"preferences":
object
A PreferenceRO
object. Describes a list of preferences.
{
"id":
string
Readonly | Identifier of configuration. | Example: preferences
}
"pricing":
object
A PricingPreferenceRO
object. Describes the channel pricing preference.
{
"id":
string
Readonly | Identifier of configuration. | Example: pricing
"priceType":
string
Readonly | The price type for the channel. | Example: net
"privateCustomerPriceDisplayType":
string
Readonly | The price type that is shown in the storefront to private customers. | Example: net
"smbCustomerPriceDisplayType":
string
Readonly | The price type that is shown in the storefront to smb customers. | Example: gross
"defaultCustomerTypeForPriceDisplay":
string
Readonly | Customer type which is used for logged-out customers. | Example: PRIVATE
}
"services":
object
A ServicesRO
object. Describes the managed sevices preferences.
{
"id":
string
Readonly | Identifier of configuration. | Example: services
}
"shipping":
object
A ShippingPreferenceRO
object. Describes the channel shipping preference.
{
"bucketSurchargeBehavior":
string
Readonly | The default behavior of bucket surcharge. | Example: Lowest
"deliveryExcludeSaturday":
boolean
Readonly | Is saturday excluded for delivery flag. | Example: false
"deliveryExcludeSunday":
boolean
Readonly | Is sunday excluded for delivery flag. | Example: true
"desiredDeliveryDate":
boolean
Readonly | Is desired delivery date enabled flag. | Example: true
"desiredDeliveryDaysMax":
string
Readonly | The latest possible desired delivery day. | Example: 90
"desiredDeliveryDaysMin":
string
Readonly | The earliest possible desired delivery day. | Example: 2
"id":
string
Readonly | Identifier of configuration. | Example: shipping
"itemImportSurchargeBehavior":
string
Readonly | The default behavior of item import surcharge. | Example: Highest
"itemSurchargeBehavior":
string
Readonly | The default behavior of item surcharge. | Example: AddAll
"multipleShipmentsSupported":
boolean
Readonly | Is multiple shipments supported enabled flag. | Example: true
"pickupInStoreEnabled":
boolean
Readonly | Is pickup in store enabled flag. | Example: true
"readyForShipmentMaximumTime":
string
Readonly | The maximum time for ready for shipment. | Example: 3
"readyForShipmentMinimumTime":
string
Readonly | The minimum time for ready for shipment. | Example: 1
"shippingMaximumTime":
string
Readonly | The maximum time for shipment. | Example: 7
"shippingMinimumTime":
string
Readonly | The minimum time for shipment. | Example: 2
}
}
"errors":
array
Readonly | An array of FeedbackRO_v1
objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1
:
An error or information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"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 information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"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.
}ContactRO application/json
{"name":
string
The name of an element. | Example: Patricia Miller
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: Contact
"email":
string
the email of the person contacting | Example: patricia@test.intershop.de
"phone":
string
the phone number of the person contacting | Example: 12345
"order":
string
the order number this contact refers to | Example: 54321
"subject":
string
the subject of the contact | Example: Order Inquiries
"comment":
string
the comment of the contact | Example: Where can I find the status of my order?
}ContactUsROResourceCollection application/json
{"pageable":
string
The pageable ID
"total":
integer
The pageable amount total | Format: int32
"offset":
integer
The pageable offset | Format: int32
"amount":
integer
The pageable amount | Format: int32
"elements":
array
An array of ContactRO
objects. The list of elements
[
ContactRO
{
"name":
string
The name of an element. | Example: Patricia Miller
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: Contact
"email":
string
the email of the person contacting | Example: patricia@test.intershop.de
"phone":
string
the phone number of the person contacting | Example: 12345
"order":
string
the order number this contact refers to | Example: 54321
"subject":
string
the subject of the contact | Example: Order Inquiries
"comment":
string
the comment of the contact | Example: Where can I find the status of my order?
}
]
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"sortKeys":
array
An array of string
literals. The keys to sort for
"name":
string
The name of an element.
}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 information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"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 information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"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 information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"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 information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"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 information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"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 information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"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. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"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.
}StoreROResourceCollection application/json
{"pageable":
string
The pageable ID
"total":
integer
The pageable amount total | Format: int32
"offset":
integer
The pageable offset | Format: int32
"amount":
integer
The pageable amount | Format: int32
"elements":
array
An array of StoreRO
objects. The list of elements
[
StoreRO
:
the list of elements{
"name":
string
The name of an element. | Example: Factory Outlet B5
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: StoreLocation
"postalCode":
string
the postal code of the stores location | Example: 14641
"city":
string
the city the store is located in | Example: Wustermark
"countryCode":
string
the country code of the store | Example: DE
"email":
string
the email address of the store | Example: b5@test.intershop.de
"fax":
string
the fax number of the store | Example: +49 (0) 33 234 - 90 420
"phoneBusiness":
string
the business phone number of the store | Example: +49 (0) 33 234 - 90 40
"phoneBusinessDirect":
string
"uuid":
string
the uuid of the store | Example: rPMKABsm2RsAAAFOI8ss9GK2
"address":
string
the address of the store | Example: Alter Spandauer Weg 1
}
]
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"sortKeys":
array
An array of string
literals. The keys to sort for
"name":
string
The name of an element.
}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.