This API specification is available for download as an Open API 3.0 YAML file:
References
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
API Specification
/customers/{customerId}/addresses
POST: [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.
Java Method
public javax.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)
Request Body
AddressRO_v1 application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in query | include | string |
| | Related objects which are to be included with the response |
Response
201 - Created The new address was successfully created.
AddressListCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
422 - Unprocessable Entity The address could not be created because of semantic errors in the provided data.
FeedbackCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
/customers/{customerId}/addresses/{addressId}
GET: [BETA] Returns the address for a given ID
Description
This operation returns the customer's address for a given ID.
Java Method
public javax.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.CustomerAddressItemResource.getAddress_V1(java.lang.String)
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | addressId | string | | | Required |
in query | include | string |
| | Related objects (as a comma-separated list) which are to be included with the response. |
Response
200 - OK The address with the given ID.
AddressCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
404 - Not Found An address with the given ID could not be found for the given customer.
FeedbackCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
DELETE: [BETA] Deletes the address with a given ID
Description
This operation deletes a customer's address with a given ID.
Java Method
public javax.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.CustomerAddressItemResource.deleteAddress_V1()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | addressId | string | | | Required |
Response
200 - OK Information message describing success status.
AddressCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
404 - Not Found An address with the given ID could not be found for the given customer.
FeedbackCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
422 - Unprocessable Entity The address could not be deleted.
AddressCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
PATCH: [BETA] Partially updates an address with a given ID
Description
This operation updates a customer's address with a given ID partially.
Java Method
public javax.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)
Request Body
AddressRO_v1 application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | addressId | string | | | Required |
in query | include | string |
| | Related objects which are to be included with the response. |
Response
200 - OK The updated address.
AddressCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
404 - Not Found An address with the given ID could not be found for the customer.
FeedbackCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
422 - Unprocessable Entity The address could not be updated.
AddressCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
/customers/{customerId}/addresses/{addressId}/attributes
GET: [BETA] Returns all custom attributes for the address
Description
This operation returns all custom attributes for the address.
Java Method
public javax.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.attribute.CustomerAddressAttributeListResource.getAttributes_V1(java.lang.String)
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | addressId | string | | | Required |
in query | include | string |
| | Related objects (as a comma-separated list) which are to be included with the response. |
Response
200 - OK The list of attributes.
AttributeListCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
POST: [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.
Java Method
public javax.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)
Request Body
AttributeRO_v1 application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | addressId | string | | | Required |
in query | include | string |
| | Related objects (as a comma-separated list) which are to be included with the response |
Response
201 - Created The attribute was successfully created.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
422 - Unprocessable Entity The attribute could not be created because of semantic errors in the provided data.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
/customers/{customerId}/addresses/{addressId}/attributes/{attributeId}
DELETE: [BETA] Deletes the custom attribute from the user
Description
This operation deletes the custom attribute from the user.
Java Method
public javax.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.address.attribute.CustomerAddressAttributeItemResource.deleteAttribute_V1()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | addressId | string | | | Required |
in path | attributeId | string | | | Required |
Response
200 - OK Information message describing success status.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
404 - Not Found A custom attribute with the given name could not be found for the user.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
422 - Unprocessable Entity The attribute could not be created because of semantic errors in the provided data.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
PATCH: [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.
Java Method
public javax.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)
Request Body
AttributeRO_v1 application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | addressId | string | | | Required |
in path | attributeId | string | | | Required |
in query | include | string |
| | Related objects (as a comma-separated list) which are to be included with the response |
Response
200 - OK The attribute was successfully updated.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
422 - Unprocessable Entity The custom attribute could not be updated because of semantic errors in the provided data.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
/customers
POST: [BETA] Creates a new customer.
Description
This operation creates a new customer with the given ID.
Java Method
public javax.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)
Request Body
CustomerRO_v1 application/json
Request Parameters
--
Response
201 - Created The customer was successfully created.
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
422 - Unprocessable Entity The customer could not be created because of semantic errors in the initial data.
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
/customers/{customerId}
GET: [BETA] Returns the customer with the given ID
Description
This operation returns the customer with the given ID.
Java Method
public javax.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.CustomerItemResource.getCustomer_V1(java.lang.String)
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in query | include | string |
| | Related objects (as a comma-separated list) which are to be included with the response |
Response
200 - OK Information message describing success status.
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
404 - Not Found A customer with the given ID could not be found.
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
DELETE: [BETA] Deletes the customer with the given ID
Description
This operation deletes the customer with the given ID.
Java Method
public javax.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.CustomerItemResource.deleteCustomer_V1()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
Response
200 - OK Information message describing success status.
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
404 - Not Found A customer with the given ID could not be found.
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
PATCH: [BETA] Partially updates the customer with the given ID
Description
This operation updates the customer with the given ID partially.
Java Method
public javax.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)
Request Body
CustomerRO_v1 application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
Response
200 - OK The customer was successfully updated.
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
404 - Not Found A customer with the given ID could not be found.
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
/customers/{customerId}/attributes
GET: [BETA] Returns all custom attributes for the customer
Description
This operation returns a list of all custom attributes for the customer.
Java Method
public javax.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.attribute.CustomerAttributeListResource.getAttributes_V1(java.lang.String)
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in query | include | string |
| | Related objects (as a comma-separated list) which are to be included with the response |
Response
200 - OK The list of attributes.
AttributeListCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
POST: [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.
Java Method
public javax.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)
Request Body
AttributeRO_v1 application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in query | include | string |
| | Related objects (as a comma-separated list) which are to be included with the response |
Response
201 - Created The created attribute.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
422 - Unprocessable Entity The attribute could not be created because of semantic errors in the provided data.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
/customers/{customerId}/attributes/{attributeId}
DELETE: [BETA] Deletes the custom attribute with the given ID
Description
This operation deletes the custom attribute from the customer.
Java Method
public javax.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.customer.attribute.CustomerAttributeItemResource.deleteAttribute_V1()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | attributeId | string | | | Required |
Response
200 - OK Information message describing success status.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
404 - Not Found A custom attribute with the given name could not be found for the user.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
PATCH: [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.
Java Method
public javax.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)
Request Body
AttributeRO_v1 application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | attributeId | string | | | Required |
in query | include | string |
| | Related objects (as a comma-separated list) which are to be included with the response |
Response
200 - OK The updated attribute.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
422 - Unprocessable Entity The custom attribute could not be updated because of semantic errors in the provided data.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
/customers/{customerId}/users
POST: [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.
Java Method
public javax.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)
Request Body
UserRO_v1 application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
Response
201 - Created The user was created.
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
422 - Unprocessable Entity The user could not be created because of semantic errors in the initial data.
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
/customers/{customerId}/users/{userId}
GET: [BETA] Returns the user with the given ID
Description
This operation returns the user with the given ID.
Java Method
public javax.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.user.UserItemResource.getUser_V1(java.lang.String)
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | userId | string | | | Required |
in query | include | string |
| | Related objects (as a comma-separated list) which are to be included with the response |
Response
200 - OK Information message describing success status.
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
404 - Not Found A user with the given ID could not be found.
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
DELETE: [BETA] Deletes the user with the given ID
Description
This operation deletes the user with the given ID.
Java Method
public javax.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.user.UserItemResource.deleteUser_V1()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | userId | string | | | Required |
Response
200 - OK Information message describing success status.
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
404 - Not Found A user with the given ID could not be found.
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
PATCH: [BETA] Partially updates the user with the given ID
Description
This operation updates the user with the given ID partially.
Java Method
public javax.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)
Request Body
UserRO_v1 application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | userId | string | | | Required |
in query | include | string |
| | Related objects (as a comma-separated list) which are to be included with the response |
Response
200 - OK The updated customer
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
404 - Not Found A user with the given ID could not be found.
CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
/customers/{customerId}/users/{userId}/attributes
GET: [BETA] Returns all custom attributes for the user
Description
This operation returns all custom attributes for the user.
Java Method
public javax.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.user.attribute.UserAttributeListResource.getAttributes_V1(java.lang.String)
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | userId | string | | | Required |
in query | include | string |
| | Related objects (as a comma-separated list) which are to be included with the response |
Response
200 - OK The list of attributes.
AttributeListCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
POST: [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.
Java Method
public javax.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)
Request Body
AttributeRO_v1 application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | userId | string | | | Required |
in query | include | string |
| | Related objects (as a comma-separated list) which are to be included with the response |
Response
201 - Created The created attribute.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
422 - Unprocessable Entity The attribute could not be created because of semantic errors in the provided data.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
/customers/{customerId}/users/{userId}/attributes/{attributeId}
DELETE: [BETA] Deletes the custom attribute from the user
Description
This operation deletes the custom attribute with the given name from the user.
Java Method
public javax.ws.rs.core.Response com.intershop.backoffice.rest.customer.v1.capi.resource.user.attribute.UserAttributeItemResource.deleteAttribute_V1()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | userId | string | | | Required |
in path | attributeId | string | | | Required |
Response
200 - OK Information message describing success status.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
404 - Not Found A custom attribute with the given name could not be found for the user.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
PATCH: [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.
Java Method
public javax.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)
Request Body
AttributeRO_v1 application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | customerId | string | | | Required |
in path | userId | string | | | Required |
in path | attributeId | string | | | Required |
in query | include | string |
| | Related objects (as a comma-separated list) which are to be included with the response |
Response
200 - OK The attribute was successfully updated.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
401 - Unauthorized
403 - Forbidden
422 - Unprocessable Entity The custom attribute could not be updated because of semantic errors in the provided data.
AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
AddressCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
{"data":
object
A AddressRO_v1
object. The address
{
"addressLine1":
string
The first address line, that usual contains street and house number. | Example: Berliner Str. 20
"addressLine2":
string
The second address line.
"addressLine3":
string
The third address line.
"aristocraticTitle":
string
The aristocratic title of the contact person, like 'Lord' or 'Lady'.
"attributes":
array
Readonly | An array of AttributeRO_v1
objects.
[
Either BooleanAttributeRO_v1
: A representation of a boolean attribute.
{}
Or DateAttributeRO_v1
: A representation of a date/time attribute.
{}
Or DecimalAttributeRO_v1
: A representation of a decimal attribute.
{}
Or DoubleAttributeRO_v1
: A representation of a double attribute.
{}
Or IntegerAttributeRO_v1
: A representation of an integer attribute.
{}
Or LongAttributeRO_v1
: A representation of a long attribute.
{}
Or MoneyAttributeRO_v1
: A representation of a money attribute.
{}
Or QuantityAttributeRO_v1
: A representation of a quantity attribute.
{}
Or StringAttributeRO_v1
: A representation of a string attribute.
{}
Or TextAttributeRO_v1
: A representation of a text attribute.
{}
Or MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.
{}
Or MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.
{}
Or MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.
{}
Or MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.
{}
Or MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.
{}
Or MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.
{}
Or MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.
{}
]
"city":
string
The name of the city. | Example: Potsdam
"companyName1":
string
The company name in case it is a business address. | Example: Intershop Communications AG
"companyName2":
string
The second company name
"country":
string
Readonly | The localized display name of the country | Example: Germany
"countryCode":
string
The ISO 3166-1 country code | Example: DE
"eligibleInstallToAddress":
boolean
Flag indicating that the address can be used as install-to address. | Example: false
"eligibleInvoiceToAddress":
boolean
Flag indicating that the address can be used as invoice-to address. | Example: true
"eligibleServiceToAddress":
boolean
Flag indicating that the address can be used as service-to address. | Example: false
"eligibleShipFromAddress":
boolean
Flag indicating that the address can be used as ship-from address. | Example: false
"eligibleShipToAddress":
boolean
Flag indicating that the address can be used as ship-to address. | Example: true
"email":
string
The e-mail address of the contact person. | Example: patricia@test.intershop.de
"externalId":
string
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":
string
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":
string
The fax number.
"firstName":
string
The given name (also known as a personal name, first name, forename, or Christian name) of the contact person | Example: Patricia
"honorific":
string
The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'.
"id":
string
The ID that identifies the address. | Example: 0987654321
"jobTitle":
string
The job title of the contact person.
"lastName":
string
The last name (also known as a family name, surname, or gentile name) of the contact person. | Example: Miller
"mainDivision":
string
Readonly | The localized display name of the main division | Example: Alabama
"mainDivisionCode":
string
The main division code of the country, e. g. a state or province. | Example: Al
"phoneBusiness":
string
The phone number of the contact person's company.
"phoneBusinessDirect":
string
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":
string
The phone number of the house or apartment where the contact person lives. | Example: 049364112677
"phoneMobile":
string
The number of the contact person's cell phone.
"postBox":
string
The post-office box.
"postalCode":
string
The postal code of the city. | Example: 14482
"secondLastName":
string
The second last name of the contact person.
"secondName":
string
The second given name of the contact person.
"subDivision":
string
Readonly | The localized display name of the sub division. | Example: City of Westminster
"subDivisionCode":
string
The sub division code. | Example: 020
"title":
string
The (personal) title of the contact person. | Example: Ms.
"urn":
string
The URN representation of this address. | Example: urn:address:customer:1234567890:0987654321
"usage":
object
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.
}
"errors":
array
Readonly | An array of FeedbackRO_v1
objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1
:
An error or information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Readonly | Optionally included related data objects. Included via "include" query parameter.
"infos":
array
Readonly | An array of FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1
:
An error or information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
}AddressListCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
{"data":
array
An array of AddressRO_v1
objects. The core data of the response object.
[
AddressRO_v1
:
The address{
"addressLine1":
string
The first address line, that usual contains street and house number. | Example: Berliner Str. 20
"addressLine2":
string
The second address line.
"addressLine3":
string
The third address line.
"aristocraticTitle":
string
The aristocratic title of the contact person, like 'Lord' or 'Lady'.
"attributes":
array
Readonly | An array of AttributeRO_v1
objects.
[
Either BooleanAttributeRO_v1
: A representation of a boolean attribute.
{}
Or DateAttributeRO_v1
: A representation of a date/time attribute.
{}
Or DecimalAttributeRO_v1
: A representation of a decimal attribute.
{}
Or DoubleAttributeRO_v1
: A representation of a double attribute.
{}
Or IntegerAttributeRO_v1
: A representation of an integer attribute.
{}
Or LongAttributeRO_v1
: A representation of a long attribute.
{}
Or MoneyAttributeRO_v1
: A representation of a money attribute.
{}
Or QuantityAttributeRO_v1
: A representation of a quantity attribute.
{}
Or StringAttributeRO_v1
: A representation of a string attribute.
{}
Or TextAttributeRO_v1
: A representation of a text attribute.
{}
Or MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.
{}
Or MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.
{}
Or MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.
{}
Or MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.
{}
Or MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.
{}
Or MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.
{}
Or MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.
{}
]
"city":
string
The name of the city. | Example: Potsdam
"companyName1":
string
The company name in case it is a business address. | Example: Intershop Communications AG
"companyName2":
string
The second company name
"country":
string
Readonly | The localized display name of the country | Example: Germany
"countryCode":
string
The ISO 3166-1 country code | Example: DE
"eligibleInstallToAddress":
boolean
Flag indicating that the address can be used as install-to address. | Example: false
"eligibleInvoiceToAddress":
boolean
Flag indicating that the address can be used as invoice-to address. | Example: true
"eligibleServiceToAddress":
boolean
Flag indicating that the address can be used as service-to address. | Example: false
"eligibleShipFromAddress":
boolean
Flag indicating that the address can be used as ship-from address. | Example: false
"eligibleShipToAddress":
boolean
Flag indicating that the address can be used as ship-to address. | Example: true
"email":
string
The e-mail address of the contact person. | Example: patricia@test.intershop.de
"externalId":
string
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":
string
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":
string
The fax number.
"firstName":
string
The given name (also known as a personal name, first name, forename, or Christian name) of the contact person | Example: Patricia
"honorific":
string
The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'.
"id":
string
The ID that identifies the address. | Example: 0987654321
"jobTitle":
string
The job title of the contact person.
"lastName":
string
The last name (also known as a family name, surname, or gentile name) of the contact person. | Example: Miller
"mainDivision":
string
Readonly | The localized display name of the main division | Example: Alabama
"mainDivisionCode":
string
The main division code of the country, e. g. a state or province. | Example: Al
"phoneBusiness":
string
The phone number of the contact person's company.
"phoneBusinessDirect":
string
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":
string
The phone number of the house or apartment where the contact person lives. | Example: 049364112677
"phoneMobile":
string
The number of the contact person's cell phone.
"postBox":
string
The post-office box.
"postalCode":
string
The postal code of the city. | Example: 14482
"secondLastName":
string
The second last name of the contact person.
"secondName":
string
The second given name of the contact person.
"subDivision":
string
Readonly | The localized display name of the sub division. | Example: City of Westminster
"subDivisionCode":
string
The sub division code. | Example: 020
"title":
string
The (personal) title of the contact person. | Example: Ms.
"urn":
string
The URN representation of this address. | Example: urn:address:customer:1234567890:0987654321
"usage":
object
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.
}
]
"errors":
array
Readonly | An array of FeedbackRO_v1
objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1
:
An error or information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Readonly | Optionally included related data objects. Included via "include" query parameter.
"infos":
array
Readonly | An array of FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1
:
An error or information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
}AddressRO_v1 application/json
{"addressLine1":
string
The first address line, that usual contains street and house number. | Example: Berliner Str. 20
"addressLine2":
string
The second address line.
"addressLine3":
string
The third address line.
"aristocraticTitle":
string
The aristocratic title of the contact person, like 'Lord' or 'Lady'.
"attributes":
array
Readonly | An array of AttributeRO_v1
objects.
[
Either BooleanAttributeRO_v1
: A representation of a boolean attribute.
{}
Or DateAttributeRO_v1
: A representation of a date/time attribute.
{}
Or DecimalAttributeRO_v1
: A representation of a decimal attribute.
{}
Or DoubleAttributeRO_v1
: A representation of a double attribute.
{}
Or IntegerAttributeRO_v1
: A representation of an integer attribute.
{}
Or LongAttributeRO_v1
: A representation of a long attribute.
{}
Or MoneyAttributeRO_v1
: A representation of a money attribute.
{}
Or QuantityAttributeRO_v1
: A representation of a quantity attribute.
{}
Or StringAttributeRO_v1
: A representation of a string attribute.
{}
Or TextAttributeRO_v1
: A representation of a text attribute.
{}
Or MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.
{}
Or MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.
{}
Or MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.
{}
Or MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.
{}
Or MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.
{}
Or MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.
{}
Or MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.
{}
]
"city":
string
The name of the city. | Example: Potsdam
"companyName1":
string
The company name in case it is a business address. | Example: Intershop Communications AG
"companyName2":
string
The second company name
"country":
string
Readonly | The localized display name of the country | Example: Germany
"countryCode":
string
The ISO 3166-1 country code | Example: DE
"eligibleInstallToAddress":
boolean
Flag indicating that the address can be used as install-to address. | Example: false
"eligibleInvoiceToAddress":
boolean
Flag indicating that the address can be used as invoice-to address. | Example: true
"eligibleServiceToAddress":
boolean
Flag indicating that the address can be used as service-to address. | Example: false
"eligibleShipFromAddress":
boolean
Flag indicating that the address can be used as ship-from address. | Example: false
"eligibleShipToAddress":
boolean
Flag indicating that the address can be used as ship-to address. | Example: true
"email":
string
The e-mail address of the contact person. | Example: patricia@test.intershop.de
"externalId":
string
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":
string
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":
string
The fax number.
"firstName":
string
The given name (also known as a personal name, first name, forename, or Christian name) of the contact person | Example: Patricia
"honorific":
string
The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'.
"id":
string
The ID that identifies the address. | Example: 0987654321
"jobTitle":
string
The job title of the contact person.
"lastName":
string
The last name (also known as a family name, surname, or gentile name) of the contact person. | Example: Miller
"mainDivision":
string
Readonly | The localized display name of the main division | Example: Alabama
"mainDivisionCode":
string
The main division code of the country, e. g. a state or province. | Example: Al
"phoneBusiness":
string
The phone number of the contact person's company.
"phoneBusinessDirect":
string
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":
string
The phone number of the house or apartment where the contact person lives. | Example: 049364112677
"phoneMobile":
string
The number of the contact person's cell phone.
"postBox":
string
The post-office box.
"postalCode":
string
The postal code of the city. | Example: 14482
"secondLastName":
string
The second last name of the contact person.
"secondName":
string
The second given name of the contact person.
"subDivision":
string
Readonly | The localized display name of the sub division. | Example: City of Westminster
"subDivisionCode":
string
The sub division code. | Example: 020
"title":
string
The (personal) title of the contact person. | Example: Ms.
"urn":
string
The URN representation of this address. | Example: urn:address:customer:1234567890:0987654321
"usage":
object
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.
}AttributeCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
{"data":
object
A AttributeRO_v1Object
object. A representation of an attribute.
{
"name":
string
Required | The name of an element
"type":
string
Required | The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Possible Values: Boolean
Date
Decimal
Double
Integer
Long
Money
Quantity
String
Text
MultipleBoolean
MultipleDate
MultipleDecimal
MultipleDouble
MultipleInteger
MultipleLong
MultipleString
}
"errors":
array
Readonly | An array of FeedbackRO_v1
objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1
:
An error or information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Optionally included related data objects.
"infos":
array
Readonly | An array of FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1
:
An error or information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
}AttributeListCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
{"data":
array
An array of AttributeRO_v1Object
objects. The core data of the response object.
[
Either BooleanAttributeRO_v1
: A representation of a boolean attribute.
{}
Or DateAttributeRO_v1
: A representation of a date/time attribute.
{}
Or DecimalAttributeRO_v1
: A representation of a decimal attribute.
{}
Or DoubleAttributeRO_v1
: A representation of a double attribute.
{}
Or IntegerAttributeRO_v1
: A representation of an integer attribute.
{}
Or LongAttributeRO_v1
: A representation of a long attribute.
{}
Or MoneyAttributeRO_v1
: A representation of a money attribute.
{}
Or QuantityAttributeRO_v1
: A representation of a quantity attribute.
{}
Or StringAttributeRO_v1
: A representation of a string attribute.
{}
Or TextAttributeRO_v1
: A representation of a text attribute.
{}
Or MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.
{}
Or MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.
{}
Or MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.
{}
Or MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.
{}
Or MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.
{}
Or MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.
{}
Or MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.
{}
]
"errors":
array
Readonly | An array of FeedbackRO_v1
objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1
:
An error or information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Optionally included related data objects.
"infos":
array
Readonly | An array of FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1
:
An error or information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
}AttributeRO_v1 application/json
{"name":
string
Required | The name of an element
"type":
string
Required | The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Possible Values: Boolean
Date
Decimal
Double
Integer
Long
Money
Quantity
String
Text
MultipleBoolean
MultipleDate
MultipleDecimal
MultipleDouble
MultipleInteger
MultipleLong
MultipleString
}CustomerCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
{"data":
object
A CustomerRO_v1
object. 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!
{
"active":
boolean
Is customer active or deactivated? | Example: true
"addresses":
array
An array of string
literals. The addresses (IDs) of the customer.
"attributes":
array
Readonly | An array of AttributeRO_v1
objects.
[
Either BooleanAttributeRO_v1
: A representation of a boolean attribute.
{}
Or DateAttributeRO_v1
: A representation of a date/time attribute.
{}
Or DecimalAttributeRO_v1
: A representation of a decimal attribute.
{}
Or DoubleAttributeRO_v1
: A representation of a double attribute.
{}
Or IntegerAttributeRO_v1
: A representation of an integer attribute.
{}
Or LongAttributeRO_v1
: A representation of a long attribute.
{}
Or MoneyAttributeRO_v1
: A representation of a money attribute.
{}
Or QuantityAttributeRO_v1
: A representation of a quantity attribute.
{}
Or StringAttributeRO_v1
: A representation of a string attribute.
{}
Or TextAttributeRO_v1
: A representation of a text attribute.
{}
Or MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.
{}
Or MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.
{}
Or MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.
{}
Or MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.
{}
Or MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.
{}
Or MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.
{}
Or MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.
{}
]
"companyName1":
string
First part of customer's company name; for business customers only. | Example: OilCorp Ltd.
"companyName2":
string
Second part of customer's company name; for business customers only. | Example: OilCorp Corporate Headquarters
"customerType":
string
The type of the customer; could be either a private (B2C) or a business (B2B) customer. | Example: SMB
| Possible Values: PRIVATE
SMB
PRIVATE
SMB
"externalId":
string
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":
string
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":
string
Readonly | 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. | Example: OilCorp
"industry":
string
Sector of industry the customer belongs to. | Example: Oil & Gas
"taxIdentificationNumber":
string
A description of the customer. | Example: OilCorp produces gas and oil, focusing on Europe and North Africa.
"urn":
string
Readonly | The URN uniquely identifying the customer in the context of an Intershop ICM deployment. | Example: urn:customer:ICM:inSPIRED:inTRONICS_Business:OilCorp
"users":
array
An array of string
literals. The users (IDs) of the customer; for business customers only
}
"errors":
array
Readonly | An array of FeedbackRO_v1
objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1
:
An error or information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Readonly | Optionally included related data objects. Included via "include" query parameter.
{
{
"":
object
A AddressRO_v1
object. The address
{
"addressLine1":
string
The first address line, that usual contains street and house number. | Example: Berliner Str. 20
"addressLine2":
string
The second address line.
"addressLine3":
string
The third address line.
"aristocraticTitle":
string
The aristocratic title of the contact person, like 'Lord' or 'Lady'.
"attributes":
array
Readonly | An array of AttributeRO_v1
objects.
[
Either BooleanAttributeRO_v1
: A representation of a boolean attribute.
{}
Or DateAttributeRO_v1
: A representation of a date/time attribute.
{}
Or DecimalAttributeRO_v1
: A representation of a decimal attribute.
{}
Or DoubleAttributeRO_v1
: A representation of a double attribute.
{}
Or IntegerAttributeRO_v1
: A representation of an integer attribute.
{}
Or LongAttributeRO_v1
: A representation of a long attribute.
{}
Or MoneyAttributeRO_v1
: A representation of a money attribute.
{}
Or QuantityAttributeRO_v1
: A representation of a quantity attribute.
{}
Or StringAttributeRO_v1
: A representation of a string attribute.
{}
Or TextAttributeRO_v1
: A representation of a text attribute.
{}
Or MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.
{}
Or MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.
{}
Or MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.
{}
Or MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.
{}
Or MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.
{}
Or MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.
{}
Or MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.
{}
]
"city":
string
The name of the city. | Example: Potsdam
"companyName1":
string
The company name in case it is a business address. | Example: Intershop Communications AG
"companyName2":
string
The second company name
"country":
string
Readonly | The localized display name of the country | Example: Germany
"countryCode":
string
The ISO 3166-1 country code | Example: DE
"eligibleInstallToAddress":
boolean
Flag indicating that the address can be used as install-to address. | Example: false
"eligibleInvoiceToAddress":
boolean
Flag indicating that the address can be used as invoice-to address. | Example: true
"eligibleServiceToAddress":
boolean
Flag indicating that the address can be used as service-to address. | Example: false
"eligibleShipFromAddress":
boolean
Flag indicating that the address can be used as ship-from address. | Example: false
"eligibleShipToAddress":
boolean
Flag indicating that the address can be used as ship-to address. | Example: true
"email":
string
The e-mail address of the contact person. | Example: patricia@test.intershop.de
"externalId":
string
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":
string
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":
string
The fax number.
"firstName":
string
The given name (also known as a personal name, first name, forename, or Christian name) of the contact person | Example: Patricia
"honorific":
string
The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'.
"id":
string
The ID that identifies the address. | Example: 0987654321
"jobTitle":
string
The job title of the contact person.
"lastName":
string
The last name (also known as a family name, surname, or gentile name) of the contact person. | Example: Miller
"mainDivision":
string
Readonly | The localized display name of the main division | Example: Alabama
"mainDivisionCode":
string
The main division code of the country, e. g. a state or province. | Example: Al
"phoneBusiness":
string
The phone number of the contact person's company.
"phoneBusinessDirect":
string
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":
string
The phone number of the house or apartment where the contact person lives. | Example: 049364112677
"phoneMobile":
string
The number of the contact person's cell phone.
"postBox":
string
The post-office box.
"postalCode":
string
The postal code of the city. | Example: 14482
"secondLastName":
string
The second last name of the contact person.
"secondName":
string
The second given name of the contact person.
"subDivision":
string
Readonly | The localized display name of the sub division. | Example: City of Westminster
"subDivisionCode":
string
The sub division code. | Example: 020
"title":
string
The (personal) title of the contact person. | Example: Ms.
"urn":
string
The URN representation of this address. | Example: urn:address:customer:1234567890:0987654321
"usage":
object
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.
}
}
{
"":
object
A UserRO_v1
object. 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!
{
"accountId":
string
The account ID if the user in Intershop ICM. | Example: patricia.miller@test.intershop.de
"active":
boolean
Is user active or deactivated? | Example: true
"aristocraticTitle":
string
The aristocratic title of the user, like Lady, Lord. | Example: Lady
"attributes":
array
Readonly | An array of AttributeRO_v1
objects.
[
Either BooleanAttributeRO_v1
: A representation of a boolean attribute.
{}
Or DateAttributeRO_v1
: A representation of a date/time attribute.
{}
Or DecimalAttributeRO_v1
: A representation of a decimal attribute.
{}
Or DoubleAttributeRO_v1
: A representation of a double attribute.
{}
Or IntegerAttributeRO_v1
: A representation of an integer attribute.
{}
Or LongAttributeRO_v1
: A representation of a long attribute.
{}
Or MoneyAttributeRO_v1
: A representation of a money attribute.
{}
Or QuantityAttributeRO_v1
: A representation of a quantity attribute.
{}
Or StringAttributeRO_v1
: A representation of a string attribute.
{}
Or TextAttributeRO_v1
: A representation of a text attribute.
{}
Or MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.
{}
Or MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.
{}
Or MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.
{}
Or MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.
{}
Or MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.
{}
Or MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.
{}
Or MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.
{}
]
"company":
string
The name of the company where the user is employeed. | Example: INTERSHOP Communications AG
"creationDate":
string
Creation date of the user account. | Format: date-time
| Example: 2019-05-23T11:23:45.000Z
"dateOfBirth":
string
User's date of birth. | Format: date
| Example: 1989-07-11T00:00:00.000Z
"department":
string
The department the user is assigned to. | Example: Procurement
"email":
string
User's e-mail account. | Example: peter.sampleman@intershop.de
"externalId":
string
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":
string
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":
string
The number of user's facsimile machine. | Example: +49 (3641) 50-1344
"firstName":
string
The given name (also known as a personal name, first name, forename, or Christian name) of the user. | Example: Peter
"gender":
string
The gender of the user. | Example: FEMALE
| Possible Values: MALE
FEMALE
UNKNOWN
"honorific":
string
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":
string
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":
string
The job title of the user. | Example: Procurement Lead
"lastName":
string
The surname (also known as a family name, last name, or gentile name) of the user. | Example: Sampleman
"phoneBusiness":
string
The number of user's company. | Example: +49 (3641) 50-0
"phoneBusinessDirect":
string
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":
string
The phone number of the house or apartment where the user lives. | Example: +49 (3641) 123456
"phoneMobile":
string
The number of user's cell phone. | Example: +49 (165) 5673123
"preferredCurrency":
string
User's preferred currency in "ISO 4217" format. | Example: USD
"preferredInvoiceToAddressUrn":
string
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":
string
User's preferred language in "ISO 639 alpha-2" format. | Example: en
"preferredLocale":
string
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":
string
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":
string
User's preferred time zone ID. | Example: Europe/Berlin
"roles":
array
An array of string
literals.
"secondLastName":
string
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":
string
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":
string
The personal title, like Ms., Mr. | Example: Mr.
"urn":
string
Readonly | The URN uniquely identifying the user in the context of an Intershop ICM deployment. | Example: urn:user:ICM:inSPIRED:OilCorp:pmiller
}
}
}
"infos":
array
Readonly | An array of FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1
:
An error or information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
}CustomerRO_v1 application/json
{"active":
boolean
Is customer active or deactivated? | Example: true
"addresses":
array
An array of string
literals. The addresses (IDs) of the customer.
"attributes":
array
Readonly | An array of AttributeRO_v1
objects.
[
Either BooleanAttributeRO_v1
: A representation of a boolean attribute.
{}
Or DateAttributeRO_v1
: A representation of a date/time attribute.
{}
Or DecimalAttributeRO_v1
: A representation of a decimal attribute.
{}
Or DoubleAttributeRO_v1
: A representation of a double attribute.
{}
Or IntegerAttributeRO_v1
: A representation of an integer attribute.
{}
Or LongAttributeRO_v1
: A representation of a long attribute.
{}
Or MoneyAttributeRO_v1
: A representation of a money attribute.
{}
Or QuantityAttributeRO_v1
: A representation of a quantity attribute.
{}
Or StringAttributeRO_v1
: A representation of a string attribute.
{}
Or TextAttributeRO_v1
: A representation of a text attribute.
{}
Or MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.
{}
Or MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.
{}
Or MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.
{}
Or MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.
{}
Or MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.
{}
Or MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.
{}
Or MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.
{}
]
"companyName1":
string
First part of customer's company name; for business customers only. | Example: OilCorp Ltd.
"companyName2":
string
Second part of customer's company name; for business customers only. | Example: OilCorp Corporate Headquarters
"customerType":
string
The type of the customer; could be either a private (B2C) or a business (B2B) customer. | Example: SMB
| Possible Values: PRIVATE
SMB
PRIVATE
SMB
"externalId":
string
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":
string
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":
string
Readonly | 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. | Example: OilCorp
"industry":
string
Sector of industry the customer belongs to. | Example: Oil & Gas
"taxIdentificationNumber":
string
A description of the customer. | Example: OilCorp produces gas and oil, focusing on Europe and North Africa.
"urn":
string
Readonly | The URN uniquely identifying the customer in the context of an Intershop ICM deployment. | Example: urn:customer:ICM:inSPIRED:inTRONICS_Business:OilCorp
"users":
array
An array of string
literals. The users (IDs) of the customer; for business customers only
}FeedbackCtnrRO_v1 application/vnd.intershop.admin.customer.v1+json
{"errors":
array
Readonly | An array of FeedbackRO_v1
objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1
:
An error or information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Optionally included related data objects.
"infos":
array
Readonly | An array of FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1
:
An error or information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath
}
]
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation:
https://github.com/json-path/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
}UserRO_v1 application/json
{"accountId":
string
The account ID if the user in Intershop ICM. | Example: patricia.miller@test.intershop.de
"active":
boolean
Is user active or deactivated? | Example: true
"aristocraticTitle":
string
The aristocratic title of the user, like Lady, Lord. | Example: Lady
"attributes":
array
Readonly | An array of AttributeRO_v1
objects.
[
Either BooleanAttributeRO_v1
: A representation of a boolean attribute.
{}
Or DateAttributeRO_v1
: A representation of a date/time attribute.
{}
Or DecimalAttributeRO_v1
: A representation of a decimal attribute.
{}
Or DoubleAttributeRO_v1
: A representation of a double attribute.
{}
Or IntegerAttributeRO_v1
: A representation of an integer attribute.
{}
Or LongAttributeRO_v1
: A representation of a long attribute.
{}
Or MoneyAttributeRO_v1
: A representation of a money attribute.
{}
Or QuantityAttributeRO_v1
: A representation of a quantity attribute.
{}
Or StringAttributeRO_v1
: A representation of a string attribute.
{}
Or TextAttributeRO_v1
: A representation of a text attribute.
{}
Or MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.
{}
Or MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.
{}
Or MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.
{}
Or MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.
{}
Or MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.
{}
Or MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.
{}
Or MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.
{}
]
"company":
string
The name of the company where the user is employeed. | Example: INTERSHOP Communications AG
"creationDate":
string
Creation date of the user account. | Format: date-time
| Example: 2019-05-23T11:23:45.000Z
"dateOfBirth":
string
User's date of birth. | Format: date
| Example: 1989-07-11T00:00:00.000Z
"department":
string
The department the user is assigned to. | Example: Procurement
"email":
string
User's e-mail account. | Example: peter.sampleman@intershop.de
"externalId":
string
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":
string
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":
string
The number of user's facsimile machine. | Example: +49 (3641) 50-1344
"firstName":
string
The given name (also known as a personal name, first name, forename, or Christian name) of the user. | Example: Peter
"gender":
string
The gender of the user. | Example: FEMALE
| Possible Values: MALE
FEMALE
UNKNOWN
"honorific":
string
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":
string
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":
string
The job title of the user. | Example: Procurement Lead
"lastName":
string
The surname (also known as a family name, last name, or gentile name) of the user. | Example: Sampleman
"phoneBusiness":
string
The number of user's company. | Example: +49 (3641) 50-0
"phoneBusinessDirect":
string
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":
string
The phone number of the house or apartment where the user lives. | Example: +49 (3641) 123456
"phoneMobile":
string
The number of user's cell phone. | Example: +49 (165) 5673123
"preferredCurrency":
string
User's preferred currency in "ISO 4217" format. | Example: USD
"preferredInvoiceToAddressUrn":
string
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":
string
User's preferred language in "ISO 639 alpha-2" format. | Example: en
"preferredLocale":
string
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":
string
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":
string
User's preferred time zone ID. | Example: Europe/Berlin
"roles":
array
An array of string
literals.
"secondLastName":
string
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":
string
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":
string
The personal title, like Ms., Mr. | Example: Mr.
"urn":
string
Readonly | The URN uniquely identifying the user in the context of an Intershop ICM deployment. | Example: urn:user:ICM:inSPIRED:OilCorp:pmiller
}The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.