openapi: 3.0.1 info: title: Shop description: "This is Intershop ICM REST API documentation. \n\nThis 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.\ \ \nThis reference is intended for developers who want to make use of an easy-to-use\ \ API when developing frontend solutions.\nYou can find more information at [Intershop\ \ Communications](https://www.intershop.com). Contact our Intershop experts at\ \ [Support - Intershop Communications](https://www.intershop.com/en/support) \ \ \n\n# Introduction\nThis API is documented in **OpenAPI format**.\n\n" version: 1.0.0 servers: - url: /INTERSHOP/rest/{serverGroup}/{siteName}/{appUrl} description: Intershop ICM Server variables: serverGroup: description: The server group default: WFS siteName: description: The site name default: inSPIRED-inTRONICS-Site appUrl: description: The application URL identifier enum: - smb-responsive default: '-' tags: - name: localizations description: "# Localizations\nThe localization API endpoint allows clients to obtain\ \ a list of localized texts or specific localization keys. All operations support\ \ different locales. In order to \nselect texts for a particular locale use matrix\ \ parameter ```loc```.\n\n## Example Usage\nFollowing (JUnit Test) example shows\ \ how to retrieve localized texts for a site:\n\n```\ncurl https:///INTERSHOP/rest/WFS//-/localizations\n\ ```\n " x-origin-class: com.intershop.beehive.platformrest.resource.localization.LocalizationResource paths: /configurations: get: tags: - Configuration summary: Returns the configuration details for given application. description: This operation returns the configuration details for the given application. operationId: getConfiguration responses: 200: description: The request was successful. content: application/vnd.intershop.configuration.v1+json: schema: $ref: '#/components/schemas/ConfigurationCtnrRO' 404: description: No application with this ID was found. content: application/vnd.intershop.configuration.v1+json: schema: $ref: '#/components/schemas/FeedbackCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.configuration.v1.capi.resource.configuration.ConfigurationListResource.getConfiguration() x-origin-class: com.intershop.sellside.rest.configuration.v1.capi.resource.configuration.ConfigurationListResource /contact: get: tags: - Contact summary: Get subjects for "Contact Us" description: Returns a list of subject that has to be used when "Contact Us" e-mail is requested. operationId: getSubjects responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/ContactUsROResourceCollection' text/xml: schema: $ref: '#/components/schemas/ContactUsROResourceCollection' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resource.contact.ContactResource$ContactUsROResourceCollection com.intershop.sellside.rest.common.capi.resource.contact.ContactResource.getSubjects() x-origin-class: com.intershop.sellside.rest.common.capi.resource.contact.ContactResource post: tags: - Contact summary: Send "Contact us" e-mail description: Triggers sending of "Contact Us" e-mail with data submitted with the request. operationId: sendMessage requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactRO' text/xml: schema: $ref: '#/components/schemas/ContactRO' responses: 201: description: Created 400: description: |- Bad request in case when submitted data is missing or invalid 404: description: |- Not found possible values for header error-key: - helpdesk.contact_us_not_found.error 500: description: |- Internal Server Error possible values for header error-key: - helpdesk.mail_not_sent.message security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public void com.intershop.sellside.rest.common.capi.resource.contact.ContactResource.sendMessage(com.intershop.sellside.rest.common.capi.resourceobject.ContactRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.contact.ContactResource /countries: get: tags: - Country summary: __BETA__ | Returns the available countries for the channel. description: Returns the available countries for the channel. operationId: getCountries_V1 responses: 200: description: The list of available countries. content: application/vnd.intershop.country.v1+json: schema: $ref: '#/components/schemas/GeoObjectListCtnrRO_v1' x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.country.v1.capi.resource.country.CountryListResource.getCountries_V1() x-origin-class: com.intershop.sellside.rest.country.v1.capi.resource.country.CountryListResource /countries/{countryCode}: get: tags: - Country summary: __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. operationId: getCountry_V1 parameters: - name: countryCode in: path required: true schema: type: string responses: 200: description: The requested country details. content: application/vnd.intershop.country.v1+json: schema: $ref: '#/components/schemas/GeoObjectCtnrRO_v1' 404: description: If a country with the given code is not found. content: application/vnd.intershop.country.v1+json: schema: $ref: '#/components/schemas/FeedbackCtnrRO_v1' x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.country.v1.capi.resource.country.CountryItemResource.getCountry_V1() x-origin-class: com.intershop.sellside.rest.country.v1.capi.resource.country.CountryItemResource /countries/{countryCode}/main-divisions: get: tags: - Country summary: __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. operationId: getMainDivisions_V1 parameters: - name: countryCode in: path required: true schema: type: string responses: 200: description: The list of available maindivisions. content: application/vnd.intershop.country.v1+json: schema: $ref: '#/components/schemas/GeoObjectListCtnrRO_v1' 404: description: If a country with the given code is not found. content: application/vnd.intershop.country.v1+json: schema: $ref: '#/components/schemas/FeedbackCtnrRO_v1' x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.country.v1.capi.resource.maindivision.MainDivisionListResource.getMainDivisions_V1() x-origin-class: com.intershop.sellside.rest.country.v1.capi.resource.maindivision.MainDivisionListResource /stores: get: tags: - Store Locator summary: Store locator description: Retrieves a list of stores and returns them to the client operationId: getStores parameters: - name: postalCode in: query description: a postal code, search expressions are supported schema: type: string - name: countryCode in: query description: country code in ISO format schema: type: string - name: city in: query description: city, search expressions are supported schema: type: string - name: storeName in: query description: name of the store, search expressions are supported schema: type: string - name: usePreference in: query description: 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. schema: type: boolean responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/StoreROResourceCollection' text/xml: schema: $ref: '#/components/schemas/StoreROResourceCollection' 204: description: No content security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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) x-origin-class: com.intershop.sellside.rest.common.capi.resource.store.locator.StoreLocatorResource '{loc}/localizations': get: tags: - localizations operationId: getLocalizations parameters: - $ref: '#/components/parameters/loc' responses: default: description: default response content: application/json: schema: type: object additionalProperties: type: string text/xml: schema: type: object additionalProperties: type: string x-origin-method: public java.util.Map com.intershop.beehive.platformrest.resource.localization.LocalizationResource.getLocalizations() x-origin-class: com.intershop.beehive.platformrest.resource.localization.LocalizationResource '{loc}/localizations/{key}': get: tags: - localizations operationId: getLocalization parameters: - $ref: '#/components/parameters/loc' - name: key in: path required: true schema: type: string responses: 200: description: OK content: text/plain: schema: type: string 204: description: No content x-origin-method: public java.lang.String com.intershop.beehive.platformrest.resource.localization.LocalizationResource.getLocalization(java.lang.String) x-origin-class: com.intershop.beehive.platformrest.resource.localization.LocalizationResource components: schemas: StoreRO: type: object properties: name: type: string description: The name of an element. example: Factory Outlet B5 xml: attribute: true type: type: string description: 'The type of the object. This is normally a **constant** that can be used to differentiate objects by their type. ' example: StoreLocation xml: attribute: true address2: type: string address3: type: string postalCode: type: string description: the postal code of the stores location example: "14641" city: type: string description: the city the store is located in example: Wustermark country: type: string countryCode: type: string description: the country code of the store example: DE email: type: string description: the email address of the store example: b5@test.intershop.de fax: type: string description: the fax number of the store example: +49 (0) 33 234 - 90 420 phoneBusiness: type: string description: the business phone number of the store example: +49 (0) 33 234 - 90 40 phoneBusinessDirect: type: string firstName: type: string lastName: type: string firstLastName: type: string uuid: type: string description: the uuid of the store example: rPMKABsm2RsAAAFOI8ss9GK2 address: type: string description: the address of the store example: Alter Spandauer Weg 1 description: the list of elements xml: name: StoreLocation StoreROResourceCollection: type: object properties: pageable: type: string description: The pageable ID total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/StoreRO' type: type: string description: 'The type of the object. This is normally a **constant** that can be used to differentiate objects by their type. ' xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: the keys to sort for xml: name: sortKey name: type: string description: The name of an element. xml: attribute: true xml: name: Stores ApplicationRO: title: ApplicationRO_v1 type: object properties: id: type: string description: Identifier of configuration. readOnly: true example: application applicationId: type: string description: The unique id of the application. readOnly: true example: 2vIKABsmU9oAAAFprwgZvAHX applicationType: type: string description: The type of the application. readOnly: true example: intershop.B2CResponsive displayName: type: string description: The name of the application. readOnly: true example: B2C - Responsive urlIdentifier: type: string description: The url identifier of the application. readOnly: true example: b2c-responsive default: type: boolean description: Is the application used as default flag. readOnly: true example: true description: Describes general data of an application. readOnly: true AttributeRO_v1: required: - name - type type: object properties: name: type: string description: The name of an element. type: type: string description: 'The type of the object. This is normally a **constant** that can be used to differentiate objects by their type. ' enum: - Boolean - Date - Decimal - Double - Integer - Long - Money - Quantity - String - Text - MultipleBoolean - MultipleDate - MultipleDecimal - MultipleDouble - MultipleInteger - MultipleLong - MultipleString value: type: object description: A representation of an attribute. discriminator: propertyName: type mapping: Boolean: '#/components/schemas/BooleanAttributeRO_v1' Date: '#/components/schemas/DateAttributeRO_v1' Decimal: '#/components/schemas/DecimalAttributeRO_v1' Double: '#/components/schemas/DoubleAttributeRO_v1' Integer: '#/components/schemas/IntegerAttributeRO_v1' Long: '#/components/schemas/LongAttributeRO_v1' Money: '#/components/schemas/MoneyAttributeRO_v1' Quantity: '#/components/schemas/QuantityAttributeRO_v1' String: '#/components/schemas/StringAttributeRO_v1' Text: '#/components/schemas/TextAttributeRO_v1' MultipleBoolean: '#/components/schemas/MultipleBooleanAttributeRO_v1' MultipleDate: '#/components/schemas/MultipleDateAttributeRO_v1' MultipleDecimal: '#/components/schemas/MultipleDecimalAttributeRO_v1' MultipleDouble: '#/components/schemas/MultipleDoubleAttributeRO_v1' MultipleInteger: '#/components/schemas/MultipleIntegerAttributeRO_v1' MultipleLong: '#/components/schemas/MultipleLongAttributeRO_v1' MultipleString: '#/components/schemas/MultipleStringAttributeRO_v1' oneOf: - $ref: '#/components/schemas/BooleanAttributeRO_v1' - $ref: '#/components/schemas/DateAttributeRO_v1' - $ref: '#/components/schemas/DecimalAttributeRO_v1' - $ref: '#/components/schemas/DoubleAttributeRO_v1' - $ref: '#/components/schemas/IntegerAttributeRO_v1' - $ref: '#/components/schemas/LongAttributeRO_v1' - $ref: '#/components/schemas/MoneyAttributeRO_v1' - $ref: '#/components/schemas/QuantityAttributeRO_v1' - $ref: '#/components/schemas/StringAttributeRO_v1' - $ref: '#/components/schemas/TextAttributeRO_v1' - $ref: '#/components/schemas/MultipleBooleanAttributeRO_v1' - $ref: '#/components/schemas/MultipleDateAttributeRO_v1' - $ref: '#/components/schemas/MultipleDecimalAttributeRO_v1' - $ref: '#/components/schemas/MultipleDoubleAttributeRO_v1' - $ref: '#/components/schemas/MultipleIntegerAttributeRO_v1' - $ref: '#/components/schemas/MultipleLongAttributeRO_v1' - $ref: '#/components/schemas/MultipleStringAttributeRO_v1' BasketSettingsRO: title: BasketSettingsRO_v1 type: object properties: id: type: string description: Identifier of configuration. readOnly: true example: basket expirationType: type: string description: The basket expiration type. readOnly: true example: Session addProductBehaviour: type: string description: The strategy for add products. readOnly: true example: Allow Repeats lifetime: type: string description: The basket lifetime. readOnly: true example: 28,800 maxItemSize: type: string description: The maximum number of line items. readOnly: true example: "50" maxItemQuantity: type: string description: The maximum item quantity per basket. readOnly: true example: "100" acceleration: type: boolean description: Is checkout acceleration enabled flag. readOnly: true example: false termsAndConditions: type: boolean description: Is terms and conditions enabled flag. readOnly: true example: true emailOptIn: type: boolean description: Is auto email Opt-In enabled flag. readOnly: true example: true displayTaxesAndFees: type: string description: The display taxes strategy. readOnly: true example: No taxes are displayed desiredDeliveryDate: type: boolean description: Is desired delivery date enabled flag. readOnly: true example: true deliveryExcludeSaturday: type: boolean description: Is saturday excluded for delivery flag. readOnly: true example: false deliveryExcludeSunday: type: boolean description: Is sunday excluded for delivery flag. readOnly: true example: true packSlipMessage: type: boolean description: Is pack slip message enabled flag. readOnly: true example: true packSlipMessageMaxLength: type: string description: The pack slip message maximum length. readOnly: true example: "42" giftWrap: type: boolean description: Is gift wrap enabled flag. readOnly: true example: true giftMessage: type: boolean description: Is gift message enabled flag. readOnly: true example: true giftMessageMaxLength: type: string description: The gift message maximum length. readOnly: true example: "450" description: Describes a basket configuration. readOnly: true BooleanAttributeRO_v1: required: - name - type - value type: object description: A representation of a boolean attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: boolean description: The boolean attribute value. CaptchaRO: title: CaptchaPreferenceRO_v1 type: object properties: id: type: string description: Identifier of configuration. readOnly: true example: captcha redemptionOfGiftCardsAndCertificates: type: boolean description: Is captcha for redemption of giftcards and certificates enabled flag. readOnly: true example: true forgotPassword: type: boolean description: Is captcha for forgot password enabled flag. readOnly: true example: true contactUs: type: boolean description: Is captcha for contact us enabled flag. readOnly: true example: false emailShoppingCart: type: boolean description: Is captcha for email shopping cart enabled flag. readOnly: true example: true register: type: boolean description: Is captcha for register enabled flag. readOnly: true example: true description: Describes the channel captcha preference. readOnly: true ConfigurationCtnrRO: title: ConfigurationListCtnrRO_v1 type: object properties: data: $ref: '#/components/schemas/ConfigurationRO' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. description: Optionally included related data objects. infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: 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. readOnly: true description: 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. readOnly: true ConfigurationRO: title: ConfigurationRO_v1 type: object properties: application: $ref: '#/components/schemas/ApplicationRO' attributes: type: array items: $ref: '#/components/schemas/AttributeRO_v1' basket: $ref: '#/components/schemas/BasketSettingsRO' captcha: $ref: '#/components/schemas/CaptchaRO' general: $ref: '#/components/schemas/GeneralSettingsRO' preferences: $ref: '#/components/schemas/PreferenceRO' pricing: $ref: '#/components/schemas/PricingPreferenceRO' services: $ref: '#/components/schemas/ServicesRO' shipping: $ref: '#/components/schemas/ShippingPreferenceRO' description: Describes a configuration. DateAttributeRO_v1: required: - name - type - value type: object description: A representation of a date/time attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: string description: The date/time attribute value. format: date-time example: 2020-05-23T13:23:45+02:00 DecimalAttributeRO_v1: required: - name - type - value type: object description: A representation of a decimal attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: number description: The decimal attribute value. DoubleAttributeRO_v1: required: - name - type - value type: object description: A representation of a double attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: number description: The double attribute value. format: double FeedbackCauseRO_v1: required: - code - message type: object properties: code: type: string description: An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). example: invoiceToAddress.address.postalcode.invalid message: type: string description: 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: type: object additionalProperties: type: object description: A map of several parameters that are used to assemble the message. description: A map of several parameters that are used to assemble the message. paths: type: array description: A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. externalDocs: url: https://github.com/json-path/JsonPath items: type: string description: A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. externalDocs: url: https://github.com/json-path/JsonPath description: A representation for the common feedback informations. FeedbackRO_v1: type: object properties: causes: type: array description: A collection of errors/infos that caused this feedback. items: $ref: '#/components/schemas/FeedbackCauseRO_v1' code: type: string description: An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). example: invoiceToAddress.address.postalcode.invalid message: type: string description: 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: type: object additionalProperties: type: object description: A map of several parameters that are used to assemble the message. description: A map of several parameters that are used to assemble the message. paths: type: array description: A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. externalDocs: url: https://github.com/json-path/JsonPath items: type: string description: A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. externalDocs: url: https://github.com/json-path/JsonPath status: type: string description: The HTTP status code, that is applicable to this problem. example: "400" description: An error or information representation regarding the current request. readOnly: true GeneralSettingsRO: title: GeneralSettingsRO_v1 type: object properties: id: type: string description: Identifier of configuration. readOnly: true example: general defaultCurrency: type: string description: The default currency. readOnly: true example: USD defaultLocale: type: string description: The default locale. readOnly: true example: en_US currencies: type: array description: The available currencies. readOnly: true example: USD items: type: string description: The available currencies. readOnly: true example: '"USD"' locales: type: array description: The available locales. readOnly: true example: en_US items: type: string description: The available locales. readOnly: true example: '"en_US"' description: Describes a general configuration values of an application. readOnly: true IntegerAttributeRO_v1: required: - name - type - value type: object description: A representation of an integer attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: integer description: The integer attribute value. format: int32 LongAttributeRO_v1: required: - name - type - value type: object description: A representation of a long attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: integer description: The long attribute value. format: int64 MoneyAttributeRO_v1: required: - name - type - value type: object description: A representation of a money attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: $ref: '#/components/schemas/MoneyRO_v1' MoneyRO_v1: type: object properties: currency: type: string description: Three-letter currency code (ISO 4217) of the monetary value. readOnly: true example: USD value: type: number description: The monetary value. readOnly: true example: 10.99 description: Describes a money object. MultipleBooleanAttributeRO_v1: required: - name - type - value type: object description: A representation of a multiple boolean attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: array description: The multiple boolean attribute value. items: type: boolean description: The multiple boolean attribute value. MultipleDateAttributeRO_v1: required: - name - type - value type: object description: A representation of a multiple date/time attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: array description: The multiple date/time attribute value. items: type: string description: The multiple date/time attribute value. format: date-time MultipleDecimalAttributeRO_v1: required: - name - type - value type: object description: A representation of a multiple decimal attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: array description: The multiple decimal attribute value. items: type: number description: The multiple decimal attribute value. MultipleDoubleAttributeRO_v1: required: - name - type - value type: object description: A representation of a multiple double attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: array description: The multiple double attribute value. items: type: number description: The multiple double attribute value. format: double MultipleIntegerAttributeRO_v1: required: - name - type - value type: object description: A representation of a multiple integer attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: array description: The multiple integer attribute value. items: type: integer description: The multiple integer attribute value. format: int32 MultipleLongAttributeRO_v1: required: - name - type - value type: object description: A representation of a multiple long attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: array description: The multiple long attribute value. items: type: integer description: The multiple long attribute value. format: int64 MultipleStringAttributeRO_v1: required: - name - type - value type: object description: A representation of a multiple string attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: array description: The multiple string attribute value. items: type: string description: The multiple string attribute value. PreferenceRO: title: PreferenceRO_v1 type: object properties: id: type: string description: Identifier of configuration. readOnly: true example: preferences description: Describes a list of preferences. readOnly: true PricingPreferenceRO: title: PricingPreferenceRO_v1 type: object properties: id: type: string description: Identifier of configuration. readOnly: true example: pricing priceType: type: string description: The price type for the channel. readOnly: true example: net privateCustomerPriceDisplayType: type: string description: The price type that is shown in the storefront to private customers. readOnly: true example: net smbCustomerPriceDisplayType: type: string description: The price type that is shown in the storefront to smb customers. readOnly: true example: gross defaultCustomerTypeForPriceDisplay: type: string description: Customer type which is used for logged-out customers. readOnly: true example: PRIVATE description: Describes the channel pricing preference. readOnly: true QuantityAttributeRO_v1: required: - name - type - value type: object description: A representation of a quantity attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: $ref: '#/components/schemas/QuantityRO_v1' QuantityRO_v1: required: - value type: object properties: unit: type: string description: The quantity's unit code. example: kg value: type: number description: The quantity's value. example: 10 description: A quantity of a business entity. ServicesRO: title: ServicesRO_v1 type: object properties: id: type: string description: Identifier of configuration. readOnly: true example: services description: Describes the managed sevices preferences. readOnly: true ShippingPreferenceRO: title: ShippingPreferenceRO_v1 type: object properties: bucketSurchargeBehavior: type: string description: The default behavior of bucket surcharge. readOnly: true example: Lowest id: type: string description: Identifier of configuration. readOnly: true example: shipping itemImportSurchargeBehavior: type: string description: The default behavior of item import surcharge. readOnly: true example: Highest itemSurchargeBehavior: type: string description: The default behavior of item surcharge. readOnly: true example: AddAll multipleShipmentsSupported: type: boolean description: Is multiple shipments supported enabled flag. readOnly: true example: true pickupInStoreEnabled: type: boolean description: Is pickup in store enabled flag. readOnly: true example: true readyForShipmentMaximumTime: type: string description: The maximum time for ready for shipment. readOnly: true example: "3" readyForShipmentMinimumTime: type: string description: The minimum time for ready for shipment. readOnly: true example: "1" shippingMaximumTime: type: string description: The maximum time for shipment. readOnly: true example: "7" shippingMinimumTime: type: string description: The minimum time for shipment. readOnly: true example: "2" description: Describes the channel shipping preference. readOnly: true StringAttributeRO_v1: required: - name - type - value type: object description: A representation of a string attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: string description: The string attribute value. TextAttributeRO_v1: required: - name - type - value type: object description: A representation of a text attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: string description: The text attribute value. FeedbackCtnrRO_v1: type: object properties: errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. description: Optionally included related data objects. infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: 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. readOnly: true description: 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. readOnly: true GeoObjectListCtnrRO_v1: type: object properties: data: type: array description: The core data of the response object. items: $ref: '#/components/schemas/GeoObjectRO_v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. description: Optionally included related data objects. infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: 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. readOnly: true description: 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. readOnly: true GeoObjectRO_v1: type: object properties: id: type: string description: The id of the geoobject. readOnly: true example: US name: type: string description: The name of an element. readOnly: true example: United States description: Describes a geoobject which can be a country or maindivision/state. GeoObjectCtnrRO_v1: type: object properties: data: $ref: '#/components/schemas/GeoObjectRO_v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. description: Optionally included related data objects. infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: 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. readOnly: true description: 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. readOnly: true ContactRO: type: object properties: name: type: string description: The name of an element. example: Patricia Miller xml: attribute: true type: type: string description: 'The type of the object. This is normally a **constant** that can be used to differentiate objects by their type. ' example: Contact xml: attribute: true email: type: string description: the email of the person contacting example: patricia@test.intershop.de phone: type: string description: the phone number of the person contacting example: "12345" order: type: string description: the order number this contact refers to example: "54321" subject: type: string description: the subject of the contact example: Order Inquiries comment: type: string description: the comment of the contact example: Where can I find the status of my order? description: the list of elements xml: name: Contact ContactUsROResourceCollection: type: object properties: pageable: type: string description: The pageable ID total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/ContactRO' type: type: string description: 'The type of the object. This is normally a **constant** that can be used to differentiate objects by their type. ' xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: the keys to sort for xml: name: sortKey name: type: string description: The name of an element. xml: attribute: true xml: name: Subjects responses: 200: description: OK 201: description: Created 202: description: Accepted 204: description: No Content 205: description: Reset Content 206: description: Partial Content 301: description: Moved Permanently 302: description: Found 303: description: See Other 304: description: Not Modified 305: description: Use Proxy 307: description: Temporary Redirect 400: description: Bad Request 401: description: Unauthorized 402: description: Payment Required 403: description: Forbidden 404: description: Not Found 405: description: Method Not Allowed 406: description: Not Acceptable 407: description: Proxy Authentication Required 408: description: Request Timeout 409: description: Conflict 410: description: Gone 411: description: Length Required 412: description: Precondition Failed 413: description: Request Entity Too Large 414: description: Request-URI Too Long 415: description: Unsupported Media Type 416: description: Requested Range Not Satisfiable 417: description: Expectation Failed 500: description: Internal Server Error 501: description: Not Implemented 502: description: Bad Gateway 503: description: Service Unavailable 504: description: Gateway Timeout 505: description: HTTP Version Not Supported parameters: loc: name: loc in: path description: The locale ID (submitted as optional matrix parameter ```;loc=```). If omitted, the site's or user's default locale is used. required: false style: matrix schema: type: string description: The locale ID (submitted as optional matrix parameter ```;loc=```). If omitted, the site's or user's default locale is used. default: en_US examples: en_US: description: English (United States) value: en_US fr_FR: description: French (France) value: fr_FR de_DE: description: German (Germany) value: de_DE x-matrixParamPath: / cur: name: cur in: path description: The currency code (submitted as optional matrix parameter ```;cur=```). If omitted, the site's or user's default currency is used. required: false style: matrix schema: type: string description: The currency code (submitted as optional matrix parameter ```;cur=```). If omitted, the site's or user's default currency is used. default: USD examples: FJD: description: Fiji Dollar value: FJD STD: description: São Tomé / Príncipe Dobra value: STD MXN: description: Mexican Peso value: MXN SCR: description: Seychelles Rupee value: SCR LVL: description: Latvian Lats value: LVL CDF: description: Congolese Franc value: CDF GTQ: description: Guatemalan Quetzal value: GTQ BBD: description: Barbados Dollar value: BBD CLP: description: Chilean Peso value: CLP UGX: description: Ugandan Shilling value: UGX HNL: description: Honduran Lempira value: HNL ZAR: description: South African Rand value: ZAR TND: description: Tunisian Dinar value: TND SLL: description: Sierra Leonean Leone value: SLL BSD: description: Bahamian Dollar value: BSD SDG: description: Sudanese Pound value: SDG IQD: description: Iraqi Dinar value: IQD GMD: description: Gambian Dalasi value: GMD CUP: description: Cuban Peso value: CUP TWD: description: New Taiwan Dollar value: TWD RSD: description: Serbian Dinar value: RSD ZRZ: description: Zaire value: ZRZ DOP: description: Dominican Peso value: DOP KMF: description: Comoro Franc value: KMF MYR: description: Malaysian Ringgit value: MYR FKP: description: Falkland Islands Pound value: FKP XOF: description: CFA Franc BCEAO value: XOF GEL: description: Lari value: GEL UYU: description: Uruguayan Peso value: UYU MAD: description: Moroccan Dirham value: MAD CVE: description: Cape Verde Escudo value: CVE TOP: description: Tongan Pa'anga value: TOP PGK: description: Papua New Guinean Kina value: PGK OMR: description: Omani Rial value: OMR AZN: description: Azerbaijanian Manat value: AZN SEK: description: Swedish Krona value: SEK KES: description: Kenyan Shilling value: KES UAH: description: Ukrainian Hryvnia value: UAH BTN: description: Ngultrum value: BTN GNF: description: Guinea Franc value: GNF MZN: description: Mozambican Metical value: MZN ERN: description: Nakfa value: ERN SVC: description: Salvadoran Colón value: SVC ARS: description: Argentine Peso value: ARS QAR: description: Qatari Riyal value: QAR NLG: description: Dutch Guilder value: NLG IRR: description: Iranian Rial value: IRR MRO: description: Mauritanian Ouguiya value: MRO XPF: description: CFP Franc value: XPF UZS: description: Uzbekistani Som value: UZS THB: description: Thai Baht value: THB CNY: description: Yuan Renminbi value: CNY BDT: description: Bangladeshi Taka value: BDT LYD: description: Libyan Dinar value: LYD BMD: description: Bermudian Dollar value: BMD PHP: description: Philippine Peso value: PHP KWD: description: Kuwaiti Dinar value: KWD RUB: description: Russian Ruble value: RUB PYG: description: Paraguayan Guarani value: PYG JMD: description: Jamaican Dollar value: JMD ISK: description: Iceland Krona value: ISK GWP: description: Guinea Peso value: GWP BEF: description: Belgian Franc value: BEF ESP: description: Spanish Peseta value: ESP COP: description: Colombian Peso value: COP USD: description: US Dollar value: USD MKD: description: Denar value: MKD DZD: description: Algerian Dinar value: DZD PAB: description: Panamanian Balboa value: PAB SGD: description: Singapore Dollar value: SGD ETB: description: Ethiopian Birr value: ETB VUV: description: Vanuatu Vatu value: VUV VEF: description: Venezuelan Bolivar Fuerte value: VEF SOS: description: Somali Shilling value: SOS KGS: description: Som value: KGS LAK: description: Lao Kip value: LAK ZMK: description: Zambian Kwacha value: ZMK BND: description: Brunei Dollar value: BND XAF: description: CFA Franc BEAC value: XAF LRD: description: Liberian Dollar value: LRD ITL: description: Italian Lira value: ITL HRK: description: Croatian Kuna value: HRK CHF: description: Swiss Franc value: CHF ATS: description: Austrian Schilling value: ATS DJF: description: Djibouti Franc value: DJF ALL: description: Albanian Lek value: ALL MTL: description: Maltese Lira value: MTL TZS: description: Tanzanian Shilling value: TZS VND: description: Vietnamese Dong value: VND AUD: description: Australian Dollar value: AUD ILS: description: New Israeli Sheqel value: ILS KPW: description: North Korean Won value: KPW GYD: description: Guyanese Dollar value: GYD GHS: description: Ghanaian Cedi value: GHS MDL: description: Moldovan Leu value: MDL KHR: description: Cambodian Riel value: KHR BOB: description: Boliviano value: BOB IDR: description: Indonesian Rupiah value: IDR KYD: description: Cayman Islands Dollar value: KYD AMD: description: Armenian Dram value: AMD TRY: description: Turkish Lira value: TRY SHP: description: Saint Helena Pound value: SHP BWP: description: Botswana Pula value: BWP LBP: description: Lebanese Pound value: LBP CYP: description: Cyprus Pound value: CYP TJS: description: Tajikistani Somoni value: TJS JOD: description: Jordanian Dinar value: JOD RWF: description: Rwanda Franc value: RWF HKD: description: Hong Kong Dollar value: HKD AED: description: United Arab Emirates Dirham value: AED EUR: description: Euro value: EUR LSL: description: Lesotho Loti value: LSL DKK: description: Danish Krone value: DKK CAD: description: Canadian Dollar value: CAD BGN: description: Bulgarian Lev value: BGN MMK: description: Kyat value: MMK EEK: description: Estonian Kroon value: EEK SYP: description: Syrian Pound value: SYP NOK: description: Norwegian Krone value: NOK MUR: description: Mauritian Rupee value: MUR ZWL: description: Zimbabwean Dollar value: ZWL GIP: description: Gibraltar Pound value: GIP RON: description: Romanian New Leu value: RON LKR: description: Sri Lankan Rupee value: LKR NGN: description: Nigerian Naira value: NGN IEP: description: Irish Pound value: IEP CZK: description: Czech Koruna value: CZK CRC: description: Costa Rican Colon value: CRC PKR: description: Pakistani Rupee value: PKR XCD: description: East Carribean Dollar value: XCD GRD: description: Greek Drachma value: GRD HTG: description: Haitian Gourde value: HTG ANG: description: Netherlands Antillian Guilder value: ANG SIT: description: Slovenian Tolar value: SIT BHD: description: Bahraini Dinar value: BHD PTE: description: Portuguese Escudo value: PTE BPP: description: Bonus Point Price value: BPP SZL: description: Swazi Lilangeni value: SZL SRD: description: Surinam Dollar value: SRD KZT: description: Kazakhstani Tenge value: KZT TTD: description: Trinidad and Tobago Dollar value: TTD SAR: description: Saudi Riyal value: SAR LTL: description: Lithuanian Litas value: LTL YER: description: Yemeni Rial value: YER MVR: description: Maldivian Rufiyaa value: MVR BPV: description: Bonus Point Value value: BPV AFN: description: Afghani value: AFN INR: description: Indian Rupee value: INR NPR: description: Nepalese Rupee value: NPR KRW: description: South Korean Won value: KRW AWG: description: Aruban Florin value: AWG MNT: description: Mongolian Tugrik value: MNT JPY: description: Japanese Yen value: JPY PLN: description: Polish Zloty value: PLN AOA: description: Angolan Kwanza value: AOA SBD: description: Solomon Islands Dollar value: SBD GBP: description: Pound Sterling value: GBP HUF: description: Hungarian Forint value: HUF BYR: description: Belarussian Ruble value: BYR LUF: description: Luxembourgian Franc value: LUF BIF: description: Burundi Franc value: BIF MWK: description: Malawian Kwacha value: MWK MGA: description: Malagasy Ariary value: MGA FIM: description: Finnish Mark value: FIM DEM: description: Deutsche Mark value: DEM BZD: description: Belize Dollar value: BZD BAM: description: Convertible Marks value: BAM MOP: description: Macanese Pataca value: MOP EGP: description: Egyptian Pound value: EGP NAD: description: Namibian Dollar value: NAD SKK: description: Slovakian Krona value: SKK NIO: description: Cordoba Oro value: NIO PEN: description: Peruvian Nuevo Sol value: PEN WST: description: Samoan Tala value: WST NZD: description: New Zealand Dollar value: NZD TMT: description: Turkmenistani Manat value: TMT FRF: description: French Franc value: FRF BRL: description: Brazilian Real value: BRL x-matrixParamPath: / regionals: name: regionals in: path required: true style: matrix schema: type: object properties: loc: type: string description: The locale ID example: en_US cur: type: string description: The currency code example: EUR x-matrixParamPath: / pgid: name: pgid in: path description: The personal group identifier (submitted as matrix parameter ```;pgid=```). required: true style: matrix schema: type: string description: The personal group identifier (submitted as matrix parameter ```;pgid=```). example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 spgid: name: spgid in: path description: The secure personal group identifier (submitted as matrix parameter ```;spgid=```). required: true style: matrix schema: type: string description: The secure personal group identifier (submitted as matrix parameter ```;spgid=```). example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 securitySchemes: basicAuth: type: http description: 'Basic access authentication. In basic authentication, a request contains a header field in the form of authorization: ```Basic ```, where credentials is the Base64 encoding of ID and password joined by a single colon :.' scheme: basic authToken: type: apiKey description: User authentication token to authenticate the request. The token is a string generated by the ICM server in the same header in every response of an REST endpoint. name: authentication-token in: header bearerAuth: type: http description: 'Bearer token authentication. A request contains a header field in the form of authorization: ```Bearer ```, where is a string generated by an authentication service in response to a login request.' scheme: bearer bearerFormat: JWT x-apiID: shop x-origin-class: com.intershop.component.rest.capi.resource.RootResource,com.intershop.sellside.rest.common.capi.resource.contact.ContactResource,com.intershop.sellside.rest.common.capi.resource.contact.ContactResource,com.intershop.sellside.rest.common.capi.resource.contact.ContactResource,com.intershop.sellside.rest.common.capi.resource.contact.ContactResource,com.intershop.sellside.rest.common.capi.resource.contact.ContactResource