The customer relations API allows a client to search and update customer related information.

Resources

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

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
Customer API
  • /customer-relationships/customer/customers
  • /customer-relationships/customer/customers/{customerId}
  • /customer-relationships/customer/customers/{customerId}/customer-activities
  • /customer-relationships/customer/customers/{customerId}/subscriptions
  • GET POST
  • PATCH
  • POST
  • GET
Allows retrieving and updating customer information.
Note API
  • /customer-relationships/note/notes
  • GET
API for retrieving customer notes.
Offer API
  • /customer-relationships/offer/offers
  • /customer-relationships/offer/offers/{offerId}/offer-codes
  • GET
  • POST
Allows to retrieve offer-information and add offer-codes.
Property API
  • /customer-relationships/property/properties
  • DELETE GET POST
Allows retrieving and updating property information.
Subscription API
  • /customer-relationships/subscription/subscriptions
  • /customer-relationships/subscription/subscriptions/{subscriptionId}
  • GET
  • PATCH
Allows for retrieval of subscription information.

Data Types

type description
Address Contains an Address
AddressType The addressType of an address.
AppliedToPrices Defines how offers are applied to variants based on their price.
ArrivalMethod Arrival method
ArrivalMethod Arrival method
BlockCode Block Code
Campaign Campaign
CancellationReason Cancellation Reason
CancellationReason Cancellation Reason
Category Customer Category
Consent Customer's consent.
Consent Customer's consent.
ConsentKey Consent key (name).
ConsentKey Consent key (name).
ConsentValue Consent value.
ConsentValue Consent value.
CustomField Contains custom fields for an order.
Customer Customer
Customer ** Customer information.
CustomerActivitiesToAdd Holds information about customer activities.
CustomerActivity Holds information about a customer activity.
CustomerAddress Customer Address
CustomerAddress Customer Address
CustomerChanges Contains changes that applies to a customer.
CustomerResult Documentation Customer API result class
CustomerToAddOrUpdate Contains a customer to add or update
CustomerToAddOrUpdateResult Holds information about created & updated customers.
CustomerToAddOrUpdateResultCustomer Holds information about a created or updated customer.
CustomerType
CustomerUser The customer to add as a connection
CustomersToAddOrUpdate Contains a list of customers to add or update.
DefaultPaymentMethod Default Payment Method
DefaultTermsOfPayment Default Terms Of Payment
Gender The gender of a customer.
InvoiceAddress Invoice Address
LookupOffer A simplistic representation of an offer
LookupResult A lookup result of a product and connected offers.
Note A note.
NoteCode A note code. (Also known as standard note)
NoteResult Holds a list of notes.
Offer Offer
OfferCode OfferCode
OfferCodes OfferCodes to add to a specific offer
OfferResult Holds a search result of offers.
OfferType The type of offer.
Parameter A variable condition or value of an offer
PaymentMethod Payment method
PaymentMethod Payment method
PreviousDelivery Previous Delivery information
PriceList Price List
PropertiesToConnect Contains a list of properties to connect or add/update translations for.
PropertiesToDelete Contains a list of properties to delete.
Property Property information.
PropertyHit Property hit information.
PropertyKey The key of the property
PropertyResult Documentation Property API result class
PropertyToConnect A property to connect to the customer (and/or add/update translations for)
PropertyToDelete Contains a property to delete
PropertyValue The property value
PropertyValue The value of the property
Store A marketplace where the offer is made available
Subscription Subscription information.
Subscription Subscription information.
SubscriptionDeliveryProduct Subscription delivery product
SubscriptionResult Holds a search result of subscriptions.
SubscriptionResult Holds a search result of subscriptions.
SubscriptionRowProduct Subscription row product
SubscriptionRowToAddOrUpdate Contains a list of subscriptions rows to add or update.
SubscriptionRowToAddOrUpdateResultRow Holds information about a created or updated subscriptions.
SubscriptionRows Subscription rows
SubscriptionRowsToAddOrUpdate Contains a list of subscriptions rows to add or update.
SubscriptionRowsToAddOrUpdateResult Holds information about created & updated subscription rows.
TranslationKey The translations for the key
TranslationKey The translation for a property value
TranslationValue The translations for the value
TranslationValue The translation for a property value
UpcomingDeliveries Upcoming deliveries
ValueToDelete The values to delete