Resources

There is a WADL document available that describes the resources API.

name path methods description
Customer relationships API
  • /customer-relationships/customer/customers
  • /customer-relationships/customer/customers/{customerId}
  • /customer-relationships/customer/customers/{customerId}/subscriptions
  • GET
  • PATCH
  • GET
Allows to retrieve and update customer information.
Customer relationships API
  • /customer-relationships/subscription/subscriptions
  • GET
Allows for retrieval of subscription information.
Offer API
  • /customer-relationships/offer/offers
  • /customer-relationships/offer/offers/{offerId}/offer-codes
  • GET
  • POST
Allows to retrieve offer-information and add offer-codes.

Data Types

type description
BlockCode Block Code
CancellationReason Cancellation Reason
CancellationReason Cancellation Reason
Category Customer Category
Consent Customer's consent.
ConsentKey Consent key (name).
ConsentValue Consent value.
Customer Customer
Customer Customer information.
CustomerChanges Contains changes that applies to a customer.
CustomerResult Holds a search result of customers.
Offer Offer
OfferCode OfferCode
OfferCodes OfferCodes to add to a specific offer
OfferResult Holds a search result of offers.
Subscription Subscription information.
Subscription Subscription information.
SubscriptionResult Holds a search result of subscriptions.
SubscriptionResult Holds a search result of subscriptions.