Document Tree
Document Properties
Kbid
310F53
Last Modified
06-Nov-2023
Added to KB
08-Nov-2023
Public Access
Everyone
Status
Online
Doc Type
References
Product
ICM 11
Home ⋮ Knowledge Base
Reference - Configuration REST API 1.1.0
Share this document
ReDoc View
Document View


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 11 and their version dependencies:

API Specification

Introduction
OpenAPI Version: 3.0.1
Configuration Version: 1.1.0

The Configuration REST API provides configuration details.

Changelog

Version 1.1.0

  • BETA | Added new configuration section "customFieldDefinitions" to the REST endpoint GET /configurations (ConfigurationRO_v1)

Version 1.0.0

  • Created a separate REST API 'Configuration' out of 'Shop'
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 jakarta.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
Request and Response Object Schemata
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.REST
      • "displayName":
        string
        Readonly | The application's display name | Example: REST
      • "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
      • "lineItemPositionHandling":
        string
        Readonly | The strategy for line item positioning. | Example: AssignAndReassign
      • "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
      • "partialOrderNo":
        boolean
        Readonly | Flag to set the partial order number on line item level. | Example: true
      • "customerProductID":
        boolean
        Readonly | Flag to set the customer product id on line item level. | Example: true
      }
    • "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
      }
    • "customFieldDefinitions":
      array
      Readonly | An array of CustomFieldDefinitionRO_v1 objects. BETA | The collection of the custom field definitions
      [
      CustomFieldDefinitionRO_v1: __BETA__ | A representation of a custom field definition.
      {
      • "description":
        string
        Readonly | The localized custom field description.
      • "displayName":
        string
        Readonly | The localized display name of the custom field. | Example: Delivery Preference
      • "name":
        string
        Readonly | The name of an element | Example: deliveryPreference
      • "position":
        integer
        Readonly | The position of the custom field in the list of custom fields. | Format: int32 | Example: 1
      • "scopes":
        array
        Readonly | An array of CustomFieldDefinitionScopeRO_v1 objects. A list of configured scopes for this custom field.
        [
        CustomFieldDefinitionScopeRO_v1: __BETA__ | A representation of a custom field definition scope.
        {
        • "isEditable":
          boolean
          Readonly | Flag indicating whether a custom field can be edited or not. | Example: true
        • "isVisible":
          boolean
          Readonly | Flag indicating whether a custom field is visible or not. | Example: true
        • "name":
          string
          Readonly | The name of an element | Example: Basket
        }
        ]
      • "type":
        string
        Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: String
      }
      ]
    • "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"
      • "customerTypeForLoginApproval":
        array
        An array of string literals. List of customer types to be checked for login purposes. | Example: "PRIVATE","SMB"
      }
    • "marketing":
      object
      A MarketingPreferenceRO object. Describes the channel marketing preferences.
      {
      • "id":
        string
        Readonly | Identifier of the configuration. | Example: marketing
      • "newsletterSubscriptionEnabled":
        boolean
        Readonly | Indicates whether the newsletter subscription is enabled (e-mail marketing provider is defined). | Example: true
      }
    • "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
      • "messageToMerchant":
        boolean
        Readonly | Is message to merchant enabled flag. | Example: true
      • "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 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.
}
FeedbackCtnrRO_v1 application/vnd.intershop.configuration.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.
}
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.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Home
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.