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/{CustomerKey}/addresses
GET: Returns the customer's addresses
Description
This operation returns a list of the customer's addresses based on the provided CustomerResourceKey. The response resource collection contains objects of the type LinkRO.
Java Method
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressListResource.getAddresses()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK - The addresses of the customer.
ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {CustomerAddressKey}
in subsequent requests. Links to item of type AddressRO.
401 - Unauthorized - The organization is not valid.
POST: Create new customer address
Description
Creates a new customer address by using POST data provided by the client
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressListResource.createAddress(com.intershop.sellside.rest.common.capi.resourceobject.AddressRO)
Request Body
AddressRO application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK The created address is a duplicate. The existing instance is returned.
201 - Created Creation of a unique address finished succesfully
400 - Bad Request possible values for header error-key:
- customer.address.invalid_fields.usage.error
- customer.address.missing_fields.error
401 - Unauthorized
404 - Not Found possible values for header error-key:
- customer.address.not_found.error
/customers/{CustomerKey}/addresses/{CustomerAddressKey}
GET: Get customer address details
Description
Returns details about customer's address to the client
Java Method
public com.intershop.sellside.rest.common.capi.resourceobject.AddressRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource.getAddress()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerAddressKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
AddressRO application/json
401 - Unauthorized
404 - Not Found possible values for header error-key:
- customer.address_not_found.error
PUT: Update customer address
Description
Updates a customer address with address data provided from the client
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource.updateAddress(com.intershop.sellside.rest.common.capi.resourceobject.AddressRO)
Request Body
AddressRO application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerAddressKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
400 - Bad Request possible values for header error-key:
- customer.address.missing_fields.error
- customer.address.update.error.inconsistentUsage
Other errors (customer.address.update.error.failureCode
) may be returned if AddressUpdateHandlers
are registered
401 - Unauthorized
403 - Forbidden possible values for header error-key:
- customer.address.update.error.AddressNotUpdatable
404 - Not Found possible values for header error-key:
- customer.address.not_found.error
DELETE: Delete customer address
Description
Deletes a customer address
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource.deleteAddress()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerAddressKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
204 - No Content
401 - Unauthorized
404 - Not Found
409 - Conflict possible values for header error-key:
- customer.address.deletion.error.LastAddress
- customer.address.deletion.error.WrongAddressRepository
Other errors (customer.address.deletion.error.failureCode
) may be returned if additional AddressDeletionHandlers
are registered
/privatecustomers/{CustomerKey}/addresses
GET: Returns the customer's addresses
Description
This operation returns a list of the customer's addresses based on the provided CustomerResourceKey. The response resource collection contains objects of the type LinkRO.
Java Method
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressListResource.getAddresses()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK - The addresses of the customer.
ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {CustomerAddressKey}
in subsequent requests. Links to item of type AddressRO.
401 - Unauthorized - The organization is not valid.
POST: Create new customer address
Description
Creates a new customer address by using POST data provided by the client
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressListResource.createAddress(com.intershop.sellside.rest.common.capi.resourceobject.AddressRO)
Request Body
AddressRO application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK The created address is a duplicate. The existing instance is returned.
201 - Created Creation of a unique address finished succesfully
400 - Bad Request possible values for header error-key:
- customer.address.invalid_fields.usage.error
- customer.address.missing_fields.error
401 - Unauthorized
404 - Not Found possible values for header error-key:
- customer.address.not_found.error
/privatecustomers/{CustomerKey}/addresses/{CustomerAddressKey}
GET: Get customer address details
Description
Returns details about customer's address to the client
Java Method
public com.intershop.sellside.rest.common.capi.resourceobject.AddressRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource.getAddress()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerAddressKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
AddressRO application/json
401 - Unauthorized
404 - Not Found possible values for header error-key:
- customer.address_not_found.error
PUT: Update customer address
Description
Updates a customer address with address data provided from the client
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource.updateAddress(com.intershop.sellside.rest.common.capi.resourceobject.AddressRO)
Request Body
AddressRO application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerAddressKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
400 - Bad Request possible values for header error-key:
- customer.address.missing_fields.error
- customer.address.update.error.inconsistentUsage
Other errors (customer.address.update.error.failureCode
) may be returned if AddressUpdateHandlers
are registered
401 - Unauthorized
403 - Forbidden possible values for header error-key:
- customer.address.update.error.AddressNotUpdatable
404 - Not Found possible values for header error-key:
- customer.address.not_found.error
DELETE: Delete customer address
Description
Deletes a customer address
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource.deleteAddress()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerAddressKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
204 - No Content
401 - Unauthorized
404 - Not Found
409 - Conflict possible values for header error-key:
- customer.address.deletion.error.LastAddress
- customer.address.deletion.error.WrongAddressRepository
Other errors (customer.address.deletion.error.failureCode
) may be returned if additional AddressDeletionHandlers
are registered
/customers
POST: registers a new SMB customer
Description
--
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource.createCustomer(com.intershop.sellside.rest.smb.capi.resourceobject.NewCustomerRO)
Request Body
NewCustomerRO application/json
Request Parameters
--
Response
201 - Created
LinkRO application/json
400 - Bad Request
401 - Unauthorized Authorization is required if the customer gets assigned to an existing user
403 - Forbidden Authorized user has to be the same as the one to get assigned to the new customer
/customers/{CustomerKey}
GET: Get customer profile of currently logged in user
Description
--
Java Method
public com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerRO com.intershop.sellside.rest.smb.capi.resource.customer.CustomerItemResource.getCustomer()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
SMBCustomerRO application/json
401 - Unauthorized
403 - Forbidden
404 - Not Found
PUT: Update customer profile of currently logged in user
Description
--
Java Method
public com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerRO com.intershop.sellside.rest.smb.capi.resource.customer.CustomerItemResource.updateCustomer(com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerRO)
Request Body
SMBCustomerRO application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
SMBCustomerRO application/json
401 - Unauthorized
404 - Not Found
/privatecustomers
POST: Create individual customer
Description
Creates an individual customer. Available for unregistered users only.
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource.createCustomer(com.intershop.sellside.rest.b2c.capi.resourceobject.NewCustomerRO)
Request Body
NewCustomerRO application/json
Request Parameters
--
Response
201 - Created
400 - Bad Request possible values for header error-key:
- customer.already_exists.error
- customer.customerno.already_exists.error
- customer.missing_fields.error
- customer.invalid_fields.error
- customer.credentials.missing_fields.error
- customer.credentials.login.not_acceptable.error
- customer.credentials.login.not_unique.error
- customer.credentials.password.invalid.error
- customer.address.missing_fields.error
401 - Unauthorized Authorization is required if the customer gets assigned to an existing user
403 - Forbidden Authorized user has to be the same as the one to get assigned to the new customer
409 - Conflict
/privatecustomers/simple
POST: Create Customer
Description
simplified creation process for new customerwith minimal information
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource.createAccount(com.intershop.sellside.rest.common.capi.resourceobject.CredentialsRO)
Request Body
CredentialsRO application/json
Request Parameters
--
Response
201 - Created
400 - Bad Request
409 - Conflict possible values for header error-key:
- customer.already_exists.error
501 - Not Implemented possible values for header error-key:
- customer.simpleaccount.not_possible.error
/privatecustomers/{CustomerKey}
GET: Get current customer profile details
Description
--
Java Method
public com.intershop.sellside.rest.b2c.capi.resourceobject.PrivateCustomerRO com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerItemResource.getCustomer()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
PrivateCustomerRO application/json
401 - Unauthorized
403 - Forbidden
404 - Not Found
PUT: Upates a customer
Description
--
Java Method
public com.intershop.sellside.rest.b2c.capi.resourceobject.PrivateCustomerRO com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerItemResource.updateCustomer(com.intershop.sellside.rest.b2c.capi.resourceobject.PrivateCustomerRO)
Request Body
PrivateCustomerRO application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
PrivateCustomerRO application/json
400 - Bad Request
401 - Unauthorized
404 - Not Found
/customers/{CustomerKey}/users/{CustomerItemUserKey}/giftcardsandcertificates
GET: Returns gift cards and certificates
Description
This operation returns a list of gift cards and certificates associated with the current user.
Java Method
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.CustomerGiftCardsAndCertificatesResource.getGiftCardsAndCertificates()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerItemUserKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK - The list of gift cards and certificates.
LinkROResourceCollectionRO application/json
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The authenticated user does not match the requested user.
404 - Not Found - The customer or user could not be found.
/customers/{CustomerKey}/users/{CustomerItemUserKey}/giftcardsandcertificates/{CustomerGiftCardAndCertificateResourceKey}
GET: Returns gift card or certificate details
Description
This operation returns details about a specific gift card or certificate associated with the current user.
Java Method
public com.intershop.sellside.rest.common.capi.resourceobject.GiftCardAndCertificateRO com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.balance.CustomerGiftCardAndCertificateResource.getGiftCardAndCertificate()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerItemUserKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerGiftCardAndCertificateResourceKey | string | | 27755166187 | Required | The gift card or certificate number |
Response
200 - OK - The gift card or certificate with the given ID.
GiftCardAndCertificateRO application/json
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The authenticated user does not match the requested user.
404 - Not Found - The customer, user or gift card/certificate could not be found.
/privatecustomers/{CustomerKey}/giftcardsandcertificates
GET: Returns gift cards and certificates
Description
This operation returns a list of gift cards and certificates associated with the current user.
Java Method
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.CustomerGiftCardsAndCertificatesResource.getGiftCardsAndCertificates()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK - The list of gift cards and certificates.
LinkROResourceCollectionRO application/json
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The authenticated user does not match the requested user.
404 - Not Found - The customer or user could not be found.
/privatecustomers/{CustomerKey}/giftcardsandcertificates/{CustomerGiftCardAndCertificateResourceKey}
GET: Returns gift card or certificate details
Description
This operation returns details about a specific gift card or certificate associated with the current user.
Java Method
public com.intershop.sellside.rest.common.capi.resourceobject.GiftCardAndCertificateRO com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.balance.CustomerGiftCardAndCertificateResource.getGiftCardAndCertificate()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerGiftCardAndCertificateResourceKey | string | | 27755166187 | Required | The gift card or certificate number |
Response
200 - OK - The gift card or certificate with the given ID.
GiftCardAndCertificateRO application/json
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The authenticated user does not match the requested user.
404 - Not Found - The customer, user or gift card/certificate could not be found.
/customers/{CustomerKey}/payments
GET: Get list of customer profile payments
Description
Returns a list of all payment methods as Links that are store in the customer profile of the logged in customer.
Java Method
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource.getPayments()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {CustomerPaymentKey}
in subsequent requests. Links to item of type PaymentRO.
401 - Unauthorized
404 - Not Found value for header error-key:
- payment.instrument.not_found.error (e.g. unregistred user)
POST: Add a payment to Customer profile
Description
Adds a payment to the customer profile of the logged in customer.
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource.createPayment(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO)
Request Body
PaymentRO application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
201 - Created
400 - Bad Request possible values for header error-key:
- shopping_cart.payment.paymentdata.error (e.g., wrong giftcard number)
- shopping_cart.payment.missing_fields.error
- shopping_cart.payment.invalid_fields.error
- shopping_cart.payment.name.error (payment method not found)
- shopping_cart.payment.dublicate.error
401 - Unauthorized
OPTIONS: Return payment options for customer
Description
Returns all available payment methods and its parameters that can be added to the customer
Java Method
public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentOptionsRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource.getPaymentOptions()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
PaymentOptionsRO application/json
401 - Unauthorized
/customers/{CustomerKey}/payments/{CustomerPaymentKey}
GET: Get details of a customer profile payment
Description
Returns detailed information of a payment method available for a customer
Java Method
public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource.getPayment()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerPaymentKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
PaymentRO application/json
401 - Unauthorized
404 - Not Found value for header error-key:
- payment.instrument.not_found.error (e.g. unregistred user)
PUT: Update payment from customer profile
Description
Updates a payment (with attributes) from customer profile for the logged in user. The request has to contain all attributes even if they are not changed. Payments without further attributes can not be updated.
Java Method
public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource.updatePayment(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO)
Request Body
PaymentRO application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerPaymentKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
PaymentRO application/json
400 - Bad Request possible values for header error-key:
- shopping_cart.payment.paymentdata.error (e.g. wrong giftcard number)
- shopping_cart.payment.missing_fields.error
- shopping_cart.payment.invalid_fields.error
401 - Unauthorized
DELETE: Remove a payment from customer profile
Description
Removes a payment method from the customer profile of the logged in customer
Java Method
public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource.deletePayment()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerPaymentKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
LinkRO application/json
401 - Unauthorized
404 - Not Found
/privatecustomers/{CustomerKey}/payments
GET: Get list of customer profile payments
Description
Returns a list of all payment methods as Links that are store in the customer profile of the logged in customer.
Java Method
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource.getPayments()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {CustomerPaymentKey}
in subsequent requests. Links to item of type PaymentRO.
401 - Unauthorized
404 - Not Found value for header error-key:
- payment.instrument.not_found.error (e.g. unregistred user)
POST: Add a payment to Customer profile
Description
Adds a payment to the customer profile of the logged in customer.
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource.createPayment(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO)
Request Body
PaymentRO application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
201 - Created
400 - Bad Request possible values for header error-key:
- shopping_cart.payment.paymentdata.error (e.g., wrong giftcard number)
- shopping_cart.payment.missing_fields.error
- shopping_cart.payment.invalid_fields.error
- shopping_cart.payment.name.error (payment method not found)
- shopping_cart.payment.dublicate.error
401 - Unauthorized
OPTIONS: Return payment options for customer
Description
Returns all available payment methods and its parameters that can be added to the customer
Java Method
public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentOptionsRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource.getPaymentOptions()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
PaymentOptionsRO application/json
401 - Unauthorized
/privatecustomers/{CustomerKey}/payments/{CustomerPaymentKey}
GET: Get details of a customer profile payment
Description
Returns detailed information of a payment method available for a customer
Java Method
public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource.getPayment()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerPaymentKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
PaymentRO application/json
401 - Unauthorized
404 - Not Found value for header error-key:
- payment.instrument.not_found.error (e.g. unregistred user)
PUT: Update payment from customer profile
Description
Updates a payment (with attributes) from customer profile for the logged in user. The request has to contain all attributes even if they are not changed. Payments without further attributes can not be updated.
Java Method
public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource.updatePayment(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO)
Request Body
PaymentRO application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerPaymentKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
PaymentRO application/json
400 - Bad Request possible values for header error-key:
- shopping_cart.payment.paymentdata.error (e.g. wrong giftcard number)
- shopping_cart.payment.missing_fields.error
- shopping_cart.payment.invalid_fields.error
401 - Unauthorized
DELETE: Remove a payment from customer profile
Description
Removes a payment method from the customer profile of the logged in customer
Java Method
public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource.deletePayment()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerPaymentKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
LinkRO application/json
401 - Unauthorized
404 - Not Found
/customers/{CustomerKey}/users
GET: Get users of SMB customer
Description
List all registered users of selected SMB customer with link to user item resource.
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource.getCustomers()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in query | offset | string | 0 | | The start element position |
in query | limit | string | 50 | | The count of users to return |
in query | filter | string | | | Only users which firtName, lastName or login contains the filter will be returned |
in query | sort | string | name | | The sorting to be applied on returned users. Minus means sorting in DESC direction. |
Response
200 - OK The list of registered users
UserLinkROCollection application/json
401 - Unauthorized
404 - Not Found
POST: Registers new users of SMB customer
Description
--
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource.addUsersToCustomer(com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerUserROCollection)
Request Body
SMBCustomerUserROCollection application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
201 - Created Collection with links to created users
UserLinkROCollection application/json
207 - Multi-Status Collection with links to created users and header 'not-created-users' with list of users which creation finished with error
UserLinkROCollection application/json
400 - Bad Request In case provided login is not acceptable
401 - Unauthorized
409 - Conflict In case user with provided login or business partner number already exists
500 - Internal Server Error In case provided user data contain missing or invalid fields
/customers/{CustomerKey}/users/{CustomerItemUserKey}
GET: Get user profile data of selected user
Description
--
Java Method
public com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerUserRO com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserItemResource.getCustomerUser()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerItemUserKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in query | include | string | | | The relations to be included in returned user data, If not provided all user data will be included. |
Response
200 - OK Display available user data. In case user has preferred address assigned, all address data will be displayed in the response.
SMBCustomerUserRO application/json
401 - Unauthorized
404 - Not Found
PUT: Update the profile of selected user of SMB customer
Description
--
Java Method
public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserItemResource.updateCustomerUser(com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerUserRO)
Request Body
SMBCustomerUserRO application/json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerItemUserKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
200 - OK
SMBCustomerUserRO application/json
400 - Bad Request
401 - Unauthorized
404 - Not Found
409 - Conflict In case user with provided business partner number already exists
500 - Internal Server Error In case provided user data contain missing or invalid fields
DELETE: Delete user of SMB customer
Description
Deletes the user with the same ID or login as the item resource name
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserItemResource.deleteUser()
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | CustomerKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | CustomerItemUserKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
Response
204 - No Content
401 - Unauthorized
403 - Forbidden Requires authentication with user having assigned the following permission: Manage Users (APP_B2B_MANAGE_USERS)
404 - Not Found
AddressRO application/json
{"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Address
"urn":
string
the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
"id":
string
The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
"addressName":
string
The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
"title":
string
The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
"aristocraticTitle":
string
the aristocratic title of the contact person, like Lord or Lady
"jobTitle":
string
the job title of the contact person | Example: CEO
"honorific":
string
the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
"firstName":
string
The (first) given name of the contact person | Example: Patricia
"secondName":
string
the second given name of the contact person | Example: Luise
"lastName":
string
The last name of the contact person | Example: Miller
"secondLastName":
string
the second last name of the contact person
"companyName1":
string
the company name | Example: PMiller ltd.
"companyName2":
string
The second company name
"addressLine1":
string
the first address line | Example: Berliner Str. 20
"addressLine2":
string
the second address line | Example: 1st Floor
"addressLine3":
string
The third address line | Example: Second door on the right
"postBox":
string
the post-office box | Example: PO Box 42
"mainDivision":
string
the main division of the country, e. g. a state or province | Example: AL
"mainDivisionName":
string
The localized display name of the main division | Example: Alabama
"subDivision":
string
The sub division code of the country. | Example: GB-PKN
"subDivisionName":
string
The localized display name of the sub division | Example: Perth and Kinross
"postalCode":
string
The postal code | Example: 14482
"email":
string
the e-mail address of the contact person | Example: pmiller@intershop.de
"phoneMobile":
string
The number of the contact person's cell phone | Example: 49364112677
"phoneHome":
string
The phone number of the house or apartment where the contact person lives | Example: 049364112677
"phoneBusiness":
string
The phone number of the contact person's company | Example: 049364112699
"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 | Example: 049364112659
"country":
string
The display name of the country in the current locale | Example: Germany
"countryCode":
string
The country code | Example: DE
"city":
string
The name of the city | Example: Potsdam
"fax":
string
the fax number | Example: 049364112643
"usage":
object
Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
}CredentialsRO application/json
{"name":
string
The name of an element
"type":
string
Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
"login":
string
the login | Example: pmiller@test.intershop.de
"password":
string
the password | Example: !InterShop00!
"securityQuestion":
string
the security question | Example: what was the name of your first pet?
"securityQuestionAnswer":
string
the security questions answer | Example: Snoopy
}GiftCardAndCertificateRO application/json
{"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: GiftCardAndCertificate
"currency":
string
The currency of the gift card | Example: USD
"amount":
number
The value of the gift card | Example: 25
"amountRemaining":
number
The remaining value of the gift card | Example: 12.73
}LinkRO application/json
{"name":
string
The name of the returned element
"type":
string
Readonly | This is a constant: Link | Example: Link
"attributes":
array
An array of ResourceAttribute
objects. The list of attributes
[
ResourceAttribute
:
An attribute{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
]
"relation":
string
The relation of the link | Documentation:
Link Relations (www.iana.org) | Possible Values:
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
"title":
string
The title of the link
"description":
string
The description of the link
"itemId":
string
The ID of the linked item
"attribute":
object
A ResourceAttribute
object. An attribute
{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
}LinkROResourceCollectionRO application/json
{"pageable":
string
The pageable ID
"total":
integer
The pageable amount total | Format: int32
"offset":
integer
The pageable offset | Format: int32
"amount":
integer
The pageable amount | Format: int32
"elements":
array
An array of LinkRO
objects. The list of elements
[
LinkRO
:
A Link pointing to a resource{
"name":
string
The name of the returned element
"type":
string
Readonly | This is a constant: Link | Example: Link
"attributes":
array
An array of ResourceAttribute
objects. The list of attributes
[
ResourceAttribute
:
An attribute{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
]
"relation":
string
The relation of the link | Documentation:
Link Relations (www.iana.org) | Possible Values:
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
"title":
string
The title of the link
"description":
string
The description of the link
"itemId":
string
The ID of the linked item
"attribute":
object
A ResourceAttribute
object. An attribute
{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
}
]
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type.
"sortKeys":
array
An array of string
literals. The keys to sort for
"name":
string
The name of an element
}NewCustomerRO application/json
{"address":
object
A AddressRO
object. This resource holds the details of an address.
{
"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Address
"urn":
string
the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
"id":
string
The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
"addressName":
string
The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
"title":
string
The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
"aristocraticTitle":
string
the aristocratic title of the contact person, like Lord or Lady
"jobTitle":
string
the job title of the contact person | Example: CEO
"honorific":
string
the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
"firstName":
string
The (first) given name of the contact person | Example: Patricia
"secondName":
string
the second given name of the contact person | Example: Luise
"lastName":
string
The last name of the contact person | Example: Miller
"secondLastName":
string
the second last name of the contact person
"companyName1":
string
the company name | Example: PMiller ltd.
"companyName2":
string
The second company name
"addressLine1":
string
the first address line | Example: Berliner Str. 20
"addressLine2":
string
the second address line | Example: 1st Floor
"addressLine3":
string
The third address line | Example: Second door on the right
"postBox":
string
the post-office box | Example: PO Box 42
"mainDivision":
string
the main division of the country, e. g. a state or province | Example: AL
"mainDivisionName":
string
The localized display name of the main division | Example: Alabama
"subDivision":
string
The sub division code of the country. | Example: GB-PKN
"subDivisionName":
string
The localized display name of the sub division | Example: Perth and Kinross
"postalCode":
string
The postal code | Example: 14482
"email":
string
the e-mail address of the contact person | Example: pmiller@intershop.de
"phoneMobile":
string
The number of the contact person's cell phone | Example: 49364112677
"phoneHome":
string
The phone number of the house or apartment where the contact person lives | Example: 049364112677
"phoneBusiness":
string
The phone number of the contact person's company | Example: 049364112699
"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 | Example: 049364112659
"country":
string
The display name of the country in the current locale | Example: Germany
"countryCode":
string
The country code | Example: DE
"city":
string
The name of the city | Example: Potsdam
"fax":
string
the fax number | Example: 049364112643
"usage":
object
Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
}
"birthday":
string
the birthday of the customer | Example: 1970-03-10T00:00:00.000Z
"credentials":
object
A CredentialsRO
object. the credentials of the new customer as CredentialsRO
{
"name":
string
The name of an element
"type":
string
Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
"login":
string
the login | Example: pmiller@test.intershop.de
"password":
string
the password | Example: !InterShop00!
"securityQuestion":
string
the security question | Example: what was the name of your first pet?
"securityQuestionAnswer":
string
the security questions answer | Example: Snoopy
}
"customerType":
string
Readonly | the type of the customer | Example: PRIVATE
"email":
string
the email address of the customer | Example: patrik@test.intershop.net
"fax":
string
the fax number of the customer | Example: 4211324
"firstName":
string
the first name of the customer | Example: Patrik
"lastName":
string
the last name of the customer | Example: Mueller
"login":
string
the login(username) of the customer | Example: patrik_83
"name":
string
The name of an element
"phoneBusiness":
string
the business phone number of the customer | Example: 4211324
"phoneHome":
string
the phone home number of the customer | Example: 4211324
"phoneMobile":
string
the mobile phone number of the customer | Example: 4211324
"preferredInvoiceToAddress":
object
A AddressRO
object. This resource holds the details of an address.
{
"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Address
"urn":
string
the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
"id":
string
The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
"addressName":
string
The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
"title":
string
The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
"aristocraticTitle":
string
the aristocratic title of the contact person, like Lord or Lady
"jobTitle":
string
the job title of the contact person | Example: CEO
"honorific":
string
the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
"firstName":
string
The (first) given name of the contact person | Example: Patricia
"secondName":
string
the second given name of the contact person | Example: Luise
"lastName":
string
The last name of the contact person | Example: Miller
"secondLastName":
string
the second last name of the contact person
"companyName1":
string
the company name | Example: PMiller ltd.
"companyName2":
string
The second company name
"addressLine1":
string
the first address line | Example: Berliner Str. 20
"addressLine2":
string
the second address line | Example: 1st Floor
"addressLine3":
string
The third address line | Example: Second door on the right
"postBox":
string
the post-office box | Example: PO Box 42
"mainDivision":
string
the main division of the country, e. g. a state or province | Example: AL
"mainDivisionName":
string
The localized display name of the main division | Example: Alabama
"subDivision":
string
The sub division code of the country. | Example: GB-PKN
"subDivisionName":
string
The localized display name of the sub division | Example: Perth and Kinross
"postalCode":
string
The postal code | Example: 14482
"email":
string
the e-mail address of the contact person | Example: pmiller@intershop.de
"phoneMobile":
string
The number of the contact person's cell phone | Example: 49364112677
"phoneHome":
string
The phone number of the house or apartment where the contact person lives | Example: 049364112677
"phoneBusiness":
string
The phone number of the contact person's company | Example: 049364112699
"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 | Example: 049364112659
"country":
string
The display name of the country in the current locale | Example: Germany
"countryCode":
string
The country code | Example: DE
"city":
string
The name of the city | Example: Potsdam
"fax":
string
the fax number | Example: 049364112643
"usage":
object
Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
}
"preferredLanguage":
string
the preferred language of the customer | Example: de_DE
"preferredPaymentInstrument":
object
A PaymentRO
object.
{
"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Payment
"attributes":
array
An array of ResourceAttribute
objects. The list of attributes
[
ResourceAttribute
:
An attribute{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
]
"id":
string
The payment ID | Example: dhKsEmZRPyEAAAF2hyV6dB2n
"limitedTenderBalance":
object
A MoneyRO
object. Money combines a currency and a money amount.
{
"type":
string
Readonly | This is a constant: Money | Example: Money
"value":
number
The monetary value. | Example: 10.99
"currencyMnemonic":
string
Deprecated
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
}
"paymentTotalAmount":
object
A MoneyRO
object. Money combines a currency and a money amount.
{
"type":
string
Readonly | This is a constant: Money | Example: Money
"value":
number
The monetary value. | Example: 10.99
"currencyMnemonic":
string
Deprecated
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
}
"accountIdentifier":
string
Readonly | The optional account identifier for this payment instrument | Example: DE12****7890
"parameters":
array
An array of GenericPropertyROObject
objects. The parameters for this payment
[
GenericPropertyROObject
{
"name":
string
The name of an element
"type":
string
Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
}
]
"attribute":
object
A ResourceAttribute
object. An attribute
{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
}
"preferredShipToAddress":
object
A AddressRO
object. This resource holds the details of an address.
{
"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Address
"urn":
string
the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
"id":
string
The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
"addressName":
string
The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
"title":
string
The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
"aristocraticTitle":
string
the aristocratic title of the contact person, like Lord or Lady
"jobTitle":
string
the job title of the contact person | Example: CEO
"honorific":
string
the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
"firstName":
string
The (first) given name of the contact person | Example: Patricia
"secondName":
string
the second given name of the contact person | Example: Luise
"lastName":
string
The last name of the contact person | Example: Miller
"secondLastName":
string
the second last name of the contact person
"companyName1":
string
the company name | Example: PMiller ltd.
"companyName2":
string
The second company name
"addressLine1":
string
the first address line | Example: Berliner Str. 20
"addressLine2":
string
the second address line | Example: 1st Floor
"addressLine3":
string
The third address line | Example: Second door on the right
"postBox":
string
the post-office box | Example: PO Box 42
"mainDivision":
string
the main division of the country, e. g. a state or province | Example: AL
"mainDivisionName":
string
The localized display name of the main division | Example: Alabama
"subDivision":
string
The sub division code of the country. | Example: GB-PKN
"subDivisionName":
string
The localized display name of the sub division | Example: Perth and Kinross
"postalCode":
string
The postal code | Example: 14482
"email":
string
the e-mail address of the contact person | Example: pmiller@intershop.de
"phoneMobile":
string
The number of the contact person's cell phone | Example: 49364112677
"phoneHome":
string
The phone number of the house or apartment where the contact person lives | Example: 049364112677
"phoneBusiness":
string
The phone number of the contact person's company | Example: 049364112699
"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 | Example: 049364112659
"country":
string
The display name of the country in the current locale | Example: Germany
"countryCode":
string
The country code | Example: DE
"city":
string
The name of the city | Example: Potsdam
"fax":
string
the fax number | Example: 049364112643
"usage":
object
Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
}
"title":
string
the title of the customer | Example: Mr
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: PrivateCustomer
"userId":
string
the id of the user this customer is based on. If not set, credentials and user data are mandatory.
}PaymentOptionsRO application/json
{"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: PaymentOptions
"methods":
array
An array of PaymentOptionsForMethodRO
objects. The payment methods that can be added via HTTP
[
PaymentOptionsForMethodRO
:
This resource holds information about payment methods that can be added and the HTTP method to be used.{
"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: PaymentOptionsForMethodRO
"payments":
array
An array of PaymentOptionRO
objects. The payments
[
PaymentOptionRO
:
This resource holds information on a payment option.{
"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: PaymentOption
"id":
string
The ID of the payment option | Example: ISH_INVOICE
"displayName":
string
The display name of the payment option | Example: Invoice
"applicability":
string
Example: Applicable
"restrictions":
array
An array of string
literals. The restrictions for this payment option
"paymentParameters":
array
An array of GenericPropertyROObject
objects. The parameters for this payment option
[
GenericPropertyROObject
{
"name":
string
The name of an element
"type":
string
Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
}
]
}
]
"method":
string
The HTTP method to use when adding this method | Example: POST
}
]
}PaymentRO application/json
{"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Payment
"attributes":
array
An array of ResourceAttribute
objects. The list of attributes
[
ResourceAttribute
:
An attribute{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
]
"id":
string
The payment ID | Example: dhKsEmZRPyEAAAF2hyV6dB2n
"limitedTenderBalance":
object
A MoneyRO
object. Money combines a currency and a money amount.
{
"type":
string
Readonly | This is a constant: Money | Example: Money
"value":
number
The monetary value. | Example: 10.99
"currencyMnemonic":
string
Deprecated
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
}
"paymentTotalAmount":
object
A MoneyRO
object. Money combines a currency and a money amount.
{
"type":
string
Readonly | This is a constant: Money | Example: Money
"value":
number
The monetary value. | Example: 10.99
"currencyMnemonic":
string
Deprecated
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
}
"accountIdentifier":
string
Readonly | The optional account identifier for this payment instrument | Example: DE12****7890
"parameters":
array
An array of GenericPropertyROObject
objects. The parameters for this payment
[
GenericPropertyROObject
{
"name":
string
The name of an element
"type":
string
Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
}
]
"attribute":
object
A ResourceAttribute
object. An attribute
{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
}PrivateCustomerRO application/json
{"birthday":
string
the birthday of the customer | Example: 1970-03-10T00:00:00.000Z
"customerType":
string
Readonly | the type of the customer | Example: PRIVATE
"email":
string
the email address of the customer | Example: patrik@test.intershop.net
"fax":
string
the fax number of the customer | Example: 4211324
"firstName":
string
the first name of the customer | Example: Patrik
"lastName":
string
the last name of the customer | Example: Mueller
"login":
string
the login(username) of the customer | Example: patrik_83
"name":
string
The name of an element
"phoneBusiness":
string
the business phone number of the customer | Example: 4211324
"phoneHome":
string
the phone home number of the customer | Example: 4211324
"phoneMobile":
string
the mobile phone number of the customer | Example: 4211324
"preferredInvoiceToAddress":
object
A AddressRO
object. This resource holds the details of an address.
{
"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Address
"urn":
string
the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
"id":
string
The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
"addressName":
string
The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
"title":
string
The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
"aristocraticTitle":
string
the aristocratic title of the contact person, like Lord or Lady
"jobTitle":
string
the job title of the contact person | Example: CEO
"honorific":
string
the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
"firstName":
string
The (first) given name of the contact person | Example: Patricia
"secondName":
string
the second given name of the contact person | Example: Luise
"lastName":
string
The last name of the contact person | Example: Miller
"secondLastName":
string
the second last name of the contact person
"companyName1":
string
the company name | Example: PMiller ltd.
"companyName2":
string
The second company name
"addressLine1":
string
the first address line | Example: Berliner Str. 20
"addressLine2":
string
the second address line | Example: 1st Floor
"addressLine3":
string
The third address line | Example: Second door on the right
"postBox":
string
the post-office box | Example: PO Box 42
"mainDivision":
string
the main division of the country, e. g. a state or province | Example: AL
"mainDivisionName":
string
The localized display name of the main division | Example: Alabama
"subDivision":
string
The sub division code of the country. | Example: GB-PKN
"subDivisionName":
string
The localized display name of the sub division | Example: Perth and Kinross
"postalCode":
string
The postal code | Example: 14482
"email":
string
the e-mail address of the contact person | Example: pmiller@intershop.de
"phoneMobile":
string
The number of the contact person's cell phone | Example: 49364112677
"phoneHome":
string
The phone number of the house or apartment where the contact person lives | Example: 049364112677
"phoneBusiness":
string
The phone number of the contact person's company | Example: 049364112699
"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 | Example: 049364112659
"country":
string
The display name of the country in the current locale | Example: Germany
"countryCode":
string
The country code | Example: DE
"city":
string
The name of the city | Example: Potsdam
"fax":
string
the fax number | Example: 049364112643
"usage":
object
Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
}
"preferredLanguage":
string
the preferred language of the customer | Example: de_DE
"preferredPaymentInstrument":
object
A PaymentRO
object.
{
"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Payment
"attributes":
array
An array of ResourceAttribute
objects. The list of attributes
[
ResourceAttribute
:
An attribute{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
]
"id":
string
The payment ID | Example: dhKsEmZRPyEAAAF2hyV6dB2n
"limitedTenderBalance":
object
A MoneyRO
object. Money combines a currency and a money amount.
{
"type":
string
Readonly | This is a constant: Money | Example: Money
"value":
number
The monetary value. | Example: 10.99
"currencyMnemonic":
string
Deprecated
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
}
"paymentTotalAmount":
object
A MoneyRO
object. Money combines a currency and a money amount.
{
"type":
string
Readonly | This is a constant: Money | Example: Money
"value":
number
The monetary value. | Example: 10.99
"currencyMnemonic":
string
Deprecated
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
}
"accountIdentifier":
string
Readonly | The optional account identifier for this payment instrument | Example: DE12****7890
"parameters":
array
An array of GenericPropertyROObject
objects. The parameters for this payment
[
GenericPropertyROObject
{
"name":
string
The name of an element
"type":
string
Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
}
]
"attribute":
object
A ResourceAttribute
object. An attribute
{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
}
"preferredShipToAddress":
object
A AddressRO
object. This resource holds the details of an address.
{
"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Address
"urn":
string
the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
"id":
string
The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
"addressName":
string
The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
"title":
string
The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
"aristocraticTitle":
string
the aristocratic title of the contact person, like Lord or Lady
"jobTitle":
string
the job title of the contact person | Example: CEO
"honorific":
string
the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
"firstName":
string
The (first) given name of the contact person | Example: Patricia
"secondName":
string
the second given name of the contact person | Example: Luise
"lastName":
string
The last name of the contact person | Example: Miller
"secondLastName":
string
the second last name of the contact person
"companyName1":
string
the company name | Example: PMiller ltd.
"companyName2":
string
The second company name
"addressLine1":
string
the first address line | Example: Berliner Str. 20
"addressLine2":
string
the second address line | Example: 1st Floor
"addressLine3":
string
The third address line | Example: Second door on the right
"postBox":
string
the post-office box | Example: PO Box 42
"mainDivision":
string
the main division of the country, e. g. a state or province | Example: AL
"mainDivisionName":
string
The localized display name of the main division | Example: Alabama
"subDivision":
string
The sub division code of the country. | Example: GB-PKN
"subDivisionName":
string
The localized display name of the sub division | Example: Perth and Kinross
"postalCode":
string
The postal code | Example: 14482
"email":
string
the e-mail address of the contact person | Example: pmiller@intershop.de
"phoneMobile":
string
The number of the contact person's cell phone | Example: 49364112677
"phoneHome":
string
The phone number of the house or apartment where the contact person lives | Example: 049364112677
"phoneBusiness":
string
The phone number of the contact person's company | Example: 049364112699
"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 | Example: 049364112659
"country":
string
The display name of the country in the current locale | Example: Germany
"countryCode":
string
The country code | Example: DE
"city":
string
The name of the city | Example: Potsdam
"fax":
string
the fax number | Example: 049364112643
"usage":
object
Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
}
"title":
string
the title of the customer | Example: Mr
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: PrivateCustomer
}ResourceCollectionROLinkRO application/json
{"pageable":
string
The pageable ID.
"total":
integer
The pageable amount total | Format: int32
"offset":
integer
The pageable offset | Format: int32
"amount":
integer
The pageable amount | Format: int32
"elements":
array
An array of LinkRO
objects. The list of elements
[
LinkRO
:
A Link pointing to a resource{
"name":
string
The name of the returned element
"type":
string
Readonly | This is a constant: Link | Example: Link
"attributes":
array
An array of ResourceAttribute
objects. The list of attributes
[
ResourceAttribute
:
An attribute{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
]
"relation":
string
The relation of the link | Documentation:
Link Relations (www.iana.org) | Possible Values:
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
"title":
string
The title of the link
"description":
string
The description of the link
"itemId":
string
The ID of the linked item
"attribute":
object
A ResourceAttribute
object. An attribute
{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
}
]
"type":
string
This is a constant: ResourceCollection | Example: ResourceCollection
"sortKeys":
array
An array of string
literals. The keys to sort for
"name":
string
The name of the returned element
}SMBCustomerRO application/json
{"companyName":
string
the company name of the customer | Example: AgroNet
"customerType":
string
Readonly | the type of the customer | Example: PRIVATE
"description":
string
the description of the customer | Example: AgroNet description
"industry":
string
the industry of the customer | Example: agrar industry
"name":
string
The name of an element
"preferredInvoiceToAddress":
object
A AddressRO
object. This resource holds the details of an address.
{
"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Address
"urn":
string
the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
"id":
string
The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
"addressName":
string
The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
"title":
string
The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
"aristocraticTitle":
string
the aristocratic title of the contact person, like Lord or Lady
"jobTitle":
string
the job title of the contact person | Example: CEO
"honorific":
string
the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
"firstName":
string
The (first) given name of the contact person | Example: Patricia
"secondName":
string
the second given name of the contact person | Example: Luise
"lastName":
string
The last name of the contact person | Example: Miller
"secondLastName":
string
the second last name of the contact person
"companyName1":
string
the company name | Example: PMiller ltd.
"companyName2":
string
The second company name
"addressLine1":
string
the first address line | Example: Berliner Str. 20
"addressLine2":
string
the second address line | Example: 1st Floor
"addressLine3":
string
The third address line | Example: Second door on the right
"postBox":
string
the post-office box | Example: PO Box 42
"mainDivision":
string
the main division of the country, e. g. a state or province | Example: AL
"mainDivisionName":
string
The localized display name of the main division | Example: Alabama
"subDivision":
string
The sub division code of the country. | Example: GB-PKN
"subDivisionName":
string
The localized display name of the sub division | Example: Perth and Kinross
"postalCode":
string
The postal code | Example: 14482
"email":
string
the e-mail address of the contact person | Example: pmiller@intershop.de
"phoneMobile":
string
The number of the contact person's cell phone | Example: 49364112677
"phoneHome":
string
The phone number of the house or apartment where the contact person lives | Example: 049364112677
"phoneBusiness":
string
The phone number of the contact person's company | Example: 049364112699
"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 | Example: 049364112659
"country":
string
The display name of the country in the current locale | Example: Germany
"countryCode":
string
The country code | Example: DE
"city":
string
The name of the city | Example: Potsdam
"fax":
string
the fax number | Example: 049364112643
"usage":
object
Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
}
"preferredShipToAddress":
object
A AddressRO
object. This resource holds the details of an address.
{
"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Address
"urn":
string
the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
"id":
string
The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
"addressName":
string
The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
"title":
string
The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
"aristocraticTitle":
string
the aristocratic title of the contact person, like Lord or Lady
"jobTitle":
string
the job title of the contact person | Example: CEO
"honorific":
string
the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
"firstName":
string
The (first) given name of the contact person | Example: Patricia
"secondName":
string
the second given name of the contact person | Example: Luise
"lastName":
string
The last name of the contact person | Example: Miller
"secondLastName":
string
the second last name of the contact person
"companyName1":
string
the company name | Example: PMiller ltd.
"companyName2":
string
The second company name
"addressLine1":
string
the first address line | Example: Berliner Str. 20
"addressLine2":
string
the second address line | Example: 1st Floor
"addressLine3":
string
The third address line | Example: Second door on the right
"postBox":
string
the post-office box | Example: PO Box 42
"mainDivision":
string
the main division of the country, e. g. a state or province | Example: AL
"mainDivisionName":
string
The localized display name of the main division | Example: Alabama
"subDivision":
string
The sub division code of the country. | Example: GB-PKN
"subDivisionName":
string
The localized display name of the sub division | Example: Perth and Kinross
"postalCode":
string
The postal code | Example: 14482
"email":
string
the e-mail address of the contact person | Example: pmiller@intershop.de
"phoneMobile":
string
The number of the contact person's cell phone | Example: 49364112677
"phoneHome":
string
The phone number of the house or apartment where the contact person lives | Example: 049364112677
"phoneBusiness":
string
The phone number of the contact person's company | Example: 049364112699
"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 | Example: 049364112659
"country":
string
The display name of the country in the current locale | Example: Germany
"countryCode":
string
The country code | Example: DE
"city":
string
The name of the city | Example: Potsdam
"fax":
string
the fax number | Example: 049364112643
"usage":
object
Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
}
"taxationID":
string
the taxation ID of the customer | Example: 123456
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: SMBCustomer
}SMBCustomerUserRO application/json
{"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: SMBCustomerUser
"name":
string
The name of an element | Example: SMBCustomerUser
"login":
string
The login to be used for that user. | Example: pmerkel@test.intershop.de
"firstName":
string
The given name (also known as a personal name, first name, forename) of the person represented by this user. | Example: Peter
"lastName":
string
The surname (also known as a family name, last name) of the person represented by this user. | Example: Merkel
"businessPartnerNo":
string
ID uniquely identifying the user in the context of the customer. | Example: PMerkel
"preferredLanguage":
string
the preffered language of the user | Example: de_DE
"phoneBusiness":
string
the business phone number of the user | Example: 4211324
"phoneMobile":
string
the mobile phone number of the user | Example: 4211324
"department":
string
the department of the user | Example: Sales
"title":
string
The personal title, like Ms., Mr. | Example: Mr.
"birthday":
string
Date of birth of the person represented by this user in format MM/dd/yyyy | Example: 12/24/1998
"preferredPaymentInstrument":
object
A PaymentRO
object.
{
"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Payment
"attributes":
array
An array of ResourceAttribute
objects. The list of attributes
[
ResourceAttribute
:
An attribute{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
]
"id":
string
The payment ID | Example: dhKsEmZRPyEAAAF2hyV6dB2n
"limitedTenderBalance":
object
A MoneyRO
object. Money combines a currency and a money amount.
{
"type":
string
Readonly | This is a constant: Money | Example: Money
"value":
number
The monetary value. | Example: 10.99
"currencyMnemonic":
string
Deprecated
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
}
"paymentTotalAmount":
object
A MoneyRO
object. Money combines a currency and a money amount.
{
"type":
string
Readonly | This is a constant: Money | Example: Money
"value":
number
The monetary value. | Example: 10.99
"currencyMnemonic":
string
Deprecated
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
}
"accountIdentifier":
string
Readonly | The optional account identifier for this payment instrument | Example: DE12****7890
"parameters":
array
An array of GenericPropertyROObject
objects. The parameters for this payment
[
GenericPropertyROObject
{
"name":
string
The name of an element
"type":
string
Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
}
]
"attribute":
object
A ResourceAttribute
object. An attribute
{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
}
"phoneHome":
string
the phone home number of the user | Example: 4211324
"fax":
string
the fax number of the user | Example: 4211324
"email":
string
the email of the user | Example: pmerkel@test.intershop.de
"active":
boolean
the user is active or not | Example: true
"preferredInvoiceToAddressUrn":
string
The URN representation of the preferred invoice address for the user in the format urn:address:customer:addressID:customerID | Example:
"preferredShipToAddressUrn":
string
The URN representation of the preferred shipping address for the user in the format urn:address:customer:addressID:customerID | Example:
}SMBCustomerUserROCollection application/json
{"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: SMBCustomerUserCollection
"name":
string
The name of an element | Example: Users
"elements":
array
An array of SMBCustomerUserRO
objects. The list of elements
[
SMBCustomerUserRO
{
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: SMBCustomerUser
"name":
string
The name of an element | Example: SMBCustomerUser
"login":
string
The login to be used for that user. | Example: pmerkel@test.intershop.de
"firstName":
string
The given name (also known as a personal name, first name, forename) of the person represented by this user. | Example: Peter
"lastName":
string
The surname (also known as a family name, last name) of the person represented by this user. | Example: Merkel
"businessPartnerNo":
string
ID uniquely identifying the user in the context of the customer. | Example: PMerkel
"preferredLanguage":
string
the preffered language of the user | Example: de_DE
"phoneBusiness":
string
the business phone number of the user | Example: 4211324
"phoneMobile":
string
the mobile phone number of the user | Example: 4211324
"department":
string
the department of the user | Example: Sales
"title":
string
The personal title, like Ms., Mr. | Example: Mr.
"birthday":
string
Date of birth of the person represented by this user in format MM/dd/yyyy | Example: 12/24/1998
"preferredPaymentInstrument":
object
A PaymentRO
object.
{
"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Payment
"attributes":
array
An array of ResourceAttribute
objects. The list of attributes
[
ResourceAttribute
:
An attribute{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
]
"id":
string
The payment ID | Example: dhKsEmZRPyEAAAF2hyV6dB2n
"limitedTenderBalance":
object
A MoneyRO
object. Money combines a currency and a money amount.
{
"type":
string
Readonly | This is a constant: Money | Example: Money
"value":
number
The monetary value. | Example: 10.99
"currencyMnemonic":
string
Deprecated
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
}
"paymentTotalAmount":
object
A MoneyRO
object. Money combines a currency and a money amount.
{
"type":
string
Readonly | This is a constant: Money | Example: Money
"value":
number
The monetary value. | Example: 10.99
"currencyMnemonic":
string
Deprecated
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
}
"accountIdentifier":
string
Readonly | The optional account identifier for this payment instrument | Example: DE12****7890
"parameters":
array
An array of GenericPropertyROObject
objects. The parameters for this payment
[
GenericPropertyROObject
{
"name":
string
The name of an element
"type":
string
Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
}
]
"attribute":
object
A ResourceAttribute
object. An attribute
{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
}
"phoneHome":
string
the phone home number of the user | Example: 4211324
"fax":
string
the fax number of the user | Example: 4211324
"email":
string
the email of the user | Example: pmerkel@test.intershop.de
"active":
boolean
the user is active or not | Example: true
"preferredInvoiceToAddressUrn":
string
The URN representation of the preferred invoice address for the user in the format urn:address:customer:addressID:customerID | Example:
"preferredShipToAddressUrn":
string
The URN representation of the preferred shipping address for the user in the format urn:address:customer:addressID:customerID | Example:
}
]
}UserLinkROCollection application/json
{"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: UserLinkCollection
"name":
string
The name of an element | Example: users
"amount":
integer
The pageable amount | Format: int32
"elements":
array
An array of UserLinkRO
objects. The list of elements
[
UserLinkRO
:
A Link to registered User Item Resource{
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Link
"name":
string
The name of an element | Example: Peter Merkel
"login":
string
The login of the user | Example: pmerkel@test.intershop.de
"uri":
string
the uri to the user item resource | Example: Organization-Channel-Site/-/customers/-/users/pmerkel@test.intershop.de
"attributes":
array
An array of ResourceAttribute
objects. The list of attributes
[
ResourceAttribute
:
An attribute{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
]
"attribute":
object
A ResourceAttribute
object. An attribute
{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
}
]
"pageable":
string
The pageable ID
"total":
integer
The pageable amount total | Format: int32
"offset":
integer
The pageable offset | Format: int32
"limit":
integer
the maximum count of users to return | Format: int32
"filter":
string
the defined filter criteria for returned users
"sortKeys":
array
An array of string
literals. The keys to sort for
}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.