openapi: 3.0.1 info: title: Customer Management description: |- The _Customer Management REST API_ contains resources that allow to execute all major actions required for managing customers in Intershop Commerce Management (back office). It covers private customers as well as SMB customers and their assigned users and addresses. For more information on customers and users, refer to [Concept - Customers and Users](https://support.intershop.com/kb/2410D0). Please contact our Intershop experts at [Support - Intershop Communications](https://www.intershop.com/en/support) if you have any questions about this API. #### API Versioning & Accept-Header Media-type-based versioning is used to distinguish between different API versions. For requests to the _Customer Management REST API 1.x_, the REST client must set the following HTTP ```Accept``` header: ```Accept: application/vnd.intershop.admin.customer.v1+json``` ## Changelog - - - ### Version 1.0.2 * `ID` attributes of `UserRO_v1`, `CustomerRO_v1` and `AddressRO_v1` are no longer URL-encoded * URLs in the link section of the responses are now properly URL-encoded ### Version 1.0.1 * Added this changelog * Set `application/json` as the required content type for all POST and PATCH API requests * Fixed several typos in the API documentation contact: name: Intershop Communications AG url: http://intershop.com version: 1.0.2 servers: - url: "/INTERSHOP/rest/{serverGroup}/{siteName}/{appUrl}" description: Intershop ICM Server variables: serverGroup: description: The server group enum: - BOS - JOB - WFS default: WFS siteName: description: The site name default: inSPIRED-Site appUrl: description: The application URL identifier enum: - inTRONICS - inTRONICS-b2c-responsive - inTRONICS-smb-responsive - inTRONICS-rest - inTRONICS_Business - inTRONICS_Business-smb-responsive - inTRONICS_Business-rest - ShoppingLive - ShoppingLive-b2c-responsive - inTRONICS-example - rest - rest-rest default: inTRONICS-rest paths: /customers: post: tags: - General summary: __BETA__ | Creates a new customer. description: 'This operation creates a new customer with the given ID. ' operationId: createCustomer_V1 requestBody: description: The object containing the initial data to be set at the customer content: application/json: schema: $ref: "#/components/schemas/CustomerRO_v1" responses: "201": description: The customer was successfully created. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "422": description: The customer could not be created because of semantic errors in the initial data. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.CustomerListResource.createCustomer_V1(com.intershop.backoffice.rest.customer.v1.capi.resourceobject.customer.CustomerRO) x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.CustomerListResource /customers/{customerId}: get: tags: - General summary: __BETA__ | Returns the customer with the given ID description: This operation returns the customer with the given ID. operationId: getCustomer_V1 parameters: - name: include in: query description: Related objects (as a comma-separated list) which are to be included with the response schema: type: string default: "" - name: customerId in: path required: true schema: type: string responses: "200": description: Information message describing success status. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "404": description: A customer with the given ID could not be found. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.CustomerItemResource.getCustomer_V1(java.lang.String) x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.CustomerItemResource delete: tags: - General summary: __BETA__ | Deletes the customer with the given ID description: 'This operation deletes the customer with the given ID. ' operationId: deleteCustomer_V1 parameters: - name: customerId in: path required: true schema: type: string responses: "200": description: Information message describing success status. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "404": description: A customer with the given ID could not be found. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.CustomerItemResource.deleteCustomer_V1() x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.CustomerItemResource patch: tags: - General summary: __BETA__ | Partially updates the customer with the given ID description: 'This operation updates the customer with the given ID partially. ' operationId: updateCustomer_V1 parameters: - name: customerId in: path required: true schema: type: string requestBody: description: The object containing the data to update the customer with the given ID content: application/json: schema: $ref: "#/components/schemas/CustomerRO_v1" responses: "200": description: The customer was successfully updated. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "404": description: A customer with the given ID could not be found. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.CustomerItemResource.updateCustomer_V1(com.intershop.backoffice.rest.customer.v1.capi.resourceobject.customer.CustomerRO) x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.CustomerItemResource /customers/{customerId}/addresses: post: tags: - Addresses summary: __BETA__ | Adds a new address to the basket description: "This operation adds a new address to the basket. If an address\ \ with initial data is passed, these data will be set at the newly created\ \ address." operationId: createCustomerAddress_V1 parameters: - name: include in: query description: Related objects which are to be included with the response schema: type: string default: "" - name: customerId in: path required: true schema: type: string requestBody: description: The objects containing the initial data for creating the address content: application/json: schema: $ref: "#/components/schemas/AddressRO_v1" responses: "201": description: The new address was successfully created. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AddressListCtnrRO_v1" "422": description: The address could not be created because of semantic errors in the provided data. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/FeedbackCtnrRO_v1" "401": $ref: "#/components/responses/401" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.CustomerAddressListResource.createAddress_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO,java.lang.String)" x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.CustomerAddressListResource /customers/{customerId}/addresses/{addressId}: get: tags: - Addresses summary: __BETA__ | Returns the address for a given ID description: 'This operation returns the customer''s address for a given ID. ' operationId: getCustomerAddress_V1 parameters: - name: include in: query description: Related objects (as a comma-separated list) which are to be included with the response. schema: type: string default: "" - name: customerId in: path required: true schema: type: string - name: addressId in: path required: true schema: type: string responses: "200": description: The address with the given ID. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AddressCtnrRO_v1" "404": description: An address with the given ID could not be found for the given customer. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/FeedbackCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.CustomerAddressItemResource.getAddress_V1(java.lang.String) x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.CustomerAddressItemResource delete: tags: - Addresses summary: __BETA__ | Deletes the address with a given ID description: This operation deletes a customer's address with a given ID. operationId: deleteCustomerAddress_V1 parameters: - name: customerId in: path required: true schema: type: string - name: addressId in: path required: true schema: type: string responses: "200": description: Information message describing success status. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AddressCtnrRO_v1" "404": description: An address with the given ID could not be found for the given customer. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/FeedbackCtnrRO_v1" "422": description: The address could not be deleted. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AddressCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.CustomerAddressItemResource.deleteAddress_V1() x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.CustomerAddressItemResource patch: tags: - Addresses summary: __BETA__ | Partially updates an address with a given ID description: This operation updates a customer's address with a given ID partially. operationId: updateAddress_V1 parameters: - name: include in: query description: Related objects which are to be included with the response. schema: type: string default: "" - name: customerId in: path required: true schema: type: string - name: addressId in: path required: true schema: type: string requestBody: description: The object containing the data to update the address with a given ID. content: application/json: schema: $ref: "#/components/schemas/AddressRO_v1" responses: "200": description: The updated address. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AddressCtnrRO_v1" "404": description: An address with the given ID could not be found for the customer. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/FeedbackCtnrRO_v1" "422": description: The address could not be updated. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AddressCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.CustomerAddressItemResource.updateAddress_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO,java.lang.String)" x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.CustomerAddressItemResource /customers/{customerId}/addresses/{addressId}/attributes: get: tags: - Addresses summary: __BETA__ | Returns all custom attributes for the address description: This operation returns all custom attributes for the address. operationId: getCustomerAddressAttributes_V1 parameters: - name: include in: query description: Related objects (as a comma-separated list) which are to be included with the response. schema: type: string default: "" - name: customerId in: path required: true schema: type: string - name: addressId in: path required: true schema: type: string responses: "200": description: The list of attributes. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeListCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.attribute.CustomerAddressAttributeListResource.getAttributes_V1(java.lang.String) x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.attribute.CustomerAddressAttributeListResource post: tags: - Addresses summary: __BETA__ | Creates a new (custom) attribute at the address description: This operation creates a new custom attribute for the address. The name of the attribute is used as identifier for the created sub resource. operationId: createCustomerAddressAttribute_V1 parameters: - name: include in: query description: Related objects (as a comma-separated list) which are to be included with the response schema: type: string default: "" - name: customerId in: path required: true schema: type: string - name: addressId in: path required: true schema: type: string requestBody: description: The object containing the attribute data content: application/json: schema: $ref: "#/components/schemas/AttributeRO_v1" responses: "201": description: The attribute was successfully created. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "422": description: The attribute could not be created because of semantic errors in the provided data. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.attribute.CustomerAddressAttributeListResource.createAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)" x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.attribute.CustomerAddressAttributeListResource /customers/{customerId}/addresses/{addressId}/attributes/{attributeId}: delete: tags: - Addresses summary: __BETA__ | Deletes the custom attribute from the user description: This operation deletes the custom attribute from the user. operationId: deleteCustomerAddressAttribute_V1 parameters: - name: customerId in: path required: true schema: type: string - name: addressId in: path required: true schema: type: string - name: attributeId in: path required: true schema: type: string responses: "200": description: Information message describing success status. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "404": description: A custom attribute with the given name could not be found for the user. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "422": description: The attribute could not be created because of semantic errors in the provided data. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.attribute.CustomerAddressAttributeItemResource.deleteAttribute_V1() x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.attribute.CustomerAddressAttributeItemResource patch: tags: - Addresses summary: __BETA__ | Updates the custom attribute set at the user description: This operation updates the custom attribute of the user. Note that only the value may be changed; name and type of the custom attribute are immutable. operationId: updateCustomerAddressAttribute_V1 parameters: - name: include in: query description: Related objects (as a comma-separated list) which are to be included with the response schema: type: string default: "" - name: customerId in: path required: true schema: type: string - name: addressId in: path required: true schema: type: string - name: attributeId in: path required: true schema: type: string requestBody: description: The object containing the custom attribute's data content: application/json: schema: $ref: "#/components/schemas/AttributeRO_v1" responses: "200": description: The attribute was successfully updated. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "422": description: The custom attribute could not be updated because of semantic errors in the provided data. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.attribute.CustomerAddressAttributeItemResource.updateAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)" x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.attribute.CustomerAddressAttributeItemResource /customers/{customerId}/attributes: get: tags: - General summary: __BETA__ | Returns all custom attributes for the customer description: This operation returns a list of all custom attributes for the customer. operationId: getCustomerAttributes_V1 parameters: - name: include in: query description: Related objects (as a comma-separated list) which are to be included with the response schema: type: string default: "" - name: customerId in: path required: true schema: type: string responses: "200": description: The list of attributes. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeListCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.attribute.CustomerAttributeListResource.getAttributes_V1(java.lang.String) x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.attribute.CustomerAttributeListResource post: tags: - General summary: __BETA__ | Creates a new custom attribute at the customer description: This operation creates a new (custom) attribute at the customer. The name of the attribute is used as identifier for the created sub resource. operationId: createCustomerAttribute_V1 parameters: - name: include in: query description: Related objects (as a comma-separated list) which are to be included with the response schema: type: string default: "" - name: customerId in: path required: true schema: type: string requestBody: description: The object containing the attribute data content: application/json: schema: $ref: "#/components/schemas/AttributeRO_v1" responses: "201": description: The created attribute. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "422": description: The attribute could not be created because of semantic errors in the provided data. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.attribute.CustomerAttributeListResource.createAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)" x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.attribute.CustomerAttributeListResource /customers/{customerId}/attributes/{attributeId}: delete: tags: - General summary: __BETA__ | Deletes the custom attribute with the given ID description: This operation deletes the custom attribute from the customer. operationId: deleteCustomerAttribute_V1 parameters: - name: customerId in: path required: true schema: type: string - name: attributeId in: path required: true schema: type: string responses: "200": description: Information message describing success status. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "404": description: A custom attribute with the given name could not be found for the user. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.attribute.CustomerAttributeItemResource.deleteAttribute_V1() x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.attribute.CustomerAttributeItemResource patch: tags: - General summary: __BETA__ | Updates the custom attribute set at the customer description: "This operation updates the custom attribute of the customer. Note\ \ that only the value may be changed, name and type of the custom attribute\ \ are immutable." operationId: updateCustomerAttribute_V1 parameters: - name: include in: query description: Related objects (as a comma-separated list) which are to be included with the response schema: type: string default: "" - name: customerId in: path required: true schema: type: string - name: attributeId in: path required: true schema: type: string requestBody: description: The object containing the custom attribute's data content: application/json: schema: $ref: "#/components/schemas/AttributeRO_v1" responses: "200": description: The updated attribute. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "422": description: The custom attribute could not be updated because of semantic errors in the provided data. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.attribute.CustomerAttributeItemResource.updateAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)" x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.customer.attribute.CustomerAttributeItemResource /customers/{customerId}/users: post: tags: - Users summary: __BETA__ | Creates a new user with the given ID description: "This operation creates a new user for the customer.If initial\ \ data is passed, these data will be set at the newly created user." operationId: createUser_V1 parameters: - name: customerId in: path required: true schema: type: string requestBody: description: The object containing the initial data to be set at the user content: application/json: schema: $ref: "#/components/schemas/UserRO_v1" responses: "201": description: The user was created. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "422": description: The user could not be created because of semantic errors in the initial data. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.user.UserListResource.createCustomer_V1(com.intershop.backoffice.rest.customer.v1.capi.resourceobject.user.UserRO) x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.user.UserListResource /customers/{customerId}/users/{userId}: get: tags: - Users summary: __BETA__ | Returns the user with the given ID description: 'This operation returns the user with the given ID. ' operationId: getUser_V1 parameters: - name: include in: query description: Related objects (as a comma-separated list) which are to be included with the response schema: type: string default: "" - name: customerId in: path required: true schema: type: string - name: userId in: path required: true schema: type: string responses: "200": description: Information message describing success status. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "404": description: A user with the given ID could not be found. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.user.UserItemResource.getUser_V1(java.lang.String) x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.user.UserItemResource delete: tags: - Users summary: __BETA__ | Deletes the user with the given ID description: 'This operation deletes the user with the given ID. ' operationId: deleteUser_V1 parameters: - name: customerId in: path required: true schema: type: string - name: userId in: path required: true schema: type: string responses: "200": description: Information message describing success status. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "404": description: A user with the given ID could not be found. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.user.UserItemResource.deleteUser_V1() x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.user.UserItemResource patch: tags: - Users summary: __BETA__ | Partially updates the user with the given ID description: 'This operation updates the user with the given ID partially. ' operationId: updateUser_V1 parameters: - name: include in: query description: Related objects (as a comma-separated list) which are to be included with the response schema: type: string default: "" - name: customerId in: path required: true schema: type: string - name: userId in: path required: true schema: type: string requestBody: description: The object containing the data to update the user with the given ID content: application/json: schema: $ref: "#/components/schemas/UserRO_v1" responses: "200": description: The updated customer content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "404": description: A user with the given ID could not be found. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/CustomerCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.user.UserItemResource.updateUser_V1(com.intershop.backoffice.rest.customer.v1.capi.resourceobject.user.UserRO,java.lang.String)" x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.user.UserItemResource /customers/{customerId}/users/{userId}/attributes: get: tags: - Users summary: __BETA__ | Returns all custom attributes for the user description: This operation returns all custom attributes for the user. operationId: getUserAttributes_V1 parameters: - name: include in: query description: Related objects (as a comma-separated list) which are to be included with the response schema: type: string default: "" - name: customerId in: path required: true schema: type: string - name: userId in: path required: true schema: type: string responses: "200": description: The list of attributes. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeListCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.user.attribute.UserAttributeListResource.getAttributes_V1(java.lang.String) x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.user.attribute.UserAttributeListResource post: tags: - Users summary: __BETA__ | Creates a new custom attribute for the user description: This operation creates a new custom attribute for the user. The name of the attribute is used as identifier for the created sub resource. operationId: createUserAttribute_V1 parameters: - name: include in: query description: Related objects (as a comma-separated list) which are to be included with the response schema: type: string default: "" - name: customerId in: path required: true schema: type: string - name: userId in: path required: true schema: type: string requestBody: description: The object containing the attribute data content: application/json: schema: $ref: "#/components/schemas/AttributeRO_v1" responses: "201": description: The created attribute. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "422": description: The attribute could not be created because of semantic errors in the provided data. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.user.attribute.UserAttributeListResource.createAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)" x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.user.attribute.UserAttributeListResource /customers/{customerId}/users/{userId}/attributes/{attributeId}: delete: tags: - Users summary: __BETA__ | Deletes the custom attribute from the user description: This operation deletes the custom attribute with the given name from the user. operationId: deleteUserAttribute_V1 parameters: - name: customerId in: path required: true schema: type: string - name: userId in: path required: true schema: type: string - name: attributeId in: path required: true schema: type: string responses: "200": description: Information message describing success status. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "404": description: A custom attribute with the given name could not be found for the user. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.user.attribute.UserAttributeItemResource.deleteAttribute_V1() x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.user.attribute.UserAttributeItemResource patch: tags: - Users summary: __BETA__ | Updates the custom attribute set at the user description: This operation updates the custom attribute of the user. Note that only the value may be changed; name and type of the custom attribute are immutable. operationId: updateUserAttribute_V1 parameters: - name: include in: query description: Related objects (as a comma-separated list) which are to be included with the response schema: type: string default: "" - name: customerId in: path required: true schema: type: string - name: userId in: path required: true schema: type: string - name: attributeId in: path required: true schema: type: string requestBody: description: The object containing the custom attribute's data content: application/json: schema: $ref: "#/components/schemas/AttributeRO_v1" responses: "200": description: The attribute was successfully updated. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "422": description: The custom attribute could not be updated because of semantic errors in the provided data. content: application/vnd.intershop.admin.customer.v1+json: schema: $ref: "#/components/schemas/AttributeCtnrRO_v1" "401": $ref: "#/components/responses/401" "403": $ref: "#/components/responses/403" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public jakarta.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.user.attribute.UserAttributeItemResource.updateAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)" x-origin-class: com.intershop.backoffice.rest.customer.v1.capi.resource.user.attribute.UserAttributeItemResource components: schemas: 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 element. This is normally a **constant** that can be used to differentiate elements 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" BooleanAttributeRO_v1: required: - name - type - value type: object description: A representation of a boolean attribute. allOf: - $ref: "#/components/schemas/AttributeRO_v1Object" - type: object properties: value: type: boolean description: The boolean attribute value. CustomerCtnrRO_v1: type: object properties: data: $ref: "#/components/schemas/CustomerRO_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 properties: addresses: type: object properties: : $ref: "#/components/schemas/AddressRO_v1" users: type: object properties: : $ref: "#/components/schemas/UserRO_v1" description: Optionally included related data objects. Included via "include" query parameter. readOnly: true x-supported-include-type: com.intershop.backoffice.rest.customer.v1.capi.resourceobject.customer.CustomerRO 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 CustomerRO_v1: type: object properties: active: type: boolean description: Is customer active or deactivated? example: true addresses: type: array description: The addresses (IDs) of the customer. items: type: string description: The addresses (IDs) of the customer. attributes: type: array readOnly: true items: $ref: "#/components/schemas/AttributeRO_v1" companyName1: type: string description: First part of customer's company name; for business customers only. example: OilCorp Ltd. companyName2: type: string description: Second part of customer's company name; for business customers only. example: OilCorp Corporate Headquarters customerType: type: string description: The type of the customer; could be either a private (B2C) or a business (B2B) customer. example: SMB enum: - PRIVATE - SMB - PRIVATE - SMB description: type: string externalId: type: string description: The ID uniquely identifying the customer in an external system; required only for data objects that have already been synchronized with the external system example: MyCorp externalUrn: type: string description: The URN uniquely identifying the customer in an external system; required only for data objects that have already been synchronized with the external system example: urn:customer:MSDynamics365:USMF:MyCorp id: type: string description: The ID uniquely identifying the customer in the context of an Intershop ICM repository. Note that ID can set only once during creation (POST) of the customer. Subsequent PATCH requests cannot change this ID. readOnly: true example: OilCorp industry: type: string description: Sector of industry the customer belongs to. example: Oil & Gas taxIdentificationNumber: type: string description: A description of the customer. example: "OilCorp produces gas and oil, focusing on Europe and North Africa. " urn: type: string description: The URN uniquely identifying the customer in the context of an Intershop ICM deployment. readOnly: true example: urn:customer:ICM:inSPIRED:inTRONICS_Business:OilCorp users: type: array description: The users (IDs) of the customer; for business customers only items: type: string description: The users (IDs) of the customer; for business customers only description: "Data object used to synchronize B2C/B2B customers between Intershop\ \ ICM and external systems. Note: Beta version - This class can still be subject\ \ of change!" DateAttributeRO_v1: required: - name - type - value type: object description: A representation of a date/time attribute. allOf: - $ref: "#/components/schemas/AttributeRO_v1Object" - 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_v1Object" - 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_v1Object" - type: object properties: value: type: number description: The double attribute value. format: double FeedbackCauseRO_v1: title: FeedbackCauseRO_v1 required: - code - message type: object properties: code: type: string description: A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) example: product.name.required.error message: type: string description: A human readable message in the request's locale example: The product name must be specified. 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. Unless\ \ otherwise specified, this always refers to the request entity." example: - "\"$.name (position: 1)\"" 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 information FeedbackRO_v1: title: FeedbackRO_v1 required: - code - message type: object properties: causes: type: array description: A collection of errors/warnings/infos that caused the feedback items: $ref: "#/components/schemas/FeedbackCauseRO_v1" code: type: string description: A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) example: product.name.required.error message: type: string description: A human readable message in the request's locale example: The product name must be specified. 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. Unless\ \ otherwise specified, this always refers to the request entity." example: - "\"$.name (position: 1)\"" 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: "422" description: An error or piece of information related to the current request readOnly: true IntegerAttributeRO_v1: required: - name - type - value type: object description: A representation of an integer attribute. allOf: - $ref: "#/components/schemas/AttributeRO_v1Object" - 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_v1Object" - 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_v1Object" - type: object properties: value: $ref: "#/components/schemas/MoneyRO_v1" MoneyRO_v1: title: MoneyRO_v1 type: object properties: currency: type: string description: Three-letter currency code (ISO 4217) of the monetary value. example: USD value: type: number description: The monetary value. 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_v1Object" - 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_v1Object" - 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_v1Object" - 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_v1Object" - 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_v1Object" - 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_v1Object" - 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_v1Object" - type: object properties: value: type: array description: The multiple string attribute value. items: type: string description: The multiple string attribute value. QuantityAttributeRO_v1: required: - name - type - value type: object description: A representation of a quantity attribute. allOf: - $ref: "#/components/schemas/AttributeRO_v1Object" - type: object properties: value: $ref: "#/components/schemas/QuantityRO_v1" QuantityRO_v1: required: - value type: object properties: unit: type: string description: The unit of the quantity. example: kg value: type: number description: The quantity's value. example: 10 description: The quantity of a business entity. StringAttributeRO_v1: required: - name - type - value type: object description: A representation of a string attribute. allOf: - $ref: "#/components/schemas/AttributeRO_v1Object" - 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_v1Object" - type: object properties: value: type: string description: The text attribute value. AttributeCtnrRO_v1: type: object properties: data: $ref: "#/components/schemas/AttributeRO_v1Object" 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 AttributeRO_v1Object: required: - name - type type: object properties: name: type: string description: The name of an element type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements 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" AttributeListCtnrRO_v1: type: object properties: data: type: array description: The core data of the response object. items: $ref: "#/components/schemas/AttributeRO_v1Object" 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 AddressCtnrRO_v1: type: object properties: data: $ref: "#/components/schemas/AddressRO_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. Included via "include" query parameter. readOnly: true x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO description: Optionally included related data objects. Included via "include" query parameter. readOnly: true x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO 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 AddressRO_v1: type: object properties: addressLine1: type: string description: "The first address line, that usual contains street and house\ \ number." example: Berliner Str. 20 addressLine2: type: string description: The second address line. addressLine3: type: string description: The third address line. aristocraticTitle: type: string description: "The aristocratic title of the contact person, like 'Lord'\ \ or 'Lady'." attributes: type: array readOnly: true items: $ref: "#/components/schemas/AttributeRO_v1" city: type: string description: The name of the city. example: Potsdam companyName1: type: string description: The company name in case it is a business address. example: Intershop Communications AG companyName2: type: string description: The second company name country: type: string description: The localized display name of the country readOnly: true example: Germany countryCode: type: string description: The ISO 3166-1 country code example: DE customer: type: string eligibleInstallToAddress: type: boolean description: Flag indicating that the address can be used as install-to address. example: false eligibleInvoiceToAddress: type: boolean description: Flag indicating that the address can be used as invoice-to address. example: true eligibleServiceToAddress: type: boolean description: Flag indicating that the address can be used as service-to address. example: false eligibleShipFromAddress: type: boolean description: Flag indicating that the address can be used as ship-from address. example: false eligibleShipToAddress: type: boolean description: Flag indicating that the address can be used as ship-to address. example: true email: type: string description: The e-mail address of the contact person. example: patricia@test.intershop.de externalId: type: string description: The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system example: "000123456" externalUrn: type: string description: The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system example: urn:address:MSDynamics365:MyCorp:000123456 fax: type: string description: The fax number. firstName: type: string description: "The given name (also known as a personal name, first name,\ \ forename, or Christian name) of the contact person" example: Patricia honorific: type: string description: "The honorific title of the contact person that denotes the\ \ honored person's occupation, like 'Captain', 'Reverend' or the academic\ \ title, like 'PhD'." id: type: string description: The ID that identifies the address. example: "0987654321" jobTitle: type: string description: The job title of the contact person. lastName: type: string description: "The last name (also known as a family name, surname, or gentile\ \ name) of the contact person." example: Miller mainDivision: type: string description: The localized display name of the main division readOnly: true example: Alabama mainDivisionCode: type: string description: "The main division code of the country, e. g. a state or province." example: Al phoneBusiness: type: string description: The phone number of the contact person's company. phoneBusinessDirect: type: string description: |- The business phone number of the contact person that allows an outside caller to connect directly to the contact person without any help of an attendant or operator. phoneHome: type: string description: The phone number of the house or apartment where the contact person lives. example: "049364112677" phoneMobile: type: string description: The number of the contact person's cell phone. postBox: type: string description: The post-office box. postalCode: type: string description: The postal code of the city. example: "14482" secondLastName: type: string description: The second last name of the contact person. secondName: type: string description: The second given name of the contact person. subDivision: type: string description: The localized display name of the sub division. readOnly: true example: City of Westminster subDivisionCode: type: string description: The sub division code. example: "020" title: type: string description: The (personal) title of the contact person. example: Ms. urn: type: string description: The URN representation of this address. example: urn:address:customer:1234567890:0987654321 usage: type: object properties: empty: type: boolean description: "The usage information for the address. Every bit in the returned\ \ set marks a specific usage type: [invoice-to, ship-to, ship-from, service-to,\ \ install-to]. If a bit is set, the address may be used for the specific\ \ purpose mapped to this bit. By default, all values are set to true." description: The address 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 AddressListCtnrRO_v1: type: object properties: data: type: array description: The core data of the response object. items: $ref: "#/components/schemas/AddressRO_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. Included via "include" query parameter. readOnly: true x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO description: Optionally included related data objects. Included via "include" query parameter. readOnly: true x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO 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 UserRO_v1: type: object properties: accountId: type: string description: The account ID if the user in Intershop ICM. example: patricia.miller@test.intershop.de active: type: boolean description: Is user active or deactivated? example: true aristocraticTitle: type: string description: "The aristocratic title of the user, like Lady, Lord." example: Lady attributes: type: array readOnly: true items: $ref: "#/components/schemas/AttributeRO_v1" company: type: string description: The name of the company where the user is employeed. example: INTERSHOP Communications AG creationDate: type: string description: Creation date of the user account. format: date-time example: 2019-05-23T13:23:45+02:00 customer: type: string dateOfBirth: type: string description: User's date of birth. format: date example: 1989-07-11 department: type: string description: The department the user is assigned to. example: Procurement email: type: string description: User's e-mail account. example: peter.sampleman@intershop.de externalId: type: string description: The ID uniquely identifying the user in an external system; required only for data objects that have already been synchronized with the external system example: MyUser externalUrn: type: string description: The URN uniquely identifying the user in an external system; required only for data objects that have already been synchronized with the external system example: urn:user:MSDynamics365:USMF:MyCorp:MyUser fax: type: string description: The number of user's facsimile machine. example: +49 (3641) 50-1344 firstName: type: string description: "The given name (also known as a personal name, first name,\ \ forename, or Christian name) of the user." example: Peter gender: type: string description: The gender of the user. example: FEMALE enum: - MALE - FEMALE - UNKNOWN honorific: type: string description: "The honorific title of the user, that denotes the honored\ \ person's occupation, like Captain, Coach, Officer, Reverend or the academic\ \ title, like PhD." example: PhD id: type: string description: The ID uniquely identifying the user in the context of an Intershop ICM repository. Note that ID can set only once during creation (POST) of the user. Subsequent PATCH reuqests cannot change this ID. example: pmiller jobTitle: type: string description: The job title of the user. example: Procurement Lead lastName: type: string description: "The surname (also known as a family name, last name, or gentile\ \ name) of the user." example: Sampleman phoneBusiness: type: string description: The number of user's company. example: +49 (3641) 50-0 phoneBusinessDirect: type: string description: Business phone number extension that allows an outside caller to connect directly to the user without any help of an attendant or operator. example: "3479" phoneHome: type: string description: The phone number of the house or apartment where the user lives. example: +49 (3641) 123456 phoneMobile: type: string description: The number of user's cell phone. example: +49 (165) 5673123 preferredCurrency: type: string description: User's preferred currency in "ISO 4217" format. example: USD preferredInvoiceToAddressUrn: type: string description: The URN of user's preferred invoice-to address. Note that this must be an address with the related usage 'invoice-to' ! example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei preferredLanguage: type: string description: User's preferred language in "ISO 639 alpha-2" format. example: en preferredLocale: type: string description: "User's preferred locale specified by format {language}_{country},\ \ whereas the language has to be specified as \"ISO 639 alpha-2\" code\ \ and the country as \"ISO 3166 alpha-2\" code" example: en_US preferredShipToAddressUrn: type: string description: The URN of user's preferred ship-to address. Note that this must be an address with the related usage 'ship-to' ! example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei preferredTimeZoneId: type: string description: User's preferred time zone ID. example: Europe/Berlin roles: type: array items: type: string secondLastName: type: string description: "The second last name of the user. Allocation depends on the\ \ culture area, second last (sur-) name is common in Hispanic culture." example: Rodriguez secondName: type: string description: "The second given name of the user. Allocation depends on the\ \ culture area, in European countries this would be regarded as the second\ \ name, whereas in United States a person has usually one middle name." example: Max title: type: string description: "The personal title, like Ms., Mr." example: Mr. urn: type: string description: The URN uniquely identifying the user in the context of an Intershop ICM deployment. readOnly: true example: urn:user:ICM:inSPIRED:OilCorp:pmiller description: "Data object used to synchronize users of business (B2B) customers\ \ between Intershop ICM and external systems. Note: Beta version - This class\ \ can still be subject of change!" responses: "200": description: OK "201": description: Created "202": description: Accepted "204": description: No Content "205": description: Reset Content "206": description: Partial Content "300": description: Multiple Choices "301": description: Moved Permanently "302": description: Found "303": description: See Other "304": description: Not Modified "305": description: Use Proxy "307": description: Temporary Redirect "308": description: Permanent 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 "428": description: Precondition Required "429": description: Too Many Requests "431": description: Request Header Fields Too Large "451": description: Unavailable For Legal Reasons "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 "511": description: Network Authentication Required parameters: loc: name: loc in: path description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using a\ \ underscore, e. g. ```en_US```." required: false style: matrix schema: type: string description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using\ \ a underscore, e. g. ```en_US```." 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 MXN: description: Mexican Peso value: MXN STD: description: São Tomé / Príncipe Dobra value: STD LVL: description: Latvian Lats value: LVL SCR: description: Seychelles Rupee value: SCR CDF: description: Congolese Franc value: CDF BBD: description: Barbados Dollar value: BBD GTQ: description: Guatemalan Quetzal value: GTQ CLP: description: Chilean Peso value: CLP HNL: description: Honduran Lempira value: HNL UGX: description: Ugandan Shilling value: UGX ZAR: description: South African Rand value: ZAR TND: description: Tunisian Dinar value: TND BSD: description: Bahamian Dollar value: BSD SLL: description: Sierra Leonean Leone value: SLL SDG: description: Sudanese Pound value: SDG IQD: description: Iraqi Dinar value: IQD CUP: description: Cuban Peso value: CUP GMD: description: Gambian Dalasi value: GMD 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 AZN: description: Azerbaijanian Manat value: AZN OMR: description: Omani Rial value: OMR PGK: description: Papua New Guinean Kina value: PGK KES: description: Kenyan Shilling value: KES SEK: description: Swedish Krona value: SEK BTN: description: Ngultrum value: BTN UAH: description: Ukrainian Hryvnia value: UAH GNF: description: Guinea Franc value: GNF ERN: description: Nakfa value: ERN MZN: description: Mozambican Metical value: MZN SVC: description: Salvadoran Colón value: SVC ARS: description: Argentine Peso value: ARS QAR: description: Qatari Riyal value: QAR IRR: description: Iranian Rial value: IRR NLG: description: Dutch Guilder value: NLG MRO: description: Mauritanian Ouguiya value: MRO CNY: description: Yuan Renminbi value: CNY THB: description: Thai Baht value: THB UZS: description: Uzbekistani Som value: UZS XPF: description: CFP Franc value: XPF BDT: description: Bangladeshi Taka value: BDT LYD: description: Libyan Dinar value: LYD BMD: description: Bermudian Dollar value: BMD KWD: description: Kuwaiti Dinar value: KWD PHP: description: Philippine Peso value: PHP RUB: description: Russian Ruble value: RUB PYG: description: Paraguayan Guarani value: PYG ISK: description: Iceland Krona value: ISK JMD: description: Jamaican Dollar value: JMD GWP: description: Guinea Peso value: GWP BEF: description: Belgian Franc value: BEF ESP: description: Spanish Peseta value: ESP COP: description: Colombian Peso value: COP MKD: description: Denar value: MKD USD: description: US Dollar value: USD DZD: description: Algerian Dinar value: DZD PAB: description: Panamanian Balboa value: PAB SGD: description: Singapore Dollar value: SGD ETB: description: Ethiopian Birr value: ETB KGS: description: Som value: KGS SOS: description: Somali Shilling value: SOS VEF: description: Venezuelan Bolivar Fuerte value: VEF VUV: description: Vanuatu Vatu value: VUV LAK: description: Lao Kip value: LAK BND: description: Brunei Dollar value: BND ZMK: description: Zambian Kwacha value: ZMK XAF: description: CFA Franc BEAC value: XAF LRD: description: Liberian Dollar value: LRD ATS: description: Austrian Schilling value: ATS CHF: description: Swiss Franc value: CHF HRK: description: Croatian Kuna value: HRK ITL: description: Italian Lira value: ITL ALL: description: Albanian Lek value: ALL DJF: description: Djibouti Franc value: DJF 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 GHS: description: Ghanaian Cedi value: GHS GYD: description: Guyanese Dollar value: GYD KPW: description: North Korean Won value: KPW BOB: description: Boliviano value: BOB KHR: description: Cambodian Riel value: KHR MDL: description: Moldovan Leu value: MDL IDR: description: Indonesian Rupiah value: IDR KYD: description: Cayman Islands Dollar value: KYD AMD: description: Armenian Dram value: AMD BWP: description: Botswana Pula value: BWP SHP: description: Saint Helena Pound value: SHP TRY: description: Turkish Lira value: TRY CYP: description: Cyprus Pound value: CYP LBP: description: Lebanese Pound value: LBP TJS: description: Tajikistani Somoni value: TJS JOD: description: Jordanian Dinar value: JOD AED: description: United Arab Emirates Dirham value: AED HKD: description: Hong Kong Dollar value: HKD RWF: description: Rwanda Franc value: RWF 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 EEK: description: Estonian Kroon value: EEK MMK: description: Kyat value: MMK MUR: description: Mauritian Rupee value: MUR NOK: description: Norwegian Krone value: NOK SYP: description: Syrian Pound value: SYP 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 CRC: description: Costa Rican Colon value: CRC CZK: description: Czech Koruna value: CZK IEP: description: Irish Pound value: IEP PKR: description: Pakistani Rupee value: PKR GRD: description: Greek Drachma value: GRD XCD: description: East Carribean Dollar value: XCD ANG: description: Netherlands Antillian Guilder value: ANG HTG: description: Haitian Gourde value: HTG BHD: description: Bahraini Dinar value: BHD SIT: description: Slovenian Tolar value: SIT PTE: description: Portuguese Escudo value: PTE BPP: description: Bonus Point Price value: BPP KZT: description: Kazakhstani Tenge value: KZT SRD: description: Surinam Dollar value: SRD SZL: description: Swazi Lilangeni value: SZL LTL: description: Lithuanian Litas value: LTL SAR: description: Saudi Riyal value: SAR TTD: description: Trinidad and Tobago Dollar value: TTD YER: description: Yemeni Rial value: YER MVR: description: Maldivian Rufiyaa value: MVR AFN: description: Afghani value: AFN BPV: description: Bonus Point Value value: BPV INR: description: Indian Rupee value: INR AWG: description: Aruban Florin value: AWG KRW: description: South Korean Won value: KRW NPR: description: Nepalese Rupee value: NPR JPY: description: Japanese Yen value: JPY MNT: description: Mongolian Tugrik value: MNT AOA: description: Angolan Kwanza value: AOA PLN: description: Polish Złoty value: PLN GBP: description: Pound Sterling value: GBP SBD: description: Solomon Islands Dollar value: SBD 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 BZD: description: Belize Dollar value: BZD DEM: description: Deutsche Mark value: DEM BAM: description: Convertible Marks value: BAM EGP: description: Egyptian Pound value: EGP MOP: description: Macanese Pataca value: MOP 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 NZD: description: New Zealand Dollar value: NZD WST: description: Samoan Tala value: WST 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: false 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 personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 spgid: name: spgid in: path description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." 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: customer_management_v100 x-origin-class: "com.intershop.component.rest.capi.resource.RootResource,com.intershop.backoffice.rest.customer.v1.capi.resource.customer.CustomerListResource"