Reference - ICM REST API - B2C Front End - Shop 1.0.0


Product Version

7.10

Product To Version


Status

final

Download Specification 

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

API Specification

Introduction

OpenAPI Version: 3.0.1
Shop Version: 1.0.0

This is Intershop ICM REST API documentation.

This reference lists the REST API for storefront development. The REST API covers features of both, the B2C (SMB - Small and Medium-sized businesses) and the B2B storefront development.
This reference is intended for developers who want to make use of an easy-to-use API when developing frontend solutions.
You can find more information at Intershop Communications. Contact our Intershop experts at Support - Intershop Communications

Introduction

This API is documented in OpenAPI format.

Configuration API

/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/json

404 - Not Found

No application with this ID was found.
FeedbackCtnrRO_v1 application/json

Contact API

/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 when 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

Country API

/countries
GET: [BETA] 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/json
/countries/{countryCode}
GET: [BETA] 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

LocationNameFormatDescription
in pathcountryCodestringRequired

Response

200 - OK

The requested country details.
GeoObjectCtnrRO_v1 application/json

404 - Not Found

If a country with the given code is not found.
FeedbackCtnrRO_v1 application/json
/countries/{countryCode}/main-divisions
GET: [BETA] 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

LocationNameFormatDescription
in pathcountryCodestringRequired

Response

200 - OK

The list of available maindivisions.
GeoObjectListCtnrRO_v1 application/json

404 - Not Found

If a country with the given code is not found.
FeedbackCtnrRO_v1 application/json

Store Locator API

/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

LocationNameFormatDescription
in querypostalCodestringa postal code, search expressions are supported
in querycountryCodestringcountry code in ISO format
in querycitystringcity, search expressions are supported
in querystoreNamestringname of the store, search expressions are supported
in queryusePreferencebooleanIf 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

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 matrix parameter loc.

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:

Description

--

Java Method

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

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathlocstringThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used. | Default: en_US

Response

default - Unknown

default response
{loc}/localizations/{key}
GET:

Description

--

Java Method

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

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathlocstringThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used. | Default: en_US
in pathkeystringRequired

Response

200 - OK

204 - No Content

Request and Response Object Schemata

ConfigurationCtnrRO application/json{
  • "data":
    object
    A ConfigurationRO object. Describes a configuration.
    {
    • "application":
      object
      A ApplicationRO object. Describes general data of an application.
      {
      • "id":
        string
        Readonly | Identifier of configuration. | Example: application
      • "applicationId":
        string
        Readonly | The unique id of the application. | Example: 2vIKABsmU9oAAAFprwgZvAHX
      • "applicationType":
        string
        Readonly | The type of the application. | Example: intershop.B2CResponsive
      • "displayName":
        string
        Readonly | The name of the application. | Example: B2C - 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
      An array of AttributeRO_v1 objects.
      [
      AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
      {
      • "name":
        string
        Required | The name of an element.
      • "type":
        string
        Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
      • "value":
        object
      }
      ]
    • "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
      • "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
        Readonly | Is desired delivery date enabled flag. | Example: true
      • "deliveryExcludeSaturday":
        boolean
        Readonly | Is saturday excluded for delivery flag. | Example: false
      • "deliveryExcludeSunday":
        boolean
        Readonly | Is sunday excluded for delivery flag. | 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
      • "locales":
        array
        Readonly | An array of string literals. The available locales. | Example: en_US
      }
    • "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
      • "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: the list of elements
    {
    • "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/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/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/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
    • "address2":
      string
    • "address3":
      string
    • "postalCode":
      string
      the postal code of the stores location | Example: 14641
    • "city":
      string
      the city the store is located in | Example: Wustermark
    • "country":
      string
    • "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
    • "firstName":
      string
    • "lastName":
      string
    • "firstLastName":
      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.
}

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.

Customer Support
Knowledge Base
Product Resources
Tickets